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

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.161.  .2(raebu    4:22): # $Id: loncommon.pm,v 1.1075.2.161.2.1 2021/12/30 21:11:56 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.161.  .1(raebu   86:21): use String::CRC32();
                     87:21): 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.143  raeburn   433:     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.143  raeburn   448:         if (courseadv == 'condition') {
                    449:             if (document.getElementById('courseadv')) {
                    450:                 courseadv = document.getElementById('courseadv').value;
                    451:             }
                    452:         }
                    453:         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.143  raeburn   485:    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.143  raeburn   496:        if ($courseadv eq 'only') {
                    497:            $callargs .= ",'',1,'$courseadv'";
                    498:        } elsif ($courseadv eq 'none') {
                    499:            $callargs .= ",'','','$courseadv'";
                    500:        } elsif ($courseadv eq 'condition') {
                    501:            $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 {
1.1075.2.158  raeburn  1383:     my ($text,$linkattr) = @_;
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.158  raeburn  1399: <a href="$link" title="$title" $linkattr>$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:     }
1.1075.2.158  raeburn  3132:     $autharg = '<input type="password" 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.1075.2.158  raeburn  3136:          '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  3137:     return $result;
                   3138: }
                   3139: 
1.586     raeburn  3140: sub get_assignable_auth {
                   3141:     my ($dom) = @_;
                   3142:     if ($dom eq '') {
                   3143:         $dom = $env{'request.role.domain'};
                   3144:     }
                   3145:     my %can_assign = (
                   3146:                           krb4 => 1,
                   3147:                           krb5 => 1,
                   3148:                           int  => 1,
                   3149:                           loc  => 1,
                   3150:                      );
                   3151:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   3152:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   3153:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   3154:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   3155:             my $context;
                   3156:             if ($env{'request.role'} =~ /^au/) {
                   3157:                 $context = 'author';
1.1075.2.117  raeburn  3158:             } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586     raeburn  3159:                 $context = 'domain';
                   3160:             } elsif ($env{'request.course.id'}) {
                   3161:                 $context = 'course';
                   3162:             }
                   3163:             if ($context) {
                   3164:                 if (ref($authhash->{$context}) eq 'HASH') {
                   3165:                    %can_assign = %{$authhash->{$context}}; 
                   3166:                 }
                   3167:             }
                   3168:         }
                   3169:     }
                   3170:     my $authnum = 0;
                   3171:     foreach my $key (keys(%can_assign)) {
                   3172:         if ($can_assign{$key}) {
                   3173:             $authnum ++;
                   3174:         }
                   3175:     }
                   3176:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   3177:         $authnum --;
                   3178:     }
                   3179:     return ($authnum,%can_assign);
                   3180: }
                   3181: 
1.1075.2.137  raeburn  3182: sub check_passwd_rules {
                   3183:     my ($domain,$plainpass) = @_;
                   3184:     my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
                   3185:     my ($min,$max,@chars,@brokerule,$warning);
1.1075.2.138  raeburn  3186:     $min = $Apache::lonnet::passwdmin;
1.1075.2.137  raeburn  3187:     if (ref($passwdconf{'chars'}) eq 'ARRAY') {
                   3188:         if ($passwdconf{'min'} =~ /^\d+$/) {
1.1075.2.138  raeburn  3189:             if ($passwdconf{'min'} > $min) {
                   3190:                 $min = $passwdconf{'min'};
                   3191:             }
1.1075.2.137  raeburn  3192:         }
                   3193:         if ($passwdconf{'max'} =~ /^\d+$/) {
                   3194:             $max = $passwdconf{'max'};
                   3195:         }
                   3196:         @chars = @{$passwdconf{'chars'}};
                   3197:     }
                   3198:     if (($min) && (length($plainpass) < $min)) {
                   3199:         push(@brokerule,'min');
                   3200:     }
                   3201:     if (($max) && (length($plainpass) > $max)) {
                   3202:         push(@brokerule,'max');
                   3203:     }
                   3204:     if (@chars) {
                   3205:         my %rules;
                   3206:         map { $rules{$_} = 1; } @chars;
                   3207:         if ($rules{'uc'}) {
                   3208:             unless ($plainpass =~ /[A-Z]/) {
                   3209:                 push(@brokerule,'uc');
                   3210:             }
                   3211:         }
                   3212:         if ($rules{'lc'}) {
                   3213:             unless ($plainpass =~ /[a-z]/) {
                   3214:                 push(@brokerule,'lc');
                   3215:             }
                   3216:         }
                   3217:         if ($rules{'num'}) {
                   3218:             unless ($plainpass =~ /\d/) {
                   3219:                 push(@brokerule,'num');
                   3220:             }
                   3221:         }
                   3222:         if ($rules{'spec'}) {
                   3223:             unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
                   3224:                 push(@brokerule,'spec');
                   3225:             }
                   3226:         }
                   3227:     }
                   3228:     if (@brokerule) {
                   3229:         my %rulenames = &Apache::lonlocal::texthash(
                   3230:             uc   => 'At least one upper case letter',
                   3231:             lc   => 'At least one lower case letter',
                   3232:             num  => 'At least one number',
                   3233:             spec => 'At least one non-alphanumeric',
                   3234:         );
                   3235:         $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
                   3236:         $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
                   3237:         $rulenames{'num'} .= ': 0123456789';
                   3238:         $rulenames{'spec'} .= ': !&quot;\#$%&amp;\'()*+,-./:;&lt;=&gt;?@[\]^_\`{|}~';
                   3239:         $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
                   3240:         $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
                   3241:         $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1075.2.143  raeburn  3242:         foreach my $rule ('min','max','uc','lc','num','spec') {
1.1075.2.137  raeburn  3243:             if (grep(/^$rule$/,@brokerule)) {
                   3244:                 $warning .= '<li>'.$rulenames{$rule}.'</li>';
                   3245:             }
                   3246:         }
                   3247:         $warning .= '</ul>';
                   3248:     }
                   3249:     if (wantarray) {
                   3250:         return @brokerule;
                   3251:     }
                   3252:     return $warning;
                   3253: }
                   3254: 
1.80      albertel 3255: ###############################################################
                   3256: ##    Get Kerberos Defaults for Domain                 ##
                   3257: ###############################################################
                   3258: ##
                   3259: ## Returns default kerberos version and an associated argument
                   3260: ## as listed in file domain.tab. If not listed, provides
                   3261: ## appropriate default domain and kerberos version.
                   3262: ##
                   3263: #-------------------------------------------
                   3264: 
                   3265: =pod
                   3266: 
1.648     raeburn  3267: =item * &get_kerberos_defaults()
1.80      albertel 3268: 
                   3269: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  3270: version and domain. If not found, it defaults to version 4 and the 
                   3271: domain of the server.
1.80      albertel 3272: 
1.648     raeburn  3273: =over 4
                   3274: 
1.80      albertel 3275: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   3276: 
1.648     raeburn  3277: =back
                   3278: 
                   3279: =back
                   3280: 
1.80      albertel 3281: =cut
                   3282: 
                   3283: #-------------------------------------------
                   3284: sub get_kerberos_defaults {
                   3285:     my $domain=shift;
1.641     raeburn  3286:     my ($krbdef,$krbdefdom);
                   3287:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   3288:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   3289:         $krbdef = $domdefaults{'auth_def'};
                   3290:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   3291:     } else {
1.80      albertel 3292:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   3293:         my $krbdefdom=$1;
                   3294:         $krbdefdom=~tr/a-z/A-Z/;
                   3295:         $krbdef = "krb4";
                   3296:     }
                   3297:     return ($krbdef,$krbdefdom);
                   3298: }
1.112     bowersj2 3299: 
1.32      matthew  3300: 
1.46      matthew  3301: ###############################################################
                   3302: ##                Thesaurus Functions                        ##
                   3303: ###############################################################
1.20      www      3304: 
1.46      matthew  3305: =pod
1.20      www      3306: 
1.112     bowersj2 3307: =head1 Thesaurus Functions
                   3308: 
                   3309: =over 4
                   3310: 
1.648     raeburn  3311: =item * &initialize_keywords()
1.46      matthew  3312: 
                   3313: Initializes the package variable %Keywords if it is empty.  Uses the
                   3314: package variable $thesaurus_db_file.
                   3315: 
                   3316: =cut
                   3317: 
                   3318: ###################################################
                   3319: 
                   3320: sub initialize_keywords {
                   3321:     return 1 if (scalar keys(%Keywords));
                   3322:     # If we are here, %Keywords is empty, so fill it up
                   3323:     #   Make sure the file we need exists...
                   3324:     if (! -e $thesaurus_db_file) {
                   3325:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   3326:                                  " failed because it does not exist");
                   3327:         return 0;
                   3328:     }
                   3329:     #   Set up the hash as a database
                   3330:     my %thesaurus_db;
                   3331:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3332:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3333:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   3334:                                  $thesaurus_db_file);
                   3335:         return 0;
                   3336:     } 
                   3337:     #  Get the average number of appearances of a word.
                   3338:     my $avecount = $thesaurus_db{'average.count'};
                   3339:     #  Put keywords (those that appear > average) into %Keywords
                   3340:     while (my ($word,$data)=each (%thesaurus_db)) {
                   3341:         my ($count,undef) = split /:/,$data;
                   3342:         $Keywords{$word}++ if ($count > $avecount);
                   3343:     }
                   3344:     untie %thesaurus_db;
                   3345:     # Remove special values from %Keywords.
1.356     albertel 3346:     foreach my $value ('total.count','average.count') {
                   3347:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  3348:   }
1.46      matthew  3349:     return 1;
                   3350: }
                   3351: 
                   3352: ###################################################
                   3353: 
                   3354: =pod
                   3355: 
1.648     raeburn  3356: =item * &keyword($word)
1.46      matthew  3357: 
                   3358: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   3359: than the average number of times in the thesaurus database.  Calls 
                   3360: &initialize_keywords
                   3361: 
                   3362: =cut
                   3363: 
                   3364: ###################################################
1.20      www      3365: 
                   3366: sub keyword {
1.46      matthew  3367:     return if (!&initialize_keywords());
                   3368:     my $word=lc(shift());
                   3369:     $word=~s/\W//g;
                   3370:     return exists($Keywords{$word});
1.20      www      3371: }
1.46      matthew  3372: 
                   3373: ###############################################################
                   3374: 
                   3375: =pod 
1.20      www      3376: 
1.648     raeburn  3377: =item * &get_related_words()
1.46      matthew  3378: 
1.160     matthew  3379: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  3380: an array of words.  If the keyword is not in the thesaurus, an empty array
                   3381: will be returned.  The order of the words returned is determined by the
                   3382: database which holds them.
                   3383: 
                   3384: Uses global $thesaurus_db_file.
                   3385: 
1.1057    foxr     3386: 
1.46      matthew  3387: =cut
                   3388: 
                   3389: ###############################################################
                   3390: sub get_related_words {
                   3391:     my $keyword = shift;
                   3392:     my %thesaurus_db;
                   3393:     if (! -e $thesaurus_db_file) {
                   3394:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   3395:                                  "failed because the file does not exist");
                   3396:         return ();
                   3397:     }
                   3398:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3399:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3400:         return ();
                   3401:     } 
                   3402:     my @Words=();
1.429     www      3403:     my $count=0;
1.46      matthew  3404:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 3405: 	# The first element is the number of times
                   3406: 	# the word appears.  We do not need it now.
1.429     www      3407: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   3408: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   3409: 	my $threshold=$mostfrequentcount/10;
                   3410:         foreach my $possibleword (@RelatedWords) {
                   3411:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   3412:             if ($wordcount>$threshold) {
                   3413: 		push(@Words,$word);
                   3414:                 $count++;
                   3415:                 if ($count>10) { last; }
                   3416: 	    }
1.20      www      3417:         }
                   3418:     }
1.46      matthew  3419:     untie %thesaurus_db;
                   3420:     return @Words;
1.14      harris41 3421: }
1.46      matthew  3422: 
1.112     bowersj2 3423: =pod
                   3424: 
                   3425: =back
                   3426: 
                   3427: =cut
1.61      www      3428: 
                   3429: # -------------------------------------------------------------- Plaintext name
1.81      albertel 3430: =pod
                   3431: 
1.112     bowersj2 3432: =head1 User Name Functions
                   3433: 
                   3434: =over 4
                   3435: 
1.648     raeburn  3436: =item * &plainname($uname,$udom,$first)
1.81      albertel 3437: 
1.112     bowersj2 3438: Takes a users logon name and returns it as a string in
1.226     albertel 3439: "first middle last generation" form 
                   3440: if $first is set to 'lastname' then it returns it as
                   3441: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 3442: 
                   3443: =cut
1.61      www      3444: 
1.295     www      3445: 
1.81      albertel 3446: ###############################################################
1.61      www      3447: sub plainname {
1.226     albertel 3448:     my ($uname,$udom,$first)=@_;
1.537     albertel 3449:     return if (!defined($uname) || !defined($udom));
1.295     www      3450:     my %names=&getnames($uname,$udom);
1.226     albertel 3451:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   3452: 					  $names{'middlename'},
                   3453: 					  $names{'lastname'},
                   3454: 					  $names{'generation'},$first);
                   3455:     $name=~s/^\s+//;
1.62      www      3456:     $name=~s/\s+$//;
                   3457:     $name=~s/\s+/ /g;
1.353     albertel 3458:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      3459:     return $name;
1.61      www      3460: }
1.66      www      3461: 
                   3462: # -------------------------------------------------------------------- Nickname
1.81      albertel 3463: =pod
                   3464: 
1.648     raeburn  3465: =item * &nickname($uname,$udom)
1.81      albertel 3466: 
                   3467: Gets a users name and returns it as a string as
                   3468: 
                   3469: "&quot;nickname&quot;"
1.66      www      3470: 
1.81      albertel 3471: if the user has a nickname or
                   3472: 
                   3473: "first middle last generation"
                   3474: 
                   3475: if the user does not
                   3476: 
                   3477: =cut
1.66      www      3478: 
                   3479: sub nickname {
                   3480:     my ($uname,$udom)=@_;
1.537     albertel 3481:     return if (!defined($uname) || !defined($udom));
1.295     www      3482:     my %names=&getnames($uname,$udom);
1.68      albertel 3483:     my $name=$names{'nickname'};
1.66      www      3484:     if ($name) {
                   3485:        $name='&quot;'.$name.'&quot;'; 
                   3486:     } else {
                   3487:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   3488: 	     $names{'lastname'}.' '.$names{'generation'};
                   3489:        $name=~s/\s+$//;
                   3490:        $name=~s/\s+/ /g;
                   3491:     }
                   3492:     return $name;
                   3493: }
                   3494: 
1.295     www      3495: sub getnames {
                   3496:     my ($uname,$udom)=@_;
1.537     albertel 3497:     return if (!defined($uname) || !defined($udom));
1.433     albertel 3498:     if ($udom eq 'public' && $uname eq 'public') {
                   3499: 	return ('lastname' => &mt('Public'));
                   3500:     }
1.295     www      3501:     my $id=$uname.':'.$udom;
                   3502:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   3503:     if ($cached) {
                   3504: 	return %{$names};
                   3505:     } else {
                   3506: 	my %loadnames=&Apache::lonnet::get('environment',
                   3507:                     ['firstname','middlename','lastname','generation','nickname'],
                   3508: 					 $udom,$uname);
                   3509: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   3510: 	return %loadnames;
                   3511:     }
                   3512: }
1.61      www      3513: 
1.542     raeburn  3514: # -------------------------------------------------------------------- getemails
1.648     raeburn  3515: 
1.542     raeburn  3516: =pod
                   3517: 
1.648     raeburn  3518: =item * &getemails($uname,$udom)
1.542     raeburn  3519: 
                   3520: Gets a user's email information and returns it as a hash with keys:
                   3521: notification, critnotification, permanentemail
                   3522: 
                   3523: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  3524: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  3525:  
1.648     raeburn  3526: 
1.542     raeburn  3527: =cut
                   3528: 
1.648     raeburn  3529: 
1.466     albertel 3530: sub getemails {
                   3531:     my ($uname,$udom)=@_;
                   3532:     if ($udom eq 'public' && $uname eq 'public') {
                   3533: 	return;
                   3534:     }
1.467     www      3535:     if (!$udom) { $udom=$env{'user.domain'}; }
                   3536:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 3537:     my $id=$uname.':'.$udom;
                   3538:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   3539:     if ($cached) {
                   3540: 	return %{$names};
                   3541:     } else {
                   3542: 	my %loadnames=&Apache::lonnet::get('environment',
                   3543:                     			   ['notification','critnotification',
                   3544: 					    'permanentemail'],
                   3545: 					   $udom,$uname);
                   3546: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   3547: 	return %loadnames;
                   3548:     }
                   3549: }
                   3550: 
1.551     albertel 3551: sub flush_email_cache {
                   3552:     my ($uname,$udom)=@_;
                   3553:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3554:     if (!$uname) { $uname=$env{'user.name'};   }
                   3555:     return if ($udom eq 'public' && $uname eq 'public');
                   3556:     my $id=$uname.':'.$udom;
                   3557:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   3558: }
                   3559: 
1.728     raeburn  3560: # -------------------------------------------------------------------- getlangs
                   3561: 
                   3562: =pod
                   3563: 
                   3564: =item * &getlangs($uname,$udom)
                   3565: 
                   3566: Gets a user's language preference and returns it as a hash with key:
                   3567: language.
                   3568: 
                   3569: =cut
                   3570: 
                   3571: 
                   3572: sub getlangs {
                   3573:     my ($uname,$udom) = @_;
                   3574:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3575:     if (!$uname) { $uname=$env{'user.name'};   }
                   3576:     my $id=$uname.':'.$udom;
                   3577:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   3578:     if ($cached) {
                   3579:         return %{$langs};
                   3580:     } else {
                   3581:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   3582:                                            $udom,$uname);
                   3583:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   3584:         return %loadlangs;
                   3585:     }
                   3586: }
                   3587: 
                   3588: sub flush_langs_cache {
                   3589:     my ($uname,$udom)=@_;
                   3590:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3591:     if (!$uname) { $uname=$env{'user.name'};   }
                   3592:     return if ($udom eq 'public' && $uname eq 'public');
                   3593:     my $id=$uname.':'.$udom;
                   3594:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   3595: }
                   3596: 
1.61      www      3597: # ------------------------------------------------------------------ Screenname
1.81      albertel 3598: 
                   3599: =pod
                   3600: 
1.648     raeburn  3601: =item * &screenname($uname,$udom)
1.81      albertel 3602: 
                   3603: Gets a users screenname and returns it as a string
                   3604: 
                   3605: =cut
1.61      www      3606: 
                   3607: sub screenname {
                   3608:     my ($uname,$udom)=@_;
1.258     albertel 3609:     if ($uname eq $env{'user.name'} &&
                   3610: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 3611:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 3612:     return $names{'screenname'};
1.62      www      3613: }
                   3614: 
1.212     albertel 3615: 
1.802     bisitz   3616: # ------------------------------------------------------------- Confirm Wrapper
                   3617: =pod
                   3618: 
1.1075.2.42  raeburn  3619: =item * &confirmwrapper($message)
1.802     bisitz   3620: 
                   3621: Wrap messages about completion of operation in box
                   3622: 
                   3623: =cut
                   3624: 
                   3625: sub confirmwrapper {
                   3626:     my ($message)=@_;
                   3627:     if ($message) {
                   3628:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3629:                .$message."\n"
                   3630:                .'</div>'."\n";
                   3631:     } else {
                   3632:         return $message;
                   3633:     }
                   3634: }
                   3635: 
1.62      www      3636: # ------------------------------------------------------------- Message Wrapper
                   3637: 
                   3638: sub messagewrapper {
1.369     www      3639:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3640:     return 
1.441     albertel 3641:         '<a href="/adm/email?compose=individual&amp;'.
                   3642:         'recname='.$username.'&amp;recdom='.$domain.
                   3643: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3644:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3645: }
1.802     bisitz   3646: 
1.74      www      3647: # --------------------------------------------------------------- Notes Wrapper
                   3648: 
                   3649: sub noteswrapper {
                   3650:     my ($link,$un,$do)=@_;
                   3651:     return 
1.896     amueller 3652: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3653: }
1.802     bisitz   3654: 
1.62      www      3655: # ------------------------------------------------------------- Aboutme Wrapper
                   3656: 
                   3657: sub aboutmewrapper {
1.1070    raeburn  3658:     my ($link,$username,$domain,$target,$class)=@_;
1.447     raeburn  3659:     if (!defined($username)  && !defined($domain)) {
                   3660:         return;
                   3661:     }
1.1075.2.15  raeburn  3662:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070    raeburn  3663: 	($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3664: }
                   3665: 
                   3666: # ------------------------------------------------------------ Syllabus Wrapper
                   3667: 
                   3668: sub syllabuswrapper {
1.707     bisitz   3669:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3670:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3671: }
1.14      harris41 3672: 
1.802     bisitz   3673: # -----------------------------------------------------------------------------
                   3674: 
1.208     matthew  3675: sub track_student_link {
1.887     raeburn  3676:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3677:     my $link ="/adm/trackstudent?";
1.208     matthew  3678:     my $title = 'View recent activity';
                   3679:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3680:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3681:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3682:         $title .= ' of this student';
1.268     albertel 3683:     } 
1.208     matthew  3684:     if (defined($target) && $target !~ /^\s*$/) {
                   3685:         $target = qq{target="$target"};
                   3686:     } else {
                   3687:         $target = '';
                   3688:     }
1.268     albertel 3689:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3690:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3691:     $title = &mt($title);
                   3692:     $linktext = &mt($linktext);
1.448     albertel 3693:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3694: 	&help_open_topic('View_recent_activity');
1.208     matthew  3695: }
                   3696: 
1.781     raeburn  3697: sub slot_reservations_link {
                   3698:     my ($linktext,$sname,$sdom,$target) = @_;
                   3699:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3700:     my $title = 'View slot reservation history';
                   3701:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3702:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3703:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3704:         $title .= ' of this student';
                   3705:     }
                   3706:     if (defined($target) && $target !~ /^\s*$/) {
                   3707:         $target = qq{target="$target"};
                   3708:     } else {
                   3709:         $target = '';
                   3710:     }
                   3711:     $title = &mt($title);
                   3712:     $linktext = &mt($linktext);
                   3713:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3714: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3715: 
                   3716: }
                   3717: 
1.508     www      3718: # ===================================================== Display a student photo
                   3719: 
                   3720: 
1.509     albertel 3721: sub student_image_tag {
1.508     www      3722:     my ($domain,$user)=@_;
                   3723:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3724:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3725: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3726:     } else {
                   3727: 	return '';
                   3728:     }
                   3729: }
                   3730: 
1.112     bowersj2 3731: =pod
                   3732: 
                   3733: =back
                   3734: 
                   3735: =head1 Access .tab File Data
                   3736: 
                   3737: =over 4
                   3738: 
1.648     raeburn  3739: =item * &languageids() 
1.112     bowersj2 3740: 
                   3741: returns list of all language ids
                   3742: 
                   3743: =cut
                   3744: 
1.14      harris41 3745: sub languageids {
1.16      harris41 3746:     return sort(keys(%language));
1.14      harris41 3747: }
                   3748: 
1.112     bowersj2 3749: =pod
                   3750: 
1.648     raeburn  3751: =item * &languagedescription() 
1.112     bowersj2 3752: 
                   3753: returns description of a specified language id
                   3754: 
                   3755: =cut
                   3756: 
1.14      harris41 3757: sub languagedescription {
1.125     www      3758:     my $code=shift;
                   3759:     return  ($supported_language{$code}?'* ':'').
                   3760:             $language{$code}.
1.126     www      3761: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3762: }
                   3763: 
1.1048    foxr     3764: =pod
                   3765: 
                   3766: =item * &plainlanguagedescription
                   3767: 
                   3768: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
                   3769: and the language character encoding (e.g. ISO) separated by a ' - ' string.
                   3770: 
                   3771: =cut
                   3772: 
1.145     www      3773: sub plainlanguagedescription {
                   3774:     my $code=shift;
                   3775:     return $language{$code};
                   3776: }
                   3777: 
1.1048    foxr     3778: =pod
                   3779: 
                   3780: =item * &supportedlanguagecode
                   3781: 
                   3782: Returns the supported language code (e.g. sptutf maps to pt) given a language
                   3783: code.
                   3784: 
                   3785: =cut
                   3786: 
1.145     www      3787: sub supportedlanguagecode {
                   3788:     my $code=shift;
                   3789:     return $supported_language{$code};
1.97      www      3790: }
                   3791: 
1.112     bowersj2 3792: =pod
                   3793: 
1.1048    foxr     3794: =item * &latexlanguage()
                   3795: 
                   3796: Given a language key code returns the correspondnig language to use
                   3797: to select the correct hyphenation on LaTeX printouts.  This is undef if there
                   3798: is no supported hyphenation for the language code.
                   3799: 
                   3800: =cut
                   3801: 
                   3802: sub latexlanguage {
                   3803:     my $code = shift;
                   3804:     return $latex_language{$code};
                   3805: }
                   3806: 
                   3807: =pod
                   3808: 
                   3809: =item * &latexhyphenation()
                   3810: 
                   3811: Same as above but what's supplied is the language as it might be stored
                   3812: in the metadata.
                   3813: 
                   3814: =cut
                   3815: 
                   3816: sub latexhyphenation {
                   3817:     my $key = shift;
                   3818:     return $latex_language_bykey{$key};
                   3819: }
                   3820: 
                   3821: =pod
                   3822: 
1.648     raeburn  3823: =item * &copyrightids() 
1.112     bowersj2 3824: 
                   3825: returns list of all copyrights
                   3826: 
                   3827: =cut
                   3828: 
                   3829: sub copyrightids {
                   3830:     return sort(keys(%cprtag));
                   3831: }
                   3832: 
                   3833: =pod
                   3834: 
1.648     raeburn  3835: =item * &copyrightdescription() 
1.112     bowersj2 3836: 
                   3837: returns description of a specified copyright id
                   3838: 
                   3839: =cut
                   3840: 
                   3841: sub copyrightdescription {
1.166     www      3842:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3843: }
1.197     matthew  3844: 
                   3845: =pod
                   3846: 
1.648     raeburn  3847: =item * &source_copyrightids() 
1.192     taceyjo1 3848: 
                   3849: returns list of all source copyrights
                   3850: 
                   3851: =cut
                   3852: 
                   3853: sub source_copyrightids {
                   3854:     return sort(keys(%scprtag));
                   3855: }
                   3856: 
                   3857: =pod
                   3858: 
1.648     raeburn  3859: =item * &source_copyrightdescription() 
1.192     taceyjo1 3860: 
                   3861: returns description of a specified source copyright id
                   3862: 
                   3863: =cut
                   3864: 
                   3865: sub source_copyrightdescription {
                   3866:     return &mt($scprtag{shift(@_)});
                   3867: }
1.112     bowersj2 3868: 
                   3869: =pod
                   3870: 
1.648     raeburn  3871: =item * &filecategories() 
1.112     bowersj2 3872: 
                   3873: returns list of all file categories
                   3874: 
                   3875: =cut
                   3876: 
                   3877: sub filecategories {
                   3878:     return sort(keys(%category_extensions));
                   3879: }
                   3880: 
                   3881: =pod
                   3882: 
1.648     raeburn  3883: =item * &filecategorytypes() 
1.112     bowersj2 3884: 
                   3885: returns list of file types belonging to a given file
                   3886: category
                   3887: 
                   3888: =cut
                   3889: 
                   3890: sub filecategorytypes {
1.356     albertel 3891:     my ($cat) = @_;
                   3892:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3893: }
                   3894: 
                   3895: =pod
                   3896: 
1.648     raeburn  3897: =item * &fileembstyle() 
1.112     bowersj2 3898: 
                   3899: returns embedding style for a specified file type
                   3900: 
                   3901: =cut
                   3902: 
                   3903: sub fileembstyle {
                   3904:     return $fe{lc(shift(@_))};
1.169     www      3905: }
                   3906: 
1.351     www      3907: sub filemimetype {
                   3908:     return $fm{lc(shift(@_))};
                   3909: }
                   3910: 
1.169     www      3911: 
                   3912: sub filecategoryselect {
                   3913:     my ($name,$value)=@_;
1.189     matthew  3914:     return &select_form($value,$name,
1.970     raeburn  3915:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112     bowersj2 3916: }
                   3917: 
                   3918: =pod
                   3919: 
1.648     raeburn  3920: =item * &filedescription() 
1.112     bowersj2 3921: 
                   3922: returns description for a specified file type
                   3923: 
                   3924: =cut
                   3925: 
                   3926: sub filedescription {
1.188     matthew  3927:     my $file_description = $fd{lc(shift())};
                   3928:     $file_description =~ s:([\[\]]):~$1:g;
                   3929:     return &mt($file_description);
1.112     bowersj2 3930: }
                   3931: 
                   3932: =pod
                   3933: 
1.648     raeburn  3934: =item * &filedescriptionex() 
1.112     bowersj2 3935: 
                   3936: returns description for a specified file type with
                   3937: extra formatting
                   3938: 
                   3939: =cut
                   3940: 
                   3941: sub filedescriptionex {
                   3942:     my $ex=shift;
1.188     matthew  3943:     my $file_description = $fd{lc($ex)};
                   3944:     $file_description =~ s:([\[\]]):~$1:g;
                   3945:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3946: }
                   3947: 
                   3948: # End of .tab access
                   3949: =pod
                   3950: 
                   3951: =back
                   3952: 
                   3953: =cut
                   3954: 
                   3955: # ------------------------------------------------------------------ File Types
                   3956: sub fileextensions {
                   3957:     return sort(keys(%fe));
                   3958: }
                   3959: 
1.97      www      3960: # ----------------------------------------------------------- Display Languages
                   3961: # returns a hash with all desired display languages
                   3962: #
                   3963: 
                   3964: sub display_languages {
                   3965:     my %languages=();
1.695     raeburn  3966:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3967: 	$languages{$lang}=1;
1.97      www      3968:     }
                   3969:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3970:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3971: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3972: 	    $languages{$lang}=1;
1.97      www      3973:         }
                   3974:     }
                   3975:     return %languages;
1.14      harris41 3976: }
                   3977: 
1.582     albertel 3978: sub languages {
                   3979:     my ($possible_langs) = @_;
1.695     raeburn  3980:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3981:     if (!ref($possible_langs)) {
                   3982: 	if( wantarray ) {
                   3983: 	    return @preferred_langs;
                   3984: 	} else {
                   3985: 	    return $preferred_langs[0];
                   3986: 	}
                   3987:     }
                   3988:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3989:     my @preferred_possibilities;
                   3990:     foreach my $preferred_lang (@preferred_langs) {
                   3991: 	if (exists($possibilities{$preferred_lang})) {
                   3992: 	    push(@preferred_possibilities, $preferred_lang);
                   3993: 	}
                   3994:     }
                   3995:     if( wantarray ) {
                   3996: 	return @preferred_possibilities;
                   3997:     }
                   3998:     return $preferred_possibilities[0];
                   3999: }
                   4000: 
1.742     raeburn  4001: sub user_lang {
                   4002:     my ($touname,$toudom,$fromcid) = @_;
                   4003:     my @userlangs;
                   4004:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   4005:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   4006:                     $env{'course.'.$fromcid.'.languages'}));
                   4007:     } else {
                   4008:         my %langhash = &getlangs($touname,$toudom);
                   4009:         if ($langhash{'languages'} ne '') {
                   4010:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   4011:         } else {
                   4012:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   4013:             if ($domdefs{'lang_def'} ne '') {
                   4014:                 @userlangs = ($domdefs{'lang_def'});
                   4015:             }
                   4016:         }
                   4017:     }
                   4018:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   4019:     my $user_lh = Apache::localize->get_handle(@languages);
                   4020:     return $user_lh;
                   4021: }
                   4022: 
                   4023: 
1.112     bowersj2 4024: ###############################################################
                   4025: ##               Student Answer Attempts                     ##
                   4026: ###############################################################
                   4027: 
                   4028: =pod
                   4029: 
                   4030: =head1 Alternate Problem Views
                   4031: 
                   4032: =over 4
                   4033: 
1.648     raeburn  4034: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1075.2.86  raeburn  4035:     $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112     bowersj2 4036: 
                   4037: Return string with previous attempt on problem. Arguments:
                   4038: 
                   4039: =over 4
                   4040: 
                   4041: =item * $symb: Problem, including path
                   4042: 
                   4043: =item * $username: username of the desired student
                   4044: 
                   4045: =item * $domain: domain of the desired student
1.14      harris41 4046: 
1.112     bowersj2 4047: =item * $course: Course ID
1.14      harris41 4048: 
1.112     bowersj2 4049: =item * $getattempt: Leave blank for all attempts, otherwise put
                   4050:     something
1.14      harris41 4051: 
1.112     bowersj2 4052: =item * $regexp: if string matches this regexp, the string will be
                   4053:     sent to $gradesub
1.14      harris41 4054: 
1.112     bowersj2 4055: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 4056: 
1.1075.2.86  raeburn  4057: =item * $usec: section of the desired student
                   4058: 
                   4059: =item * $identifier: counter for student (multiple students one problem) or
                   4060:     problem (one student; whole sequence).
                   4061: 
1.112     bowersj2 4062: =back
1.14      harris41 4063: 
1.112     bowersj2 4064: The output string is a table containing all desired attempts, if any.
1.16      harris41 4065: 
1.112     bowersj2 4066: =cut
1.1       albertel 4067: 
                   4068: sub get_previous_attempt {
1.1075.2.86  raeburn  4069:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1       albertel 4070:   my $prevattempts='';
1.43      ng       4071:   no strict 'refs';
1.1       albertel 4072:   if ($symb) {
1.3       albertel 4073:     my (%returnhash)=
                   4074:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 4075:     if ($returnhash{'version'}) {
                   4076:       my %lasthash=();
                   4077:       my $version;
                   4078:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.91  raeburn  4079:         foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
                   4080:             if ($key =~ /\.rawrndseed$/) {
                   4081:                 my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
                   4082:                 $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
                   4083:             } else {
                   4084:                 $lasthash{$key}=$returnhash{$version.':'.$key};
                   4085:             }
1.19      harris41 4086:         }
1.1       albertel 4087:       }
1.596     albertel 4088:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   4089:       $prevattempts.='<th>'.&mt('History').'</th>';
1.1075.2.86  raeburn  4090:       my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945     raeburn  4091:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 4092:       foreach my $key (sort(keys(%lasthash))) {
                   4093: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       4094: 	if ($#parts > 0) {
1.31      albertel 4095: 	  my $data=$parts[-1];
1.989     raeburn  4096:           next if ($data eq 'foilorder');
1.31      albertel 4097: 	  pop(@parts);
1.1010    www      4098:           $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.945     raeburn  4099:           if ($data eq 'type') {
                   4100:               unless ($showsurv) {
                   4101:                   my $id = join(',',@parts);
                   4102:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978     raeburn  4103:                   if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                   4104:                       $lasthidden{$ign.'.'.$id} = 1;
                   4105:                   }
1.945     raeburn  4106:               }
1.1075.2.86  raeburn  4107:               if ($identifier ne '') {
                   4108:                   my $id = join(',',@parts);
                   4109:                   if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
                   4110:                                                $domain,$username,$usec,undef,$course) =~ /^no/) {
                   4111:                       $hidestatus{$ign.'.'.$id} = 1;
                   4112:                   }
                   4113:               }
                   4114:           } elsif ($data eq 'regrader') {
                   4115:               if (($identifier ne '') && (@parts)) {
                   4116:                   my $id = join(',',@parts);
                   4117:                   $regraded{$ign.'.'.$id} = 1;
                   4118:               }
1.1010    www      4119:           } 
1.31      albertel 4120: 	} else {
1.41      ng       4121: 	  if ($#parts == 0) {
                   4122: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   4123: 	  } else {
                   4124: 	    $prevattempts.='<th>'.$ign.'</th>';
                   4125: 	  }
1.31      albertel 4126: 	}
1.16      harris41 4127:       }
1.596     albertel 4128:       $prevattempts.=&end_data_table_header_row();
1.40      ng       4129:       if ($getattempt eq '') {
1.1075.2.86  raeburn  4130:         my (%solved,%resets,%probstatus);
                   4131:         if (($identifier ne '') && (keys(%regraded) > 0)) {
                   4132:             for ($version=1;$version<=$returnhash{'version'};$version++) {
                   4133:                 foreach my $id (keys(%regraded)) {
                   4134:                     if (($returnhash{$version.':'.$id.'.regrader'}) &&
                   4135:                         ($returnhash{$version.':'.$id.'.tries'} eq '') &&
                   4136:                         ($returnhash{$version.':'.$id.'.award'} eq '')) {
                   4137:                         push(@{$resets{$id}},$version);
                   4138:                     }
                   4139:                 }
                   4140:             }
                   4141:         }
1.40      ng       4142: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.86  raeburn  4143:             my (@hidden,@unsolved);
1.945     raeburn  4144:             if (%typeparts) {
                   4145:                 foreach my $id (keys(%typeparts)) {
1.1075.2.86  raeburn  4146:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
                   4147:                         ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945     raeburn  4148:                         push(@hidden,$id);
1.1075.2.86  raeburn  4149:                     } elsif ($identifier ne '') {
                   4150:                         unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
                   4151:                                 ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
                   4152:                                 ($hidestatus{$id})) {
                   4153:                             next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
                   4154:                             if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
                   4155:                                 push(@{$solved{$id}},$version);
                   4156:                             } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
                   4157:                                      (ref($solved{$id}) eq 'ARRAY')) {
                   4158:                                 my $skip;
                   4159:                                 if (ref($resets{$id}) eq 'ARRAY') {
                   4160:                                     foreach my $reset (@{$resets{$id}}) {
                   4161:                                         if ($reset > $solved{$id}[-1]) {
                   4162:                                             $skip=1;
                   4163:                                             last;
                   4164:                                         }
                   4165:                                     }
                   4166:                                 }
                   4167:                                 unless ($skip) {
                   4168:                                     my ($ign,$partslist) = split(/\./,$id,2);
                   4169:                                     push(@unsolved,$partslist);
                   4170:                                 }
                   4171:                             }
                   4172:                         }
1.945     raeburn  4173:                     }
                   4174:                 }
                   4175:             }
                   4176:             $prevattempts.=&start_data_table_row().
1.1075.2.86  raeburn  4177:                            '<td>'.&mt('Transaction [_1]',$version);
                   4178:             if (@unsolved) {
                   4179:                 $prevattempts .= '<span class="LC_nobreak"><label>'.
                   4180:                                  '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
                   4181:                                  &mt('Hide').'</label></span>';
                   4182:             }
                   4183:             $prevattempts .= '</td>';
1.945     raeburn  4184:             if (@hidden) {
                   4185:                 foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4186:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  4187:                     my $hide;
                   4188:                     foreach my $id (@hidden) {
                   4189:                         if ($key =~ /^\Q$id\E/) {
                   4190:                             $hide = 1;
                   4191:                             last;
                   4192:                         }
                   4193:                     }
                   4194:                     if ($hide) {
                   4195:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   4196:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   4197:                             my $value = &format_previous_attempt_value($key,
                   4198:                                              $returnhash{$version.':'.$key});
                   4199:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4200:                         } else {
                   4201:                             $prevattempts.='<td>&nbsp;</td>';
                   4202:                         }
                   4203:                     } else {
                   4204:                         if ($key =~ /\./) {
1.1075.2.91  raeburn  4205:                             my $value = $returnhash{$version.':'.$key};
                   4206:                             if ($key =~ /\.rndseed$/) {
                   4207:                                 my ($id) = ($key =~ /^(.+)\.rndseed$/);
                   4208:                                 if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   4209:                                     $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   4210:                                 }
                   4211:                             }
                   4212:                             $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   4213:                                            '&nbsp;</td>';
1.945     raeburn  4214:                         } else {
                   4215:                             $prevattempts.='<td>&nbsp;</td>';
                   4216:                         }
                   4217:                     }
                   4218:                 }
                   4219:             } else {
                   4220: 	        foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4221:                     next if ($key =~ /\.foilorder$/);
1.1075.2.91  raeburn  4222:                     my $value = $returnhash{$version.':'.$key};
                   4223:                     if ($key =~ /\.rndseed$/) {
                   4224:                         my ($id) = ($key =~ /^(.+)\.rndseed$/);
                   4225:                         if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   4226:                             $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   4227:                         }
                   4228:                     }
                   4229:                     $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   4230:                                    '&nbsp;</td>';
1.945     raeburn  4231: 	        }
                   4232:             }
                   4233: 	    $prevattempts.=&end_data_table_row();
1.40      ng       4234: 	 }
1.1       albertel 4235:       }
1.945     raeburn  4236:       my @currhidden = keys(%lasthidden);
1.596     albertel 4237:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 4238:       foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4239:           next if ($key =~ /\.foilorder$/);
1.945     raeburn  4240:           if (%typeparts) {
                   4241:               my $hidden;
                   4242:               foreach my $id (@currhidden) {
                   4243:                   if ($key =~ /^\Q$id\E/) {
                   4244:                       $hidden = 1;
                   4245:                       last;
                   4246:                   }
                   4247:               }
                   4248:               if ($hidden) {
                   4249:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   4250:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   4251:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4252:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4253:                           $value = &$gradesub($value);
                   4254:                       }
                   4255:                       $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4256:                   } else {
                   4257:                       $prevattempts.='<td>&nbsp;</td>';
                   4258:                   }
                   4259:               } else {
                   4260:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4261:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4262:                       $value = &$gradesub($value);
                   4263:                   }
                   4264:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4265:               }
                   4266:           } else {
                   4267: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4268: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4269:                   $value = &$gradesub($value);
                   4270:               }
                   4271: 	      $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4272:           }
1.16      harris41 4273:       }
1.596     albertel 4274:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 4275:     } else {
1.596     albertel 4276:       $prevattempts=
                   4277: 	  &start_data_table().&start_data_table_row().
                   4278: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   4279: 	  &end_data_table_row().&end_data_table();
1.1       albertel 4280:     }
                   4281:   } else {
1.596     albertel 4282:     $prevattempts=
                   4283: 	  &start_data_table().&start_data_table_row().
                   4284: 	  '<td>'.&mt('No data.').'</td>'.
                   4285: 	  &end_data_table_row().&end_data_table();
1.1       albertel 4286:   }
1.10      albertel 4287: }
                   4288: 
1.581     albertel 4289: sub format_previous_attempt_value {
                   4290:     my ($key,$value) = @_;
1.1011    www      4291:     if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581     albertel 4292: 	$value = &Apache::lonlocal::locallocaltime($value);
                   4293:     } elsif (ref($value) eq 'ARRAY') {
                   4294: 	$value = '('.join(', ', @{ $value }).')';
1.988     raeburn  4295:     } elsif ($key =~ /answerstring$/) {
                   4296:         my %answers = &Apache::lonnet::str2hash($value);
                   4297:         my @anskeys = sort(keys(%answers));
                   4298:         if (@anskeys == 1) {
                   4299:             my $answer = $answers{$anskeys[0]};
1.1001    raeburn  4300:             if ($answer =~ m{\0}) {
                   4301:                 $answer =~ s{\0}{,}g;
1.988     raeburn  4302:             }
                   4303:             my $tag_internal_answer_name = 'INTERNAL';
                   4304:             if ($anskeys[0] eq $tag_internal_answer_name) {
                   4305:                 $value = $answer; 
                   4306:             } else {
                   4307:                 $value = $anskeys[0].'='.$answer;
                   4308:             }
                   4309:         } else {
                   4310:             foreach my $ans (@anskeys) {
                   4311:                 my $answer = $answers{$ans};
1.1001    raeburn  4312:                 if ($answer =~ m{\0}) {
                   4313:                     $answer =~ s{\0}{,}g;
1.988     raeburn  4314:                 }
                   4315:                 $value .=  $ans.'='.$answer.'<br />';;
                   4316:             } 
                   4317:         }
1.581     albertel 4318:     } else {
                   4319: 	$value = &unescape($value);
                   4320:     }
                   4321:     return $value;
                   4322: }
                   4323: 
                   4324: 
1.107     albertel 4325: sub relative_to_absolute {
                   4326:     my ($url,$output)=@_;
                   4327:     my $parser=HTML::TokeParser->new(\$output);
                   4328:     my $token;
                   4329:     my $thisdir=$url;
                   4330:     my @rlinks=();
                   4331:     while ($token=$parser->get_token) {
                   4332: 	if ($token->[0] eq 'S') {
                   4333: 	    if ($token->[1] eq 'a') {
                   4334: 		if ($token->[2]->{'href'}) {
                   4335: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   4336: 		}
                   4337: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   4338: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   4339: 	    } elsif ($token->[1] eq 'base') {
                   4340: 		$thisdir=$token->[2]->{'href'};
                   4341: 	    }
                   4342: 	}
                   4343:     }
                   4344:     $thisdir=~s-/[^/]*$--;
1.356     albertel 4345:     foreach my $link (@rlinks) {
1.726     raeburn  4346: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 4347: 		($link=~/^\//) ||
                   4348: 		($link=~/^javascript:/i) ||
                   4349: 		($link=~/^mailto:/i) ||
                   4350: 		($link=~/^\#/)) {
                   4351: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   4352: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 4353: 	}
                   4354:     }
                   4355: # -------------------------------------------------- Deal with Applet codebases
                   4356:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   4357:     return $output;
                   4358: }
                   4359: 
1.112     bowersj2 4360: =pod
                   4361: 
1.648     raeburn  4362: =item * &get_student_view()
1.112     bowersj2 4363: 
                   4364: show a snapshot of what student was looking at
                   4365: 
                   4366: =cut
                   4367: 
1.10      albertel 4368: sub get_student_view {
1.186     albertel 4369:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      4370:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4371:   my (%form);
1.10      albertel 4372:   my @elements=('symb','courseid','domain','username');
                   4373:   foreach my $element (@elements) {
1.186     albertel 4374:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4375:   }
1.186     albertel 4376:   if (defined($moreenv)) {
                   4377:       %form=(%form,%{$moreenv});
                   4378:   }
1.236     albertel 4379:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 4380:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      4381:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 4382:   $userview=~s/\<body[^\>]*\>//gi;
                   4383:   $userview=~s/\<\/body\>//gi;
                   4384:   $userview=~s/\<html\>//gi;
                   4385:   $userview=~s/\<\/html\>//gi;
                   4386:   $userview=~s/\<head\>//gi;
                   4387:   $userview=~s/\<\/head\>//gi;
                   4388:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 4389:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      4390:   if (wantarray) {
                   4391:      return ($userview,$response);
                   4392:   } else {
                   4393:      return $userview;
                   4394:   }
                   4395: }
                   4396: 
                   4397: sub get_student_view_with_retries {
                   4398:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   4399: 
                   4400:     my $ok = 0;                 # True if we got a good response.
                   4401:     my $content;
                   4402:     my $response;
                   4403: 
                   4404:     # Try to get the student_view done. within the retries count:
                   4405:     
                   4406:     do {
                   4407:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   4408:          $ok      = $response->is_success;
                   4409:          if (!$ok) {
                   4410:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   4411:          }
                   4412:          $retries--;
                   4413:     } while (!$ok && ($retries > 0));
                   4414:     
                   4415:     if (!$ok) {
                   4416:        $content = '';          # On error return an empty content.
                   4417:     }
1.651     www      4418:     if (wantarray) {
                   4419:        return ($content, $response);
                   4420:     } else {
                   4421:        return $content;
                   4422:     }
1.11      albertel 4423: }
                   4424: 
1.1075.2.149  raeburn  4425: sub css_links {
                   4426:     my ($currsymb,$level) = @_;
                   4427:     my ($links,@symbs,%cssrefs,%httpref);
                   4428:     if ($level eq 'map') {
                   4429:         my $navmap = Apache::lonnavmaps::navmap->new();
                   4430:         if (ref($navmap)) {
                   4431:             my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
                   4432:             my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
                   4433:             foreach my $res (@resources) {
                   4434:                 if (ref($res) && $res->symb()) {
                   4435:                     push(@symbs,$res->symb());
                   4436:                 }
                   4437:             }
                   4438:         }
                   4439:     } else {
                   4440:         @symbs = ($currsymb);
                   4441:     }
                   4442:     foreach my $symb (@symbs) {
                   4443:         my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
                   4444:         if ($css_href =~ /\S/) {
                   4445:             unless ($css_href =~ m{https?://}) {
                   4446:                 my $url = (&Apache::lonnet::decode_symb($symb))[-1];
                   4447:                 my $proburl =  &Apache::lonnet::clutter($url);
                   4448:                 my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
                   4449:                 unless ($css_href =~ m{^/}) {
                   4450:                     $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
                   4451:                 }
                   4452:                 if ($css_href =~ m{^/(res|uploaded)/}) {
                   4453:                     unless (($httpref{'httpref.'.$css_href}) ||
                   4454:                             (&Apache::lonnet::is_on_map($css_href))) {
                   4455:                         my $thisurl = $proburl;
                   4456:                         if ($env{'httpref.'.$proburl}) {
                   4457:                             $thisurl = $env{'httpref.'.$proburl};
                   4458:                         }
                   4459:                         $httpref{'httpref.'.$css_href} = $thisurl;
                   4460:                     }
                   4461:                 }
                   4462:             }
                   4463:             $cssrefs{$css_href} = 1;
                   4464:         }
                   4465:     }
                   4466:     if (keys(%httpref)) {
                   4467:         &Apache::lonnet::appenv(\%httpref);
                   4468:     }
                   4469:     if (keys(%cssrefs)) {
                   4470:         foreach my $css_href (keys(%cssrefs)) {
                   4471:             next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
                   4472:             $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
                   4473:         }
                   4474:     }
                   4475:     return $links;
                   4476: }
                   4477: 
1.112     bowersj2 4478: =pod
                   4479: 
1.648     raeburn  4480: =item * &get_student_answers() 
1.112     bowersj2 4481: 
                   4482: show a snapshot of how student was answering problem
                   4483: 
                   4484: =cut
                   4485: 
1.11      albertel 4486: sub get_student_answers {
1.100     sakharuk 4487:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      4488:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4489:   my (%moreenv);
1.11      albertel 4490:   my @elements=('symb','courseid','domain','username');
                   4491:   foreach my $element (@elements) {
1.186     albertel 4492:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4493:   }
1.186     albertel 4494:   $moreenv{'grade_target'}='answer';
                   4495:   %moreenv=(%form,%moreenv);
1.497     raeburn  4496:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   4497:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 4498:   return $userview;
1.1       albertel 4499: }
1.116     albertel 4500: 
                   4501: =pod
                   4502: 
                   4503: =item * &submlink()
                   4504: 
1.242     albertel 4505: Inputs: $text $uname $udom $symb $target
1.116     albertel 4506: 
                   4507: Returns: A link to grades.pm such as to see the SUBM view of a student
                   4508: 
                   4509: =cut
                   4510: 
                   4511: ###############################################
                   4512: sub submlink {
1.242     albertel 4513:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 4514:     if (!($uname && $udom)) {
                   4515: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4516: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 4517: 	if (!$symb) { $symb=$cursymb; }
                   4518:     }
1.254     matthew  4519:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4520:     $symb=&escape($symb);
1.960     bisitz   4521:     if ($target) { $target=" target=\"$target\""; }
                   4522:     return
                   4523:         '<a href="/adm/grades?command=submission'.
                   4524:         '&amp;symb='.$symb.
                   4525:         '&amp;student='.$uname.
                   4526:         '&amp;userdom='.$udom.'"'.
                   4527:         $target.'>'.$text.'</a>';
1.242     albertel 4528: }
                   4529: ##############################################
                   4530: 
                   4531: =pod
                   4532: 
                   4533: =item * &pgrdlink()
                   4534: 
                   4535: Inputs: $text $uname $udom $symb $target
                   4536: 
                   4537: Returns: A link to grades.pm such as to see the PGRD view of a student
                   4538: 
                   4539: =cut
                   4540: 
                   4541: ###############################################
                   4542: sub pgrdlink {
                   4543:     my $link=&submlink(@_);
                   4544:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   4545:     return $link;
                   4546: }
                   4547: ##############################################
                   4548: 
                   4549: =pod
                   4550: 
                   4551: =item * &pprmlink()
                   4552: 
                   4553: Inputs: $text $uname $udom $symb $target
                   4554: 
                   4555: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 4556: student and a specific resource
1.242     albertel 4557: 
                   4558: =cut
                   4559: 
                   4560: ###############################################
                   4561: sub pprmlink {
                   4562:     my ($text,$uname,$udom,$symb,$target)=@_;
                   4563:     if (!($uname && $udom)) {
                   4564: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4565: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 4566: 	if (!$symb) { $symb=$cursymb; }
                   4567:     }
1.254     matthew  4568:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4569:     $symb=&escape($symb);
1.242     albertel 4570:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 4571:     return '<a href="/adm/parmset?command=set&amp;'.
                   4572: 	'symb='.$symb.'&amp;uname='.$uname.
                   4573: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 4574: }
                   4575: ##############################################
1.37      matthew  4576: 
1.112     bowersj2 4577: =pod
                   4578: 
                   4579: =back
                   4580: 
                   4581: =cut
                   4582: 
1.37      matthew  4583: ###############################################
1.51      www      4584: 
                   4585: 
                   4586: sub timehash {
1.687     raeburn  4587:     my ($thistime) = @_;
                   4588:     my $timezone = &Apache::lonlocal::gettimezone();
                   4589:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   4590:                      ->set_time_zone($timezone);
                   4591:     my $wday = $dt->day_of_week();
                   4592:     if ($wday == 7) { $wday = 0; }
                   4593:     return ( 'second' => $dt->second(),
                   4594:              'minute' => $dt->minute(),
                   4595:              'hour'   => $dt->hour(),
                   4596:              'day'     => $dt->day_of_month(),
                   4597:              'month'   => $dt->month(),
                   4598:              'year'    => $dt->year(),
                   4599:              'weekday' => $wday,
                   4600:              'dayyear' => $dt->day_of_year(),
                   4601:              'dlsav'   => $dt->is_dst() );
1.51      www      4602: }
                   4603: 
1.370     www      4604: sub utc_string {
                   4605:     my ($date)=@_;
1.371     www      4606:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      4607: }
                   4608: 
1.51      www      4609: sub maketime {
                   4610:     my %th=@_;
1.687     raeburn  4611:     my ($epoch_time,$timezone,$dt);
                   4612:     $timezone = &Apache::lonlocal::gettimezone();
                   4613:     eval {
                   4614:         $dt = DateTime->new( year   => $th{'year'},
                   4615:                              month  => $th{'month'},
                   4616:                              day    => $th{'day'},
                   4617:                              hour   => $th{'hour'},
                   4618:                              minute => $th{'minute'},
                   4619:                              second => $th{'second'},
                   4620:                              time_zone => $timezone,
                   4621:                          );
                   4622:     };
                   4623:     if (!$@) {
                   4624:         $epoch_time = $dt->epoch;
                   4625:         if ($epoch_time) {
                   4626:             return $epoch_time;
                   4627:         }
                   4628:     }
1.51      www      4629:     return POSIX::mktime(
                   4630:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      4631:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      4632: }
                   4633: 
                   4634: #########################################
1.51      www      4635: 
                   4636: sub findallcourses {
1.482     raeburn  4637:     my ($roles,$uname,$udom) = @_;
1.355     albertel 4638:     my %roles;
                   4639:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 4640:     my %courses;
1.51      www      4641:     my $now=time;
1.482     raeburn  4642:     if (!defined($uname)) {
                   4643:         $uname = $env{'user.name'};
                   4644:     }
                   4645:     if (!defined($udom)) {
                   4646:         $udom = $env{'user.domain'};
                   4647:     }
                   4648:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073    raeburn  4649:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482     raeburn  4650:         if (!%roles) {
                   4651:             %roles = (
                   4652:                        cc => 1,
1.907     raeburn  4653:                        co => 1,
1.482     raeburn  4654:                        in => 1,
                   4655:                        ep => 1,
                   4656:                        ta => 1,
                   4657:                        cr => 1,
                   4658:                        st => 1,
                   4659:              );
                   4660:         }
                   4661:         foreach my $entry (keys(%roleshash)) {
                   4662:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   4663:             if ($trole =~ /^cr/) { 
                   4664:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   4665:             } else {
                   4666:                 next if (!exists($roles{$trole}));
                   4667:             }
                   4668:             if ($tend) {
                   4669:                 next if ($tend < $now);
                   4670:             }
                   4671:             if ($tstart) {
                   4672:                 next if ($tstart > $now);
                   4673:             }
1.1058    raeburn  4674:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482     raeburn  4675:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058    raeburn  4676:             my $value = $trole.'/'.$cdom.'/';
1.482     raeburn  4677:             if ($secpart eq '') {
                   4678:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   4679:                 $sec = 'none';
1.1058    raeburn  4680:                 $value .= $cnum.'/';
1.482     raeburn  4681:             } else {
                   4682:                 $cnum = $cnumpart;
                   4683:                 ($sec,$role) = split(/_/,$secpart);
1.1058    raeburn  4684:                 $value .= $cnum.'/'.$sec;
                   4685:             }
                   4686:             if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4687:                 unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4688:                     push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4689:                 }
                   4690:             } else {
                   4691:                 @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490     raeburn  4692:             }
1.482     raeburn  4693:         }
                   4694:     } else {
                   4695:         foreach my $key (keys(%env)) {
1.483     albertel 4696: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   4697:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  4698: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   4699: 	        next if ($role eq 'ca' || $role eq 'aa');
                   4700: 	        next if (%roles && !exists($roles{$role}));
                   4701: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   4702:                 my $active=1;
                   4703:                 if ($starttime) {
                   4704: 		    if ($now<$starttime) { $active=0; }
                   4705:                 }
                   4706:                 if ($endtime) {
                   4707:                     if ($now>$endtime) { $active=0; }
                   4708:                 }
                   4709:                 if ($active) {
1.1058    raeburn  4710:                     my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482     raeburn  4711:                     if ($sec eq '') {
                   4712:                         $sec = 'none';
1.1058    raeburn  4713:                     } else {
                   4714:                         $value .= $sec;
                   4715:                     }
                   4716:                     if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4717:                         unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4718:                             push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4719:                         }
                   4720:                     } else {
                   4721:                         @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482     raeburn  4722:                     }
1.474     raeburn  4723:                 }
                   4724:             }
1.51      www      4725:         }
                   4726:     }
1.474     raeburn  4727:     return %courses;
1.51      www      4728: }
1.37      matthew  4729: 
1.54      www      4730: ###############################################
1.474     raeburn  4731: 
                   4732: sub blockcheck {
1.1075.2.158  raeburn  4733:     my ($setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.490     raeburn  4734: 
1.1075.2.158  raeburn  4735:     unless ($activity eq 'docs') {
                   4736:         my ($has_evb,$check_ipaccess);
                   4737:         my $dom = $env{'user.domain'};
                   4738:         if ($env{'request.course.id'}) {
                   4739:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   4740:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   4741:             my $checkrole = "cm./$cdom/$cnum";
                   4742:             my $sec = $env{'request.course.sec'};
                   4743:             if ($sec ne '') {
                   4744:                 $checkrole .= "/$sec";
                   4745:             }
                   4746:             if ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   4747:                 ($env{'request.role'} !~ /^st/)) {
                   4748:                 $has_evb = 1;
                   4749:             }
                   4750:             unless ($has_evb) {
                   4751:                 if (($activity eq 'printout') || ($activity eq 'grades') || ($activity eq 'search') ||
                   4752:                     ($activity eq 'boards') || ($activity eq 'groups') || ($activity eq 'chat')) {
                   4753:                     if ($udom eq $cdom) {
                   4754:                         $check_ipaccess = 1;
                   4755:                     }
                   4756:                 }
                   4757:             }
                   4758:         }
                   4759:         unless ($has_evb || $check_ipaccess) {
                   4760:             my @machinedoms = &Apache::lonnet::current_machine_domains();
                   4761:             if (($dom eq 'public') && ($activity eq 'port')) {
                   4762:                 $dom = $udom;
                   4763:             }
                   4764:             if (($dom ne '') && (grep(/^\Q$dom\E$/,@machinedoms))) {
                   4765:                 $check_ipaccess = 1;
                   4766:             } else {
                   4767:                 my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   4768:                 my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
                   4769:                 my $prim = &Apache::lonnet::domain($dom,'primary');
                   4770:                 my $intdom = &Apache::lonnet::internet_dom($prim);
                   4771:                 if (($intdom ne '') && (ref($internet_names) eq 'ARRAY')) {
                   4772:                     if (grep(/^\Q$intdom\E$/,@{$internet_names})) {
                   4773:                         $check_ipaccess = 1;
                   4774:                     }
                   4775:                 }
                   4776:             }
                   4777:         }
                   4778:         if ($check_ipaccess) {
                   4779:             my ($ipaccessref,$cached)=&Apache::lonnet::is_cached_new('ipaccess',$dom);
                   4780:             unless (defined($cached)) {
                   4781:                 my %domconfig =
                   4782:                     &Apache::lonnet::get_dom('configuration',['ipaccess'],$dom);
                   4783:                 $ipaccessref = &Apache::lonnet::do_cache_new('ipaccess',$dom,$domconfig{'ipaccess'},1800);
                   4784:             }
                   4785:             if ((ref($ipaccessref) eq 'HASH') && ($clientip)) {
                   4786:                 foreach my $id (keys(%{$ipaccessref})) {
                   4787:                     if (ref($ipaccessref->{$id}) eq 'HASH') {
                   4788:                         my $range = $ipaccessref->{$id}->{'ip'};
                   4789:                         if ($range) {
                   4790:                             if (&Apache::lonnet::ip_match($clientip,$range)) {
                   4791:                                 if (ref($ipaccessref->{$id}->{'commblocks'}) eq 'HASH') {
                   4792:                                     if ($ipaccessref->{$id}->{'commblocks'}->{$activity} eq 'on') {
                   4793:                                         return ('','','',$id,$dom);
                   4794:                                         last;
                   4795:                                     }
                   4796:                                 }
                   4797:                             }
                   4798:                         }
                   4799:                     }
                   4800:                 }
                   4801:             }
                   4802:         }
                   4803:     }
1.1075.2.73  raeburn  4804:     if (defined($udom) && defined($uname)) {
                   4805:         # If uname and udom are for a course, check for blocks in the course.
                   4806:         if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
                   4807:             my ($startblock,$endblock,$triggerblock) =
1.1075.2.147  raeburn  4808:                 &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1075.2.73  raeburn  4809:             return ($startblock,$endblock,$triggerblock);
                   4810:         }
                   4811:     } else {
1.490     raeburn  4812:         $udom = $env{'user.domain'};
                   4813:         $uname = $env{'user.name'};
                   4814:     }
                   4815: 
1.502     raeburn  4816:     my $startblock = 0;
                   4817:     my $endblock = 0;
1.1062    raeburn  4818:     my $triggerblock = '';
1.1075.2.160  raeburn  4819:     my %live_courses;
                   4820:     unless (($activity eq 'wishlist') || ($activity eq 'annotate')) {
                   4821:         %live_courses = &findallcourses(undef,$uname,$udom);
                   4822:     }
1.474     raeburn  4823: 
1.490     raeburn  4824:     # If uname is for a user, and activity is course-specific, i.e.,
                   4825:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  4826: 
1.490     raeburn  4827:     if (($activity eq 'boards' || $activity eq 'chat' ||
1.1075.2.161.  .1(raebu 4828:21):          $activity eq 'groups' || $activity eq 'printout' ||
                   4829:21):          $activity eq 'search' || $activity eq 'reinit' ||
                   4830:21):          $activity eq 'alert') && ($env{'request.course.id'})) {
1.490     raeburn  4831:         foreach my $key (keys(%live_courses)) {
                   4832:             if ($key ne $env{'request.course.id'}) {
                   4833:                 delete($live_courses{$key});
                   4834:             }
                   4835:         }
                   4836:     }
                   4837: 
                   4838:     my $otheruser = 0;
                   4839:     my %own_courses;
                   4840:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   4841:         # Resource belongs to user other than current user.
                   4842:         $otheruser = 1;
                   4843:         # Gather courses for current user
                   4844:         %own_courses = 
                   4845:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   4846:     }
                   4847: 
                   4848:     # Gather active course roles - course coordinator, instructor, 
                   4849:     # exam proctor, ta, student, or custom role.
1.474     raeburn  4850: 
                   4851:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  4852:         my ($cdom,$cnum);
                   4853:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   4854:             $cdom = $env{'course.'.$course.'.domain'};
                   4855:             $cnum = $env{'course.'.$course.'.num'};
                   4856:         } else {
1.490     raeburn  4857:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  4858:         }
                   4859:         my $no_ownblock = 0;
                   4860:         my $no_userblock = 0;
1.533     raeburn  4861:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  4862:             # Check if current user has 'evb' priv for this
                   4863:             if (defined($own_courses{$course})) {
                   4864:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   4865:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   4866:                     if ($sec ne 'none') {
                   4867:                         $checkrole .= '/'.$sec;
                   4868:                     }
                   4869:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4870:                         $no_ownblock = 1;
                   4871:                         last;
                   4872:                     }
                   4873:                 }
                   4874:             }
                   4875:             # if they have 'evb' priv and are currently not playing student
                   4876:             next if (($no_ownblock) &&
                   4877:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   4878:         }
1.474     raeburn  4879:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  4880:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  4881:             if ($sec ne 'none') {
1.482     raeburn  4882:                 $checkrole .= '/'.$sec;
1.474     raeburn  4883:             }
1.490     raeburn  4884:             if ($otheruser) {
                   4885:                 # Resource belongs to user other than current user.
                   4886:                 # Assemble privs for that user, and check for 'evb' priv.
1.1058    raeburn  4887:                 my (%allroles,%userroles);
                   4888:                 if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
                   4889:                     foreach my $entry (@{$live_courses{$course}{$sec}}) { 
                   4890:                         my ($trole,$tdom,$tnum,$tsec);
                   4891:                         if ($entry =~ /^cr/) {
                   4892:                             ($trole,$tdom,$tnum,$tsec) = 
                   4893:                                 ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   4894:                         } else {
                   4895:                            ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   4896:                         }
                   4897:                         my ($spec,$area,$trest);
                   4898:                         $area = '/'.$tdom.'/'.$tnum;
                   4899:                         $trest = $tnum;
                   4900:                         if ($tsec ne '') {
                   4901:                             $area .= '/'.$tsec;
                   4902:                             $trest .= '/'.$tsec;
                   4903:                         }
                   4904:                         $spec = $trole.'.'.$area;
                   4905:                         if ($trole =~ /^cr/) {
                   4906:                             &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   4907:                                                               $tdom,$spec,$trest,$area);
                   4908:                         } else {
                   4909:                             &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   4910:                                                                 $tdom,$spec,$trest,$area);
                   4911:                         }
                   4912:                     }
1.1075.2.124  raeburn  4913:                     my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058    raeburn  4914:                     if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   4915:                         if ($1) {
                   4916:                             $no_userblock = 1;
                   4917:                             last;
                   4918:                         }
1.486     raeburn  4919:                     }
                   4920:                 }
1.490     raeburn  4921:             } else {
                   4922:                 # Resource belongs to current user
                   4923:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  4924:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4925:                     $no_ownblock = 1;
                   4926:                     last;
                   4927:                 }
1.474     raeburn  4928:             }
                   4929:         }
                   4930:         # if they have the evb priv and are currently not playing student
1.482     raeburn  4931:         next if (($no_ownblock) &&
1.491     albertel 4932:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  4933:         next if ($no_userblock);
1.474     raeburn  4934: 
1.1075.2.128  raeburn  4935:         # Retrieve blocking times and identity of blocker for course
1.490     raeburn  4936:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  4937:         
1.1062    raeburn  4938:         my ($start,$end,$trigger) = 
1.1075.2.147  raeburn  4939:             &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502     raeburn  4940:         if (($start != 0) && 
                   4941:             (($startblock == 0) || ($startblock > $start))) {
                   4942:             $startblock = $start;
1.1062    raeburn  4943:             if ($trigger ne '') {
                   4944:                 $triggerblock = $trigger;
                   4945:             }
1.502     raeburn  4946:         }
                   4947:         if (($end != 0)  &&
                   4948:             (($endblock == 0) || ($endblock < $end))) {
                   4949:             $endblock = $end;
1.1062    raeburn  4950:             if ($trigger ne '') {
                   4951:                 $triggerblock = $trigger;
                   4952:             }
1.502     raeburn  4953:         }
1.490     raeburn  4954:     }
1.1062    raeburn  4955:     return ($startblock,$endblock,$triggerblock);
1.490     raeburn  4956: }
                   4957: 
                   4958: sub get_blocks {
1.1075.2.147  raeburn  4959:     my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490     raeburn  4960:     my $startblock = 0;
                   4961:     my $endblock = 0;
1.1062    raeburn  4962:     my $triggerblock = '';
1.490     raeburn  4963:     my $course = $cdom.'_'.$cnum;
                   4964:     $setters->{$course} = {};
                   4965:     $setters->{$course}{'staff'} = [];
                   4966:     $setters->{$course}{'times'} = [];
1.1062    raeburn  4967:     $setters->{$course}{'triggers'} = [];
                   4968:     my (@blockers,%triggered);
                   4969:     my $now = time;
                   4970:     my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
                   4971:     if ($activity eq 'docs') {
1.1075.2.148  raeburn  4972:         my ($blocked,$nosymbcache,$noenccheck);
1.1075.2.147  raeburn  4973:         if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
                   4974:             $blocked = 1;
                   4975:             $nosymbcache = 1;
1.1075.2.148  raeburn  4976:             $noenccheck = 1;
1.1075.2.147  raeburn  4977:         }
1.1075.2.148  raeburn  4978:         @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062    raeburn  4979:         foreach my $block (@blockers) {
                   4980:             if ($block =~ /^firstaccess____(.+)$/) {
                   4981:                 my $item = $1;
                   4982:                 my $type = 'map';
                   4983:                 my $timersymb = $item;
                   4984:                 if ($item eq 'course') {
                   4985:                     $type = 'course';
                   4986:                 } elsif ($item =~ /___\d+___/) {
                   4987:                     $type = 'resource';
                   4988:                 } else {
                   4989:                     $timersymb = &Apache::lonnet::symbread($item);
                   4990:                 }
                   4991:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4992:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
                   4993:                 $triggered{$block} = {
                   4994:                                        start => $start,
                   4995:                                        end   => $end,
                   4996:                                        type  => $type,
                   4997:                                      };
                   4998:             }
                   4999:         }
                   5000:     } else {
                   5001:         foreach my $block (keys(%commblocks)) {
                   5002:             if ($block =~ m/^(\d+)____(\d+)$/) { 
                   5003:                 my ($start,$end) = ($1,$2);
                   5004:                 if ($start <= time && $end >= time) {
                   5005:                     if (ref($commblocks{$block}) eq 'HASH') {
                   5006:                         if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   5007:                             if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   5008:                                 unless(grep(/^\Q$block\E$/,@blockers)) {
                   5009:                                     push(@blockers,$block);
                   5010:                                 }
                   5011:                             }
                   5012:                         }
                   5013:                     }
                   5014:                 }
                   5015:             } elsif ($block =~ /^firstaccess____(.+)$/) {
                   5016:                 my $item = $1;
                   5017:                 my $timersymb = $item; 
                   5018:                 my $type = 'map';
                   5019:                 if ($item eq 'course') {
                   5020:                     $type = 'course';
                   5021:                 } elsif ($item =~ /___\d+___/) {
                   5022:                     $type = 'resource';
                   5023:                 } else {
                   5024:                     $timersymb = &Apache::lonnet::symbread($item);
                   5025:                 }
                   5026:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   5027:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb}; 
                   5028:                 if ($start && $end) {
                   5029:                     if (($start <= time) && ($end >= time)) {
1.1075.2.158  raeburn  5030:                         if (ref($commblocks{$block}) eq 'HASH') {
                   5031:                             if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   5032:                                 if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   5033:                                     unless(grep(/^\Q$block\E$/,@blockers)) {
                   5034:                                         push(@blockers,$block);
                   5035:                                         $triggered{$block} = {
                   5036:                                                                start => $start,
                   5037:                                                                end   => $end,
                   5038:                                                                type  => $type,
                   5039:                                                              };
                   5040:                                     }
                   5041:                                 }
                   5042:                             }
1.1062    raeburn  5043:                         }
                   5044:                     }
1.490     raeburn  5045:                 }
1.1062    raeburn  5046:             }
                   5047:         }
                   5048:     }
                   5049:     foreach my $blocker (@blockers) {
                   5050:         my ($staff_name,$staff_dom,$title,$blocks) =
                   5051:             &parse_block_record($commblocks{$blocker});
                   5052:         push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   5053:         my ($start,$end,$triggertype);
                   5054:         if ($blocker =~ m/^(\d+)____(\d+)$/) {
                   5055:             ($start,$end) = ($1,$2);
                   5056:         } elsif (ref($triggered{$blocker}) eq 'HASH') {
                   5057:             $start = $triggered{$blocker}{'start'};
                   5058:             $end = $triggered{$blocker}{'end'};
                   5059:             $triggertype = $triggered{$blocker}{'type'};
                   5060:         }
                   5061:         if ($start) {
                   5062:             push(@{$$setters{$course}{'times'}}, [$start,$end]);
                   5063:             if ($triggertype) {
                   5064:                 push(@{$$setters{$course}{'triggers'}},$triggertype);
                   5065:             } else {
                   5066:                 push(@{$$setters{$course}{'triggers'}},0);
                   5067:             }
                   5068:             if ( ($startblock == 0) || ($startblock > $start) ) {
                   5069:                 $startblock = $start;
                   5070:                 if ($triggertype) {
                   5071:                     $triggerblock = $blocker;
1.474     raeburn  5072:                 }
                   5073:             }
1.1062    raeburn  5074:             if ( ($endblock == 0) || ($endblock < $end) ) {
                   5075:                $endblock = $end;
                   5076:                if ($triggertype) {
                   5077:                    $triggerblock = $blocker;
                   5078:                }
                   5079:             }
1.474     raeburn  5080:         }
                   5081:     }
1.1062    raeburn  5082:     return ($startblock,$endblock,$triggerblock);
1.474     raeburn  5083: }
                   5084: 
                   5085: sub parse_block_record {
                   5086:     my ($record) = @_;
                   5087:     my ($setuname,$setudom,$title,$blocks);
                   5088:     if (ref($record) eq 'HASH') {
                   5089:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   5090:         $title = &unescape($record->{'event'});
                   5091:         $blocks = $record->{'blocks'};
                   5092:     } else {
                   5093:         my @data = split(/:/,$record,3);
                   5094:         if (scalar(@data) eq 2) {
                   5095:             $title = $data[1];
                   5096:             ($setuname,$setudom) = split(/@/,$data[0]);
                   5097:         } else {
                   5098:             ($setuname,$setudom,$title) = @data;
                   5099:         }
                   5100:         $blocks = { 'com' => 'on' };
                   5101:     }
                   5102:     return ($setuname,$setudom,$title,$blocks);
                   5103: }
                   5104: 
1.854     kalberla 5105: sub blocking_status {
1.1075.2.158  raeburn  5106:     my ($activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061    raeburn  5107:     my %setters;
1.890     droeschl 5108: 
1.1061    raeburn  5109: # check for active blocking
1.1075.2.158  raeburn  5110:     if ($clientip eq '') {
                   5111:         $clientip = &Apache::lonnet::get_requestor_ip();
                   5112:     }
                   5113:     my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) = 
                   5114:         &blockcheck(\%setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062    raeburn  5115:     my $blocked = 0;
1.1075.2.158  raeburn  5116:     if (($startblock && $endblock) || ($by_ip)) {
1.1062    raeburn  5117:         $blocked = 1;
                   5118:     }
1.890     droeschl 5119: 
1.1061    raeburn  5120: # caller just wants to know whether a block is active
                   5121:     if (!wantarray) { return $blocked; }
                   5122: 
                   5123: # build a link to a popup window containing the details
                   5124:     my $querystring  = "?activity=$activity";
1.1075.2.158  raeburn  5125: # $uname and $udom decide whose portfolio (or information page) the user is trying to look at
                   5126:     if (($activity eq 'port') || ($activity eq 'about') || ($activity eq 'passwd')) {
1.1075.2.97  raeburn  5127:         $querystring .= "&amp;udom=$udom"      if ($udom =~ /^$match_domain$/);
                   5128:         $querystring .= "&amp;uname=$uname"    if ($uname =~ /^$match_username$/);
1.1062    raeburn  5129:     } elsif ($activity eq 'docs') {
1.1075.2.147  raeburn  5130:         my $showurl = &Apache::lonenc::check_encrypt($url);
                   5131:         $querystring .= '&amp;url='.&HTML::Entities::encode($showurl,'\'&"<>');
                   5132:         if ($symb) {
                   5133:             my $showsymb = &Apache::lonenc::check_encrypt($symb);
                   5134:             $querystring .= '&amp;symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
                   5135:         }
1.1062    raeburn  5136:     }
1.1061    raeburn  5137: 
                   5138:     my $output .= <<'END_MYBLOCK';
                   5139: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   5140:     var options = "width=" + w + ",height=" + h + ",";
                   5141:     options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   5142:     options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   5143:     var newWin = window.open(url, wdwName, options);
                   5144:     newWin.focus();
                   5145: }
1.890     droeschl 5146: END_MYBLOCK
1.854     kalberla 5147: 
1.1061    raeburn  5148:     $output = Apache::lonhtmlcommon::scripttag($output);
1.890     droeschl 5149:   
1.1061    raeburn  5150:     my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062    raeburn  5151:     my $text = &mt('Communication Blocked');
1.1075.2.93  raeburn  5152:     my $class = 'LC_comblock';
1.1062    raeburn  5153:     if ($activity eq 'docs') {
                   5154:         $text = &mt('Content Access Blocked');
1.1075.2.93  raeburn  5155:         $class = '';
1.1063    raeburn  5156:     } elsif ($activity eq 'printout') {
                   5157:         $text = &mt('Printing Blocked');
1.1075.2.97  raeburn  5158:     } elsif ($activity eq 'passwd') {
                   5159:         $text = &mt('Password Changing Blocked');
1.1075.2.158  raeburn  5160:     } elsif ($activity eq 'grades') {
                   5161:         $text = &mt('Gradebook Blocked');
                   5162:     } elsif ($activity eq 'search') {
                   5163:         $text = &mt('Search Blocked');
1.1075.2.161.  .1(raebu 5164:21):     } elsif ($activity eq 'alert') {
                   5165:21):         $text = &mt('Checking Critical Messages Blocked');
                   5166:21):     } elsif ($activity eq 'reinit') {
                   5167:21):         $text = &mt('Checking Course Update Blocked');
1.1075.2.158  raeburn  5168:     } elsif ($activity eq 'about') {
                   5169:         $text = &mt('Access to User Information Pages Blocked');
1.1075.2.160  raeburn  5170:     } elsif ($activity eq 'wishlist') {
                   5171:         $text = &mt('Access to Stored Links Blocked');
                   5172:     } elsif ($activity eq 'annotate') {
                   5173:         $text = &mt('Access to Annotations Blocked');
1.1062    raeburn  5174:     }
1.1061    raeburn  5175:     $output .= <<"END_BLOCK";
1.1075.2.93  raeburn  5176: <div class='$class'>
1.869     kalberla 5177:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 5178:   title='$text'>
                   5179:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 5180:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 5181:   title='$text'>$text</a>
1.867     kalberla 5182: </div>
                   5183: 
                   5184: END_BLOCK
1.474     raeburn  5185: 
1.1061    raeburn  5186:     return ($blocked, $output);
1.854     kalberla 5187: }
1.490     raeburn  5188: 
1.60      matthew  5189: ###############################################
                   5190: 
1.682     raeburn  5191: sub check_ip_acc {
1.1075.2.105  raeburn  5192:     my ($acc,$clientip)=@_;
1.682     raeburn  5193:     &Apache::lonxml::debug("acc is $acc");
                   5194:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   5195:         return 1;
                   5196:     }
                   5197:     my $allowed=0;
1.1075.2.144  raeburn  5198:     my $ip;
                   5199:     if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
                   5200:         ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
                   5201:         $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
                   5202:     } else {
1.1075.2.150  raeburn  5203:         my $remote_ip = &Apache::lonnet::get_requestor_ip();
                   5204:         $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1075.2.144  raeburn  5205:     }
1.682     raeburn  5206: 
                   5207:     my $name;
1.1075.2.161.  .1(raebu 5208:21):     my %access = (
                   5209:21):                      allowfrom => 1,
                   5210:21):                      denyfrom  => 0,
                   5211:21):                  );
                   5212:21):     my @allows;
                   5213:21):     my @denies;
                   5214:21):     foreach my $item (split(',',$acc)) {
                   5215:21):         $item =~ s/^\s*//;
                   5216:21):         $item =~ s/\s*$//;
                   5217:21):         if ($item =~ /^\!(.+)$/) {
                   5218:21):             push(@denies,$1);
                   5219:21):         } else {
                   5220:21):             push(@allows,$item);
                   5221:21):         }
                   5222:21):     }
                   5223:21):     my $numdenies = scalar(@denies);
                   5224:21):     my $numallows = scalar(@allows);
                   5225:21):     my $count = 0;
                   5226:21):     foreach my $pattern (@denies,@allows) {
                   5227:21):         $count ++;
                   5228:21):         my $acctype = 'allowfrom';
                   5229:21):         if ($count <= $numdenies) {
                   5230:21):             $acctype = 'denyfrom';
                   5231:21):         }
1.682     raeburn  5232:         if ($pattern =~ /\*$/) {
                   5233:             #35.8.*
                   5234:             $pattern=~s/\*//;
1.1075.2.161.  .1(raebu 5235:21):             if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682     raeburn  5236:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   5237:             #35.8.3.[34-56]
                   5238:             my $low=$2;
                   5239:             my $high=$3;
                   5240:             $pattern=$1;
                   5241:             if ($ip =~ /^\Q$pattern\E/) {
                   5242:                 my $last=(split(/\./,$ip))[3];
1.1075.2.161.  .1(raebu 5243:21):                 if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682     raeburn  5244:             }
                   5245:         } elsif ($pattern =~ /^\*/) {
                   5246:             #*.msu.edu
                   5247:             $pattern=~s/\*//;
                   5248:             if (!defined($name)) {
                   5249:                 use Socket;
                   5250:                 my $netaddr=inet_aton($ip);
                   5251:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   5252:             }
1.1075.2.161.  .1(raebu 5253:21):             if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682     raeburn  5254:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   5255:             #127.0.0.1
1.1075.2.161.  .1(raebu 5256:21):             if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682     raeburn  5257:         } else {
                   5258:             #some.name.com
                   5259:             if (!defined($name)) {
                   5260:                 use Socket;
                   5261:                 my $netaddr=inet_aton($ip);
                   5262:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   5263:             }
1.1075.2.161.  .1(raebu 5264:21):             if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
                   5265:21):         }
                   5266:21):         if ($allowed =~ /^(0|1)$/) { last; }
                   5267:21):     }
                   5268:21):     if ($allowed eq '') {
                   5269:21):         if ($numdenies && !$numallows) {
                   5270:21):             $allowed = 1;
                   5271:21):         } else {
                   5272:21):             $allowed = 0;
1.682     raeburn  5273:         }
                   5274:     }
                   5275:     return $allowed;
                   5276: }
                   5277: 
                   5278: ###############################################
                   5279: 
1.60      matthew  5280: =pod
                   5281: 
1.112     bowersj2 5282: =head1 Domain Template Functions
                   5283: 
                   5284: =over 4
                   5285: 
                   5286: =item * &determinedomain()
1.60      matthew  5287: 
                   5288: Inputs: $domain (usually will be undef)
                   5289: 
1.63      www      5290: Returns: Determines which domain should be used for designs
1.60      matthew  5291: 
                   5292: =cut
1.54      www      5293: 
1.60      matthew  5294: ###############################################
1.63      www      5295: sub determinedomain {
                   5296:     my $domain=shift;
1.531     albertel 5297:     if (! $domain) {
1.60      matthew  5298:         # Determine domain if we have not been given one
1.893     raeburn  5299:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 5300:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   5301:         if ($env{'request.role.domain'}) { 
                   5302:             $domain=$env{'request.role.domain'}; 
1.60      matthew  5303:         }
                   5304:     }
1.63      www      5305:     return $domain;
                   5306: }
                   5307: ###############################################
1.517     raeburn  5308: 
1.518     albertel 5309: sub devalidate_domconfig_cache {
                   5310:     my ($udom)=@_;
                   5311:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   5312: }
                   5313: 
                   5314: # ---------------------- Get domain configuration for a domain
                   5315: sub get_domainconf {
                   5316:     my ($udom) = @_;
                   5317:     my $cachetime=1800;
                   5318:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   5319:     if (defined($cached)) { return %{$result}; }
                   5320: 
                   5321:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  5322: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  5323:     my (%designhash,%legacy);
1.518     albertel 5324:     if (keys(%domconfig) > 0) {
                   5325:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  5326:             if (keys(%{$domconfig{'login'}})) {
                   5327:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  5328:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1075.2.87  raeburn  5329:                         if (($key eq 'loginvia') || ($key eq 'headtag')) {
                   5330:                             if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   5331:                                 foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
                   5332:                                     if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
                   5333:                                         if ($key eq 'loginvia') {
                   5334:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   5335:                                                 my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   5336:                                                 $designhash{$udom.'.login.loginvia'} = $server;
                   5337:                                                 if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   5338:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   5339:                                                 } else {
                   5340:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
                   5341:                                                 }
1.948     raeburn  5342:                                             }
1.1075.2.87  raeburn  5343:                                         } elsif ($key eq 'headtag') {
                   5344:                                             if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
                   5345:                                                 $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948     raeburn  5346:                                             }
1.946     raeburn  5347:                                         }
1.1075.2.87  raeburn  5348:                                         if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
                   5349:                                             $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
                   5350:                                         }
1.946     raeburn  5351:                                     }
                   5352:                                 }
                   5353:                             }
1.1075.2.158  raeburn  5354:                         } elsif ($key eq 'saml') {
                   5355:                             if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   5356:                                 foreach my $host (keys(%{$domconfig{'login'}{$key}})) {
                   5357:                                     if (ref($domconfig{'login'}{$key}{$host}) eq 'HASH') {
                   5358:                                         $designhash{$udom.'.login.'.$key.'_'.$host} = 1;
                   5359:                                         foreach my $item ('text','img','alt','url','title','notsso') {
                   5360:                                             $designhash{$udom.'.login.'.$key.'_'.$item.'_'.$host} = $domconfig{'login'}{$key}{$host}{$item};
                   5361:                                         }
                   5362:                                     }
                   5363:                                 }
                   5364:                             }
1.946     raeburn  5365:                         } else {
                   5366:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   5367:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   5368:                                     $domconfig{'login'}{$key}{$img};
                   5369:                             }
1.699     raeburn  5370:                         }
                   5371:                     } else {
                   5372:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   5373:                     }
1.632     raeburn  5374:                 }
                   5375:             } else {
                   5376:                 $legacy{'login'} = 1;
1.518     albertel 5377:             }
1.632     raeburn  5378:         } else {
                   5379:             $legacy{'login'} = 1;
1.518     albertel 5380:         }
                   5381:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  5382:             if (keys(%{$domconfig{'rolecolors'}})) {
                   5383:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   5384:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   5385:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   5386:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   5387:                         }
1.518     albertel 5388:                     }
                   5389:                 }
1.632     raeburn  5390:             } else {
                   5391:                 $legacy{'rolecolors'} = 1;
1.518     albertel 5392:             }
1.632     raeburn  5393:         } else {
                   5394:             $legacy{'rolecolors'} = 1;
1.518     albertel 5395:         }
1.948     raeburn  5396:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   5397:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   5398:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   5399:             }
                   5400:         }
1.632     raeburn  5401:         if (keys(%legacy) > 0) {
                   5402:             my %legacyhash = &get_legacy_domconf($udom);
                   5403:             foreach my $item (keys(%legacyhash)) {
                   5404:                 if ($item =~ /^\Q$udom\E\.login/) {
                   5405:                     if ($legacy{'login'}) { 
                   5406:                         $designhash{$item} = $legacyhash{$item};
                   5407:                     }
                   5408:                 } else {
                   5409:                     if ($legacy{'rolecolors'}) {
                   5410:                         $designhash{$item} = $legacyhash{$item};
                   5411:                     }
1.518     albertel 5412:                 }
                   5413:             }
                   5414:         }
1.632     raeburn  5415:     } else {
                   5416:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 5417:     }
                   5418:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   5419: 				  $cachetime);
                   5420:     return %designhash;
                   5421: }
                   5422: 
1.632     raeburn  5423: sub get_legacy_domconf {
                   5424:     my ($udom) = @_;
                   5425:     my %legacyhash;
                   5426:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   5427:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   5428:     if (-e $designfile) {
1.1075.2.128  raeburn  5429:         if ( open (my $fh,'<',$designfile) ) {
1.632     raeburn  5430:             while (my $line = <$fh>) {
                   5431:                 next if ($line =~ /^\#/);
                   5432:                 chomp($line);
                   5433:                 my ($key,$val)=(split(/\=/,$line));
                   5434:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   5435:             }
                   5436:             close($fh);
                   5437:         }
                   5438:     }
1.1026    raeburn  5439:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  5440:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   5441:     }
                   5442:     return %legacyhash;
                   5443: }
                   5444: 
1.63      www      5445: =pod
                   5446: 
1.112     bowersj2 5447: =item * &domainlogo()
1.63      www      5448: 
                   5449: Inputs: $domain (usually will be undef)
                   5450: 
                   5451: Returns: A link to a domain logo, if the domain logo exists.
                   5452: If the domain logo does not exist, a description of the domain.
                   5453: 
                   5454: =cut
1.112     bowersj2 5455: 
1.63      www      5456: ###############################################
                   5457: sub domainlogo {
1.517     raeburn  5458:     my $domain = &determinedomain(shift);
1.518     albertel 5459:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  5460:     # See if there is a logo
                   5461:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  5462:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 5463:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   5464: 	    if ($imgsrc =~ m{^/res/}) {
                   5465: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   5466: 		&Apache::lonnet::repcopy($local_name);
                   5467: 	    }
                   5468: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.1075.2.161.  .2(raebu 5469:22):         }
                   5470:22):         my $alttext = $domain;
                   5471:22):         if ($designhash{$domain.'.login.alttext_domlogo'} ne '') {
                   5472:22):             $alttext = $designhash{$domain.'.login.alttext_domlogo'};
                   5473:22):         }
                   5474:22):         return '<img src="'.$imgsrc.'" alt="'.$alttext.'" id="lclogindomlogo" />';
1.514     albertel 5475:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   5476:         return &Apache::lonnet::domain($domain,'description');
1.59      www      5477:     } else {
1.60      matthew  5478:         return '';
1.59      www      5479:     }
                   5480: }
1.63      www      5481: ##############################################
                   5482: 
                   5483: =pod
                   5484: 
1.112     bowersj2 5485: =item * &designparm()
1.63      www      5486: 
                   5487: Inputs: $which parameter; $domain (usually will be undef)
                   5488: 
                   5489: Returns: value of designparamter $which
                   5490: 
                   5491: =cut
1.112     bowersj2 5492: 
1.397     albertel 5493: 
1.400     albertel 5494: ##############################################
1.397     albertel 5495: sub designparm {
                   5496:     my ($which,$domain)=@_;
                   5497:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   5498:         return $env{'environment.color.'.$which};
1.96      www      5499:     }
1.63      www      5500:     $domain=&determinedomain($domain);
1.1016    raeburn  5501:     my %domdesign;
                   5502:     unless ($domain eq 'public') {
                   5503:         %domdesign = &get_domainconf($domain);
                   5504:     }
1.520     raeburn  5505:     my $output;
1.517     raeburn  5506:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   5507:         $output = $domdesign{$domain.'.'.$which};
1.63      www      5508:     } else {
1.520     raeburn  5509:         $output = $defaultdesign{$which};
                   5510:     }
                   5511:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  5512:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 5513:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   5514:             if ($output =~ m{^/res/}) {
                   5515:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   5516:                 &Apache::lonnet::repcopy($local_name);
                   5517:             }
1.520     raeburn  5518:             $output = &lonhttpdurl($output);
                   5519:         }
1.63      www      5520:     }
1.520     raeburn  5521:     return $output;
1.63      www      5522: }
1.59      www      5523: 
1.822     bisitz   5524: ##############################################
                   5525: =pod
                   5526: 
1.832     bisitz   5527: =item * &authorspace()
                   5528: 
1.1028    raeburn  5529: Inputs: $url (usually will be undef).
1.832     bisitz   5530: 
1.1075.2.40  raeburn  5531: Returns: Path to Authoring Space containing the resource or 
1.1028    raeburn  5532:          directory being viewed (or for which action is being taken). 
                   5533:          If $url is provided, and begins /priv/<domain>/<uname>
                   5534:          the path will be that portion of the $context argument.
                   5535:          Otherwise the path will be for the author space of the current
                   5536:          user when the current role is author, or for that of the 
                   5537:          co-author/assistant co-author space when the current role 
                   5538:          is co-author or assistant co-author.
1.832     bisitz   5539: 
                   5540: =cut
                   5541: 
                   5542: sub authorspace {
1.1028    raeburn  5543:     my ($url) = @_;
                   5544:     if ($url ne '') {
                   5545:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   5546:            return $1;
                   5547:         }
                   5548:     }
1.832     bisitz   5549:     my $caname = '';
1.1024    www      5550:     my $cadom = '';
1.1028    raeburn  5551:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      5552:         ($cadom,$caname) =
1.832     bisitz   5553:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  5554:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   5555:         $caname = $env{'user.name'};
1.1024    www      5556:         $cadom = $env{'user.domain'};
1.832     bisitz   5557:     }
1.1028    raeburn  5558:     if (($caname ne '') && ($cadom ne '')) {
                   5559:         return "/priv/$cadom/$caname/";
                   5560:     }
                   5561:     return;
1.832     bisitz   5562: }
                   5563: 
                   5564: ##############################################
                   5565: =pod
                   5566: 
1.822     bisitz   5567: =item * &head_subbox()
                   5568: 
                   5569: Inputs: $content (contains HTML code with page functions, etc.)
                   5570: 
                   5571: Returns: HTML div with $content
                   5572:          To be included in page header
                   5573: 
                   5574: =cut
                   5575: 
                   5576: sub head_subbox {
                   5577:     my ($content)=@_;
                   5578:     my $output =
1.993     raeburn  5579:         '<div class="LC_head_subbox">'
1.822     bisitz   5580:        .$content
                   5581:        .'</div>'
                   5582: }
                   5583: 
                   5584: ##############################################
                   5585: =pod
                   5586: 
                   5587: =item * &CSTR_pageheader()
                   5588: 
1.1026    raeburn  5589: Input: (optional) filename from which breadcrumb trail is built.
                   5590:        In most cases no input as needed, as $env{'request.filename'}
                   5591:        is appropriate for use in building the breadcrumb trail.
1.822     bisitz   5592: 
                   5593: Returns: HTML div with CSTR path and recent box
1.1075.2.40  raeburn  5594:          To be included on Authoring Space pages
1.822     bisitz   5595: 
                   5596: =cut
                   5597: 
                   5598: sub CSTR_pageheader {
1.1026    raeburn  5599:     my ($trailfile) = @_;
                   5600:     if ($trailfile eq '') {
                   5601:         $trailfile = $env{'request.filename'};
                   5602:     }
                   5603: 
                   5604: # this is for resources; directories have customtitle, and crumbs
                   5605: # and select recent are created in lonpubdir.pm
                   5606: 
                   5607:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      5608:     my ($udom,$uname,$thisdisfn)=
1.1075.2.29  raeburn  5609:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026    raeburn  5610:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   5611:     $formaction =~ s{/+}{/}g;
1.822     bisitz   5612: 
                   5613:     my $parentpath = '';
                   5614:     my $lastitem = '';
                   5615:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   5616:         $parentpath = $1;
                   5617:         $lastitem = $2;
                   5618:     } else {
                   5619:         $lastitem = $thisdisfn;
                   5620:     }
1.921     bisitz   5621: 
                   5622:     my $output =
1.822     bisitz   5623:          '<div>'
                   5624:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1075.2.40  raeburn  5625:         .'<b>'.&mt('Authoring Space:').'</b> '
1.822     bisitz   5626:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   5627:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024    www      5628:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921     bisitz   5629: 
                   5630:     if ($lastitem) {
                   5631:         $output .=
                   5632:              '<span class="LC_filename">'
                   5633:             .$lastitem
                   5634:             .'</span>';
                   5635:     }
                   5636:     $output .=
                   5637:          '<br />'
1.822     bisitz   5638:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   5639:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   5640:         .'</form>'
                   5641:         .&Apache::lonmenu::constspaceform()
                   5642:         .'</div>';
1.921     bisitz   5643: 
                   5644:     return $output;
1.822     bisitz   5645: }
                   5646: 
1.60      matthew  5647: ###############################################
                   5648: ###############################################
                   5649: 
                   5650: =pod
                   5651: 
1.112     bowersj2 5652: =back
                   5653: 
1.549     albertel 5654: =head1 HTML Helpers
1.112     bowersj2 5655: 
                   5656: =over 4
                   5657: 
                   5658: =item * &bodytag()
1.60      matthew  5659: 
                   5660: Returns a uniform header for LON-CAPA web pages.
                   5661: 
                   5662: Inputs: 
                   5663: 
1.112     bowersj2 5664: =over 4
                   5665: 
                   5666: =item * $title, A title to be displayed on the page.
                   5667: 
                   5668: =item * $function, the current role (can be undef).
                   5669: 
                   5670: =item * $addentries, extra parameters for the <body> tag.
                   5671: 
                   5672: =item * $bodyonly, if defined, only return the <body> tag.
                   5673: 
                   5674: =item * $domain, if defined, force a given domain.
                   5675: 
                   5676: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      5677:             text interface only)
1.60      matthew  5678: 
1.814     bisitz   5679: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   5680:                      navigational links
1.317     albertel 5681: 
1.338     albertel 5682: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   5683: 
1.1075.2.12  raeburn  5684: =item * $no_inline_link, if true and in remote mode, don't show the
                   5685:          'Switch To Inline Menu' link
                   5686: 
1.460     albertel 5687: =item * $args, optional argument valid values are
                   5688:             no_auto_mt_title -> prevents &mt()ing the title arg
1.1075.2.133  raeburn  5689:             use_absolute     -> for external resource or syllabus, this will
                   5690:                                 contain https://<hostname> if server uses
                   5691:                                 https (as per hosts.tab), but request is for http
                   5692:             hostname         -> hostname, from $r->hostname().
1.460     albertel 5693: 
1.1075.2.15  raeburn  5694: =item * $advtoolsref, optional argument, ref to an array containing
                   5695:             inlineremote items to be added in "Functions" menu below
                   5696:             breadcrumbs.
                   5697: 
1.1075.2.161.  .1(raebu 5698:21): =item * $ltiscope, optional argument, will be one of: resource, map or
                   5699:21):             course, if LON-CAPA is in LTI Provider context. Value is
                   5700:21):             the scope of use, i.e., launch was for access to a single, a map
                   5701:21):             or the entire course.
                   5702:21): 
                   5703:21): =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
                   5704:21):             context, this will contain the URL for the landing item in
                   5705:21):             the course, after launch from an LTI Consumer
                   5706:21): 
                   5707:21): =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
                   5708:21):             context, this will contain a reference to hash of items
                   5709:21):             to be included in the page header and/or inline menu.
                   5710:21): 
1.112     bowersj2 5711: =back
                   5712: 
1.60      matthew  5713: Returns: A uniform header for LON-CAPA web pages.  
                   5714: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   5715: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   5716: other decorations will be returned.
                   5717: 
                   5718: =cut
                   5719: 
1.54      www      5720: sub bodytag {
1.831     bisitz   5721:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1075.2.161.  .1(raebu 5722:21):         $no_nav_bar,$bgcolor,$no_inline_link,$args,$advtoolsref,
                   5723:21):         $ltiscope,$ltiuri,$ltimenu,$menucoll,$menuref)=@_;
1.339     albertel 5724: 
1.954     raeburn  5725:     my $public;
                   5726:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   5727:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   5728:         $public = 1;
                   5729:     }
1.460     albertel 5730:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1075.2.52  raeburn  5731:     my $httphost = $args->{'use_absolute'};
1.1075.2.133  raeburn  5732:     my $hostname = $args->{'hostname'};
1.339     albertel 5733: 
1.183     matthew  5734:     $function = &get_users_function() if (!$function);
1.339     albertel 5735:     my $img =    &designparm($function.'.img',$domain);
                   5736:     my $font =   &designparm($function.'.font',$domain);
                   5737:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   5738: 
1.803     bisitz   5739:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 5740: 		   'bgcolor' => $pgbg,
1.339     albertel 5741: 		   'text'    => $font,
                   5742:                    'alink'   => &designparm($function.'.alink',$domain),
                   5743: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   5744: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 5745:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 5746: 
1.63      www      5747:  # role and realm
1.1075.2.68  raeburn  5748:     my ($role,$realm) = split(m{\./},$env{'request.role'},2);
                   5749:     if ($realm) {
                   5750:         $realm = '/'.$realm;
                   5751:     }
1.1075.2.159  raeburn  5752:     if ($role eq 'ca') {
1.479     albertel 5753:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 5754:         $realm = &plainname($rname,$rdom);
1.378     raeburn  5755:     } 
1.55      www      5756: # realm
1.1075.2.158  raeburn  5757:     my ($cid,$sec);
1.258     albertel 5758:     if ($env{'request.course.id'}) {
1.1075.2.158  raeburn  5759:         $cid = $env{'request.course.id'};
                   5760:         if ($env{'request.course.sec'}) {
                   5761:             $sec = $env{'request.course.sec'};
                   5762:         }
                   5763:     } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
                   5764:         if (&Apache::lonnet::is_course($1,$2)) {
                   5765:             $cid = $1.'_'.$2;
                   5766:             $sec = $3;
                   5767:         }
                   5768:     }
                   5769:     if ($cid) {
1.378     raeburn  5770:         if ($env{'request.role'} !~ /^cr/) {
                   5771:             $role = &Apache::lonnet::plaintext($role,&course_type());
1.1075.2.115  raeburn  5772:         } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1075.2.121  raeburn  5773:             if ($env{'request.role.desc'}) {
                   5774:                 $role = $env{'request.role.desc'};
                   5775:             } else {
                   5776:                 $role = &mt('Helpdesk[_1]','&nbsp;'.$2);
                   5777:             }
1.1075.2.115  raeburn  5778:         } else {
                   5779:             $role = (split(/\//,$role,4))[-1];
1.378     raeburn  5780:         }
1.1075.2.158  raeburn  5781:         if ($sec) {
                   5782:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$sec;
1.898     raeburn  5783:         }   
1.1075.2.158  raeburn  5784: 	$realm = $env{'course.'.$cid.'.description'};
1.378     raeburn  5785:     } else {
                   5786:         $role = &Apache::lonnet::plaintext($role);
1.54      www      5787:     }
1.433     albertel 5788: 
1.359     albertel 5789:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 5790: 
1.438     albertel 5791:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 5792: 
1.101     www      5793: # construct main body tag
1.359     albertel 5794:     my $bodytag = "<body $extra_body_attr>".
1.1075.2.100  raeburn  5795: 	&Apache::lontexconvert::init_math_support();
1.252     albertel 5796: 
1.1075.2.38  raeburn  5797:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   5798: 
                   5799:     if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60      matthew  5800:         return $bodytag;
1.1075.2.38  raeburn  5801:     }
1.359     albertel 5802: 
1.954     raeburn  5803:     if ($public) {
1.433     albertel 5804: 	undef($role);
                   5805:     }
1.1075.2.158  raeburn  5806: 
1.1075.2.161.  .1(raebu 5807:21):     my $showcrstitle = 1;
                   5808:21):     if (($cid) && ($env{'request.lti.login'})) {
                   5809:21):         if (ref($ltimenu) eq 'HASH') {
                   5810:21):             unless ($ltimenu->{'role'}) {
                   5811:21):                 undef($role);
                   5812:21):             }
                   5813:21):             unless ($ltimenu->{'coursetitle'}) {
                   5814:21):                 $realm='&nbsp;';
                   5815:21):                 $showcrstitle = 0;
                   5816:21):             }
                   5817:21):         }
                   5818:21):     } elsif (($cid) && ($menucoll)) {
                   5819:21):         if (ref($menuref) eq 'HASH') {
                   5820:21):             unless ($menuref->{'role'}) {
                   5821:21):                 undef($role);
                   5822:21):             }
                   5823:21):             unless ($menuref->{'crs'}) {
                   5824:21):                 $realm='&nbsp;';
                   5825:21):                 $showcrstitle = 0;
                   5826:21):             }
                   5827:21):         }
                   5828:21):     }
                   5829:21): 
1.762     bisitz   5830:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 5831:     #
                   5832:     # Extra info if you are the DC
                   5833:     my $dc_info = '';
1.1075.2.161.  .1(raebu 5834:21):     if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1075.2.158  raeburn  5835:         (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917     raeburn  5836:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      5837:         $dc_info =~ s/\s+$//;
1.359     albertel 5838:     }
                   5839: 
1.1075.2.161.  .1(raebu 5840:21):     my $crstype;
                   5841:21):     if ($cid) {
                   5842:21):         $crstype = $env{'course.'.$cid.'.type'};
                   5843:21):     } elsif ($args->{'crstype'}) {
                   5844:21):         $crstype = $args->{'crstype'};
                   5845:21):     }
                   5846:21): 
1.1075.2.108  raeburn  5847:     $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.903     droeschl 5848: 
1.1075.2.13  raeburn  5849:     if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   5850: 
1.1075.2.38  raeburn  5851: 
                   5852: 
1.1075.2.21  raeburn  5853:     my $funclist;
                   5854:     if (($env{'environment.remote'} eq 'on') && ($env{'request.state'} ne 'construct')) {
1.1075.2.52  raeburn  5855:         $bodytag .= Apache::lonhtmlcommon::scripttag(Apache::lonmenu::utilityfunctions($httphost), 'start')."\n".
1.1075.2.21  raeburn  5856:                     Apache::lonmenu::serverform();
                   5857:         my $forbodytag;
                   5858:         &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5859:                                             $forcereg,$args->{'group'},
                   5860:                                             $args->{'bread_crumbs'},
1.1075.2.133  raeburn  5861:                                             $advtoolsref,'','',\$forbodytag);
1.1075.2.21  raeburn  5862:         unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5863:             $funclist = $forbodytag;
                   5864:         }
                   5865:     } else {
1.903     droeschl 5866: 
                   5867:         #    if ($env{'request.state'} eq 'construct') {
                   5868:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   5869:         #    }
                   5870: 
1.1075.2.38  raeburn  5871:         $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  5872:             Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359     albertel 5873: 
1.1075.2.161.  .1(raebu 5874:21):         unless ($args->{'no_primary_menu'}) {
                   5875:21):             my ($left,$right) = Apache::lonmenu::primary_menu($args->{'links_disabled'});
1.1075.2.2  raeburn  5876: 
1.1075.2.161.  .1(raebu 5877:21):             if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
                   5878:21):                 if ($dc_info) {
                   5879:21):                     $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   5880:21):                 }
                   5881:21):                 $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
                   5882:21):                                <em>$realm</em> $dc_info</div>|;
                   5883:21):                 return $bodytag;
1.1075.2.1  raeburn  5884:             }
1.894     droeschl 5885: 
1.1075.2.161.  .1(raebu 5886:21):             unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
                   5887:21):                 $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
                   5888:21):             }
1.916     droeschl 5889: 
1.1075.2.161.  .1(raebu 5890:21):             $bodytag .= $right;
1.852     droeschl 5891: 
1.1075.2.161.  .1(raebu 5892:21):             if ($dc_info) {
                   5893:21):                 $dc_info = &dc_courseid_toggle($dc_info);
                   5894:21):             }
                   5895:21):             $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917     raeburn  5896:         }
1.916     droeschl 5897: 
1.1075.2.61  raeburn  5898:         #if directed to not display the secondary menu, don't.
                   5899:         if ($args->{'no_secondary_menu'}) {
                   5900:             return $bodytag;
                   5901:         }
1.903     droeschl 5902:         #don't show menus for public users
1.954     raeburn  5903:         if (!$public){
1.1075.2.161.  .1(raebu 5904:21):             unless ($args->{'no_inline_menu'}) {
                   5905:21):                 $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
                   5906:21):                                                             $args->{'no_primary_menu'},
                   5907:21):                                                             $menucoll,$menuref,
                   5908:21):                                                             $args->{'links_disabled'});
                   5909:21):             }
1.903     droeschl 5910:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  5911:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   5912:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 5913:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1075.2.161.  .1(raebu 5914:21):                                 $args->{'bread_crumbs'},'','',$hostname,$ltiscope,$ltiuri);
1.1075.2.116  raeburn  5915:             } elsif ($forcereg) {
1.1075.2.22  raeburn  5916:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1075.2.116  raeburn  5917:                                                             $args->{'group'},
1.1075.2.161  raeburn  5918:                                                             $args->{'hide_buttons'},
1.1075.2.161.  .1(raebu 5919:21):                                                             $hostname,$ltiscope,$ltiuri);
1.1075.2.15  raeburn  5920:             } else {
1.1075.2.21  raeburn  5921:                 my $forbodytag;
                   5922:                 &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5923:                                                     $forcereg,$args->{'group'},
                   5924:                                                     $args->{'bread_crumbs'},
1.1075.2.133  raeburn  5925:                                                     $advtoolsref,'',$hostname,
                   5926:                                                     \$forbodytag);
1.1075.2.21  raeburn  5927:                 unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5928:                     $bodytag .= $forbodytag;
                   5929:                 }
1.920     raeburn  5930:             }
1.903     droeschl 5931:         }else{
                   5932:             # this is to seperate menu from content when there's no secondary
                   5933:             # menu. Especially needed for public accessible ressources.
                   5934:             $bodytag .= '<hr style="clear:both" />';
                   5935:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  5936:         }
1.903     droeschl 5937: 
1.235     raeburn  5938:         return $bodytag;
1.1075.2.12  raeburn  5939:     }
                   5940: 
                   5941: #
                   5942: # Top frame rendering, Remote is up
                   5943: #
                   5944: 
                   5945:     my $imgsrc = $img;
                   5946:     if ($img =~ /^\/adm/) {
                   5947:         $imgsrc = &lonhttpdurl($img);
                   5948:     }
                   5949:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
                   5950: 
1.1075.2.60  raeburn  5951:     my $help=($no_inline_link?''
                   5952:               :&Apache::loncommon::top_nav_help('Help'));
                   5953: 
1.1075.2.12  raeburn  5954:     # Explicit link to get inline menu
                   5955:     my $menu= ($no_inline_link?''
                   5956:                :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
                   5957: 
                   5958:     if ($dc_info) {
                   5959:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   5960:     }
                   5961: 
1.1075.2.38  raeburn  5962:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
                   5963:     unless ($public) {
                   5964:         $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
                   5965:                                 undef,'LC_menubuttons_link');
                   5966:     }
                   5967: 
1.1075.2.12  raeburn  5968:     unless ($env{'form.inhibitmenu'}) {
                   5969:         $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.1075.2.38  raeburn  5970:                        <ol class="LC_primary_menu LC_floatright LC_right">
1.1075.2.60  raeburn  5971:                        <li>$help</li>
1.1075.2.12  raeburn  5972:                        <li>$menu</li>
                   5973:                        </ol><div id="LC_realm"> $realm $dc_info</div>|;
                   5974:     }
1.1075.2.13  raeburn  5975:     if ($env{'request.state'} eq 'construct') {
                   5976:         if (!$public){
                   5977:             if ($env{'request.state'} eq 'construct') {
                   5978:                 $funclist = &Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  5979:                                 &Apache::lonmenu::utilityfunctions($httphost), 'start').
1.1075.2.13  raeburn  5980:                             &Apache::lonhtmlcommon::scripttag('','end').
                   5981:                             &Apache::lonmenu::innerregister($forcereg,
                   5982:                                                             $args->{'bread_crumbs'});
                   5983:             }
                   5984:         }
                   5985:     }
1.1075.2.21  raeburn  5986:     return $bodytag."\n".$funclist;
1.182     matthew  5987: }
                   5988: 
1.917     raeburn  5989: sub dc_courseid_toggle {
                   5990:     my ($dc_info) = @_;
1.980     raeburn  5991:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  5992:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  5993:            &mt('(More ...)').'</a></span>'.
                   5994:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5995: }
                   5996: 
1.330     albertel 5997: sub make_attr_string {
                   5998:     my ($register,$attr_ref) = @_;
                   5999: 
                   6000:     if ($attr_ref && !ref($attr_ref)) {
                   6001: 	die("addentries Must be a hash ref ".
                   6002: 	    join(':',caller(1))." ".
                   6003: 	    join(':',caller(0))." ");
                   6004:     }
                   6005: 
                   6006:     if ($register) {
1.339     albertel 6007: 	my ($on_load,$on_unload);
                   6008: 	foreach my $key (keys(%{$attr_ref})) {
                   6009: 	    if      (lc($key) eq 'onload') {
                   6010: 		$on_load.=$attr_ref->{$key}.';';
                   6011: 		delete($attr_ref->{$key});
                   6012: 
                   6013: 	    } elsif (lc($key) eq 'onunload') {
                   6014: 		$on_unload.=$attr_ref->{$key}.';';
                   6015: 		delete($attr_ref->{$key});
                   6016: 	    }
                   6017: 	}
1.1075.2.12  raeburn  6018:         if ($env{'environment.remote'} eq 'on') {
                   6019:             $attr_ref->{'onload'}  =
                   6020:                 &Apache::lonmenu::loadevents().  $on_load;
                   6021:             $attr_ref->{'onunload'}=
                   6022:                 &Apache::lonmenu::unloadevents().$on_unload;
                   6023:         } else {  
                   6024: 	    $attr_ref->{'onload'}  = $on_load;
                   6025: 	    $attr_ref->{'onunload'}= $on_unload;
                   6026:         }
1.330     albertel 6027:     }
1.339     albertel 6028: 
1.330     albertel 6029:     my $attr_string;
1.1075.2.56  raeburn  6030:     foreach my $attr (sort(keys(%$attr_ref))) {
1.330     albertel 6031: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   6032:     }
                   6033:     return $attr_string;
                   6034: }
                   6035: 
                   6036: 
1.182     matthew  6037: ###############################################
1.251     albertel 6038: ###############################################
                   6039: 
                   6040: =pod
                   6041: 
                   6042: =item * &endbodytag()
                   6043: 
                   6044: Returns a uniform footer for LON-CAPA web pages.
                   6045: 
1.635     raeburn  6046: Inputs: 1 - optional reference to an args hash
                   6047: If in the hash, key for noredirectlink has a value which evaluates to true,
                   6048: a 'Continue' link is not displayed if the page contains an
                   6049: internal redirect in the <head></head> section,
                   6050: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 6051: 
                   6052: =cut
                   6053: 
                   6054: sub endbodytag {
1.635     raeburn  6055:     my ($args) = @_;
1.1075.2.6  raeburn  6056:     my $endbodytag;
                   6057:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   6058:         $endbodytag='</body>';
                   6059:     }
1.315     albertel 6060:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  6061:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   6062: 	    $endbodytag=
                   6063: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   6064: 	        &mt('Continue').'</a>'.
                   6065: 	        $endbodytag;
                   6066:         }
1.315     albertel 6067:     }
1.251     albertel 6068:     return $endbodytag;
                   6069: }
                   6070: 
1.352     albertel 6071: =pod
                   6072: 
                   6073: =item * &standard_css()
                   6074: 
                   6075: Returns a style sheet
                   6076: 
                   6077: Inputs: (all optional)
                   6078:             domain         -> force to color decorate a page for a specific
                   6079:                                domain
                   6080:             function       -> force usage of a specific rolish color scheme
                   6081:             bgcolor        -> override the default page bgcolor
                   6082: 
                   6083: =cut
                   6084: 
1.343     albertel 6085: sub standard_css {
1.345     albertel 6086:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 6087:     $function  = &get_users_function() if (!$function);
                   6088:     my $img    = &designparm($function.'.img',   $domain);
                   6089:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   6090:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 6091:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 6092: #second colour for later usage
1.345     albertel 6093:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 6094:     my $pgbg_or_bgcolor =
                   6095: 	         $bgcolor ||
1.352     albertel 6096: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 6097:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 6098:     my $alink  = &designparm($function.'.alink', $domain);
                   6099:     my $vlink  = &designparm($function.'.vlink', $domain);
                   6100:     my $link   = &designparm($function.'.link',  $domain);
                   6101: 
1.602     albertel 6102:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 6103:     my $mono                 = 'monospace';
1.850     bisitz   6104:     my $data_table_head      = $sidebg;
                   6105:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   6106:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 6107:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 6108:     my $data_table_highlight = '#FFFF00';
1.352     albertel 6109:     my $mail_new             = '#FFBB77';
                   6110:     my $mail_new_hover       = '#DD9955';
                   6111:     my $mail_read            = '#BBBB77';
                   6112:     my $mail_read_hover      = '#999944';
                   6113:     my $mail_replied         = '#AAAA88';
                   6114:     my $mail_replied_hover   = '#888855';
                   6115:     my $mail_other           = '#99BBBB';
                   6116:     my $mail_other_hover     = '#669999';
1.391     albertel 6117:     my $table_header         = '#DDDDDD';
1.489     raeburn  6118:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   6119:     my $lg_border_color      = '#C8C8C8';
1.952     onken    6120:     my $button_hover         = '#BF2317';
1.392     albertel 6121: 
1.608     albertel 6122:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   6123:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   6124:                                              : '0 3px 0 4px';
1.448     albertel 6125: 
1.523     albertel 6126: 
1.343     albertel 6127:     return <<END;
1.947     droeschl 6128: 
                   6129: /* needed for iframe to allow 100% height in FF */
                   6130: body, html { 
                   6131:     margin: 0;
                   6132:     padding: 0 0.5%;
                   6133:     height: 99%; /* to avoid scrollbars */
                   6134: }
                   6135: 
1.795     www      6136: body {
1.911     bisitz   6137:   font-family: $sans;
                   6138:   line-height:130%;
                   6139:   font-size:0.83em;
                   6140:   color:$font;
1.795     www      6141: }
                   6142: 
1.959     onken    6143: a:focus,
                   6144: a:focus img {
1.795     www      6145:   color: red;
                   6146: }
1.698     harmsja  6147: 
1.911     bisitz   6148: form, .inline {
                   6149:   display: inline;
1.795     www      6150: }
1.721     harmsja  6151: 
1.795     www      6152: .LC_right {
1.911     bisitz   6153:   text-align:right;
1.795     www      6154: }
                   6155: 
                   6156: .LC_middle {
1.911     bisitz   6157:   vertical-align:middle;
1.795     www      6158: }
1.721     harmsja  6159: 
1.1075.2.38  raeburn  6160: .LC_floatleft {
                   6161:   float: left;
                   6162: }
                   6163: 
                   6164: .LC_floatright {
                   6165:   float: right;
                   6166: }
                   6167: 
1.911     bisitz   6168: .LC_400Box {
                   6169:   width:400px;
                   6170: }
1.721     harmsja  6171: 
1.947     droeschl 6172: .LC_iframecontainer {
                   6173:     width: 98%;
                   6174:     margin: 0;
                   6175:     position: fixed;
                   6176:     top: 8.5em;
                   6177:     bottom: 0;
                   6178: }
                   6179: 
                   6180: .LC_iframecontainer iframe{
                   6181:     border: none;
                   6182:     width: 100%;
                   6183:     height: 100%;
                   6184: }
                   6185: 
1.778     bisitz   6186: .LC_filename {
                   6187:   font-family: $mono;
                   6188:   white-space:pre;
1.921     bisitz   6189:   font-size: 120%;
1.778     bisitz   6190: }
                   6191: 
                   6192: .LC_fileicon {
                   6193:   border: none;
                   6194:   height: 1.3em;
                   6195:   vertical-align: text-bottom;
                   6196:   margin-right: 0.3em;
                   6197:   text-decoration:none;
                   6198: }
                   6199: 
1.1008    www      6200: .LC_setting {
                   6201:   text-decoration:underline;
                   6202: }
                   6203: 
1.350     albertel 6204: .LC_error {
                   6205:   color: red;
                   6206: }
1.795     www      6207: 
1.1075.2.15  raeburn  6208: .LC_warning {
                   6209:   color: darkorange;
                   6210: }
                   6211: 
1.457     albertel 6212: .LC_diff_removed {
1.733     bisitz   6213:   color: red;
1.394     albertel 6214: }
1.532     albertel 6215: 
                   6216: .LC_info,
1.457     albertel 6217: .LC_success,
                   6218: .LC_diff_added {
1.350     albertel 6219:   color: green;
                   6220: }
1.795     www      6221: 
1.802     bisitz   6222: div.LC_confirm_box {
                   6223:   background-color: #FAFAFA;
                   6224:   border: 1px solid $lg_border_color;
                   6225:   margin-right: 0;
                   6226:   padding: 5px;
                   6227: }
                   6228: 
                   6229: div.LC_confirm_box .LC_error img,
                   6230: div.LC_confirm_box .LC_success img {
                   6231:   vertical-align: middle;
                   6232: }
                   6233: 
1.1075.2.108  raeburn  6234: .LC_maxwidth {
                   6235:   max-width: 100%;
                   6236:   height: auto;
                   6237: }
                   6238: 
                   6239: .LC_textsize_mobile {
                   6240:   \@media only screen and (max-device-width: 480px) {
                   6241:       -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
                   6242:   }
                   6243: }
                   6244: 
1.440     albertel 6245: .LC_icon {
1.771     droeschl 6246:   border: none;
1.790     droeschl 6247:   vertical-align: middle;
1.771     droeschl 6248: }
                   6249: 
1.543     albertel 6250: .LC_docs_spacer {
                   6251:   width: 25px;
                   6252:   height: 1px;
1.771     droeschl 6253:   border: none;
1.543     albertel 6254: }
1.346     albertel 6255: 
1.532     albertel 6256: .LC_internal_info {
1.735     bisitz   6257:   color: #999999;
1.532     albertel 6258: }
                   6259: 
1.794     www      6260: .LC_discussion {
1.1050    www      6261:   background: $data_table_dark;
1.911     bisitz   6262:   border: 1px solid black;
                   6263:   margin: 2px;
1.794     www      6264: }
                   6265: 
                   6266: .LC_disc_action_left {
1.1050    www      6267:   background: $sidebg;
1.911     bisitz   6268:   text-align: left;
1.1050    www      6269:   padding: 4px;
                   6270:   margin: 2px;
1.794     www      6271: }
                   6272: 
                   6273: .LC_disc_action_right {
1.1050    www      6274:   background: $sidebg;
1.911     bisitz   6275:   text-align: right;
1.1050    www      6276:   padding: 4px;
                   6277:   margin: 2px;
1.794     www      6278: }
                   6279: 
                   6280: .LC_disc_new_item {
1.911     bisitz   6281:   background: white;
                   6282:   border: 2px solid red;
1.1050    www      6283:   margin: 4px;
                   6284:   padding: 4px;
1.794     www      6285: }
                   6286: 
                   6287: .LC_disc_old_item {
1.911     bisitz   6288:   background: white;
1.1050    www      6289:   margin: 4px;
                   6290:   padding: 4px;
1.794     www      6291: }
                   6292: 
1.458     albertel 6293: table.LC_pastsubmission {
                   6294:   border: 1px solid black;
                   6295:   margin: 2px;
                   6296: }
                   6297: 
1.924     bisitz   6298: table#LC_menubuttons {
1.345     albertel 6299:   width: 100%;
                   6300:   background: $pgbg;
1.392     albertel 6301:   border: 2px;
1.402     albertel 6302:   border-collapse: separate;
1.803     bisitz   6303:   padding: 0;
1.345     albertel 6304: }
1.392     albertel 6305: 
1.801     tempelho 6306: table#LC_title_bar a {
                   6307:   color: $fontmenu;
                   6308: }
1.836     bisitz   6309: 
1.807     droeschl 6310: table#LC_title_bar {
1.819     tempelho 6311:   clear: both;
1.836     bisitz   6312:   display: none;
1.807     droeschl 6313: }
                   6314: 
1.795     www      6315: table#LC_title_bar,
1.933     droeschl 6316: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 6317: table#LC_title_bar.LC_with_remote {
1.359     albertel 6318:   width: 100%;
1.392     albertel 6319:   border-color: $pgbg;
                   6320:   border-style: solid;
                   6321:   border-width: $border;
1.379     albertel 6322:   background: $pgbg;
1.801     tempelho 6323:   color: $fontmenu;
1.392     albertel 6324:   border-collapse: collapse;
1.803     bisitz   6325:   padding: 0;
1.819     tempelho 6326:   margin: 0;
1.359     albertel 6327: }
1.795     www      6328: 
1.933     droeschl 6329: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 6330:     margin: 0;
                   6331:     padding: 0;
1.933     droeschl 6332:     position: relative;
                   6333:     list-style: none;
1.913     droeschl 6334: }
1.933     droeschl 6335: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 6336:     display: inline;
                   6337: }
1.933     droeschl 6338: 
                   6339: .LC_breadcrumb_tools_navigation {
1.913     droeschl 6340:     padding: 0;
1.933     droeschl 6341:     margin: 0;
                   6342:     float: left;
1.913     droeschl 6343: }
1.933     droeschl 6344: .LC_breadcrumb_tools_tools {
                   6345:     padding: 0;
                   6346:     margin: 0;
1.913     droeschl 6347:     float: right;
                   6348: }
                   6349: 
1.359     albertel 6350: table#LC_title_bar td {
                   6351:   background: $tabbg;
                   6352: }
1.795     www      6353: 
1.911     bisitz   6354: table#LC_menubuttons img {
1.803     bisitz   6355:   border: none;
1.346     albertel 6356: }
1.795     www      6357: 
1.842     droeschl 6358: .LC_breadcrumbs_component {
1.911     bisitz   6359:   float: right;
                   6360:   margin: 0 1em;
1.357     albertel 6361: }
1.842     droeschl 6362: .LC_breadcrumbs_component img {
1.911     bisitz   6363:   vertical-align: middle;
1.777     tempelho 6364: }
1.795     www      6365: 
1.1075.2.108  raeburn  6366: .LC_breadcrumbs_hoverable {
                   6367:   background: $sidebg;
                   6368: }
                   6369: 
1.383     albertel 6370: td.LC_table_cell_checkbox {
                   6371:   text-align: center;
                   6372: }
1.795     www      6373: 
                   6374: .LC_fontsize_small {
1.911     bisitz   6375:   font-size: 70%;
1.705     tempelho 6376: }
                   6377: 
1.844     bisitz   6378: #LC_breadcrumbs {
1.911     bisitz   6379:   clear:both;
                   6380:   background: $sidebg;
                   6381:   border-bottom: 1px solid $lg_border_color;
                   6382:   line-height: 2.5em;
1.933     droeschl 6383:   overflow: hidden;
1.911     bisitz   6384:   margin: 0;
                   6385:   padding: 0;
1.995     raeburn  6386:   text-align: left;
1.819     tempelho 6387: }
1.862     bisitz   6388: 
1.1075.2.16  raeburn  6389: .LC_head_subbox, .LC_actionbox {
1.911     bisitz   6390:   clear:both;
                   6391:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 6392:   border: 1px solid $sidebg;
1.1075.2.16  raeburn  6393:   margin: 0 0 10px 0;
1.966     bisitz   6394:   padding: 3px;
1.995     raeburn  6395:   text-align: left;
1.822     bisitz   6396: }
                   6397: 
1.795     www      6398: .LC_fontsize_medium {
1.911     bisitz   6399:   font-size: 85%;
1.705     tempelho 6400: }
                   6401: 
1.795     www      6402: .LC_fontsize_large {
1.911     bisitz   6403:   font-size: 120%;
1.705     tempelho 6404: }
                   6405: 
1.346     albertel 6406: .LC_menubuttons_inline_text {
                   6407:   color: $font;
1.698     harmsja  6408:   font-size: 90%;
1.701     harmsja  6409:   padding-left:3px;
1.346     albertel 6410: }
                   6411: 
1.934     droeschl 6412: .LC_menubuttons_inline_text img{
                   6413:   vertical-align: middle;
                   6414: }
                   6415: 
1.1051    www      6416: li.LC_menubuttons_inline_text img {
1.951     onken    6417:   cursor:pointer;
1.1002    droeschl 6418:   text-decoration: none;
1.951     onken    6419: }
                   6420: 
1.526     www      6421: .LC_menubuttons_link {
                   6422:   text-decoration: none;
                   6423: }
1.795     www      6424: 
1.522     albertel 6425: .LC_menubuttons_category {
1.521     www      6426:   color: $font;
1.526     www      6427:   background: $pgbg;
1.521     www      6428:   font-size: larger;
                   6429:   font-weight: bold;
                   6430: }
                   6431: 
1.346     albertel 6432: td.LC_menubuttons_text {
1.911     bisitz   6433:   color: $font;
1.346     albertel 6434: }
1.706     harmsja  6435: 
1.346     albertel 6436: .LC_current_location {
                   6437:   background: $tabbg;
                   6438: }
1.795     www      6439: 
1.1075.2.134  raeburn  6440: td.LC_zero_height {
                   6441:   line-height: 0;
                   6442:   cellpadding: 0;
                   6443: }
                   6444: 
1.938     bisitz   6445: table.LC_data_table {
1.347     albertel 6446:   border: 1px solid #000000;
1.402     albertel 6447:   border-collapse: separate;
1.426     albertel 6448:   border-spacing: 1px;
1.610     albertel 6449:   background: $pgbg;
1.347     albertel 6450: }
1.795     www      6451: 
1.422     albertel 6452: .LC_data_table_dense {
                   6453:   font-size: small;
                   6454: }
1.795     www      6455: 
1.507     raeburn  6456: table.LC_nested_outer {
                   6457:   border: 1px solid #000000;
1.589     raeburn  6458:   border-collapse: collapse;
1.803     bisitz   6459:   border-spacing: 0;
1.507     raeburn  6460:   width: 100%;
                   6461: }
1.795     www      6462: 
1.879     raeburn  6463: table.LC_innerpickbox,
1.507     raeburn  6464: table.LC_nested {
1.803     bisitz   6465:   border: none;
1.589     raeburn  6466:   border-collapse: collapse;
1.803     bisitz   6467:   border-spacing: 0;
1.507     raeburn  6468:   width: 100%;
                   6469: }
1.795     www      6470: 
1.911     bisitz   6471: table.LC_data_table tr th,
                   6472: table.LC_calendar tr th,
1.879     raeburn  6473: table.LC_prior_tries tr th,
                   6474: table.LC_innerpickbox tr th {
1.349     albertel 6475:   font-weight: bold;
                   6476:   background-color: $data_table_head;
1.801     tempelho 6477:   color:$fontmenu;
1.701     harmsja  6478:   font-size:90%;
1.347     albertel 6479: }
1.795     www      6480: 
1.879     raeburn  6481: table.LC_innerpickbox tr th,
                   6482: table.LC_innerpickbox tr td {
                   6483:   vertical-align: top;
                   6484: }
                   6485: 
1.711     raeburn  6486: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   6487:   background-color: #CCCCCC;
1.711     raeburn  6488:   font-weight: bold;
                   6489:   text-align: left;
                   6490: }
1.795     www      6491: 
1.912     bisitz   6492: table.LC_data_table tr.LC_odd_row > td {
                   6493:   background-color: $data_table_light;
                   6494:   padding: 2px;
                   6495:   vertical-align: top;
                   6496: }
                   6497: 
1.809     bisitz   6498: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 6499:   background-color: $data_table_light;
1.912     bisitz   6500:   vertical-align: top;
                   6501: }
                   6502: 
                   6503: table.LC_data_table tr.LC_even_row > td {
                   6504:   background-color: $data_table_dark;
1.425     albertel 6505:   padding: 2px;
1.900     bisitz   6506:   vertical-align: top;
1.347     albertel 6507: }
1.795     www      6508: 
1.809     bisitz   6509: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 6510:   background-color: $data_table_dark;
1.900     bisitz   6511:   vertical-align: top;
1.347     albertel 6512: }
1.795     www      6513: 
1.425     albertel 6514: table.LC_data_table tr.LC_data_table_highlight td {
                   6515:   background-color: $data_table_darker;
                   6516: }
1.795     www      6517: 
1.639     raeburn  6518: table.LC_data_table tr td.LC_leftcol_header {
                   6519:   background-color: $data_table_head;
                   6520:   font-weight: bold;
                   6521: }
1.795     www      6522: 
1.451     albertel 6523: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  6524: table.LC_nested tr.LC_empty_row td {
1.421     albertel 6525:   font-weight: bold;
                   6526:   font-style: italic;
                   6527:   text-align: center;
                   6528:   padding: 8px;
1.347     albertel 6529: }
1.795     www      6530: 
1.1075.2.30  raeburn  6531: table.LC_data_table tr.LC_empty_row td,
                   6532: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   6533:   background-color: $sidebg;
                   6534: }
                   6535: 
                   6536: table.LC_nested tr.LC_empty_row td {
                   6537:   background-color: #FFFFFF;
                   6538: }
                   6539: 
1.890     droeschl 6540: table.LC_caption {
                   6541: }
                   6542: 
1.507     raeburn  6543: table.LC_nested tr.LC_empty_row td {
1.465     albertel 6544:   padding: 4ex
                   6545: }
1.795     www      6546: 
1.507     raeburn  6547: table.LC_nested_outer tr th {
                   6548:   font-weight: bold;
1.801     tempelho 6549:   color:$fontmenu;
1.507     raeburn  6550:   background-color: $data_table_head;
1.701     harmsja  6551:   font-size: small;
1.507     raeburn  6552:   border-bottom: 1px solid #000000;
                   6553: }
1.795     www      6554: 
1.507     raeburn  6555: table.LC_nested_outer tr td.LC_subheader {
                   6556:   background-color: $data_table_head;
                   6557:   font-weight: bold;
                   6558:   font-size: small;
                   6559:   border-bottom: 1px solid #000000;
                   6560:   text-align: right;
1.451     albertel 6561: }
1.795     www      6562: 
1.507     raeburn  6563: table.LC_nested tr.LC_info_row td {
1.735     bisitz   6564:   background-color: #CCCCCC;
1.451     albertel 6565:   font-weight: bold;
                   6566:   font-size: small;
1.507     raeburn  6567:   text-align: center;
                   6568: }
1.795     www      6569: 
1.589     raeburn  6570: table.LC_nested tr.LC_info_row td.LC_left_item,
                   6571: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  6572:   text-align: left;
1.451     albertel 6573: }
1.795     www      6574: 
1.507     raeburn  6575: table.LC_nested td {
1.735     bisitz   6576:   background-color: #FFFFFF;
1.451     albertel 6577:   font-size: small;
1.507     raeburn  6578: }
1.795     www      6579: 
1.507     raeburn  6580: table.LC_nested_outer tr th.LC_right_item,
                   6581: table.LC_nested tr.LC_info_row td.LC_right_item,
                   6582: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   6583: table.LC_nested tr td.LC_right_item {
1.451     albertel 6584:   text-align: right;
                   6585: }
                   6586: 
1.507     raeburn  6587: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   6588:   background-color: #EEEEEE;
1.451     albertel 6589: }
                   6590: 
1.473     raeburn  6591: table.LC_createuser {
                   6592: }
                   6593: 
                   6594: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  6595:   font-size: small;
1.473     raeburn  6596: }
                   6597: 
                   6598: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   6599:   background-color: #CCCCCC;
1.473     raeburn  6600:   font-weight: bold;
                   6601:   text-align: center;
                   6602: }
                   6603: 
1.349     albertel 6604: table.LC_calendar {
                   6605:   border: 1px solid #000000;
                   6606:   border-collapse: collapse;
1.917     raeburn  6607:   width: 98%;
1.349     albertel 6608: }
1.795     www      6609: 
1.349     albertel 6610: table.LC_calendar_pickdate {
                   6611:   font-size: xx-small;
                   6612: }
1.795     www      6613: 
1.349     albertel 6614: table.LC_calendar tr td {
                   6615:   border: 1px solid #000000;
                   6616:   vertical-align: top;
1.917     raeburn  6617:   width: 14%;
1.349     albertel 6618: }
1.795     www      6619: 
1.349     albertel 6620: table.LC_calendar tr td.LC_calendar_day_empty {
                   6621:   background-color: $data_table_dark;
                   6622: }
1.795     www      6623: 
1.779     bisitz   6624: table.LC_calendar tr td.LC_calendar_day_current {
                   6625:   background-color: $data_table_highlight;
1.777     tempelho 6626: }
1.795     www      6627: 
1.938     bisitz   6628: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 6629:   background-color: $mail_new;
                   6630: }
1.795     www      6631: 
1.938     bisitz   6632: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 6633:   background-color: $mail_new_hover;
                   6634: }
1.795     www      6635: 
1.938     bisitz   6636: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 6637:   background-color: $mail_read;
                   6638: }
1.795     www      6639: 
1.938     bisitz   6640: /*
                   6641: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 6642:   background-color: $mail_read_hover;
                   6643: }
1.938     bisitz   6644: */
1.795     www      6645: 
1.938     bisitz   6646: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 6647:   background-color: $mail_replied;
                   6648: }
1.795     www      6649: 
1.938     bisitz   6650: /*
                   6651: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 6652:   background-color: $mail_replied_hover;
                   6653: }
1.938     bisitz   6654: */
1.795     www      6655: 
1.938     bisitz   6656: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 6657:   background-color: $mail_other;
                   6658: }
1.795     www      6659: 
1.938     bisitz   6660: /*
                   6661: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 6662:   background-color: $mail_other_hover;
                   6663: }
1.938     bisitz   6664: */
1.494     raeburn  6665: 
1.777     tempelho 6666: table.LC_data_table tr > td.LC_browser_file,
                   6667: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   6668:   background: #AAEE77;
1.389     albertel 6669: }
1.795     www      6670: 
1.777     tempelho 6671: table.LC_data_table tr > td.LC_browser_file_locked,
                   6672: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 6673:   background: #FFAA99;
1.387     albertel 6674: }
1.795     www      6675: 
1.777     tempelho 6676: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   6677:   background: #888888;
1.779     bisitz   6678: }
1.795     www      6679: 
1.777     tempelho 6680: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   6681: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   6682:   background: #F8F866;
1.777     tempelho 6683: }
1.795     www      6684: 
1.696     bisitz   6685: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   6686:   background: #E0E8FF;
1.387     albertel 6687: }
1.696     bisitz   6688: 
1.707     bisitz   6689: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   6690:   /* background: #77FF77; */
1.707     bisitz   6691: }
1.795     www      6692: 
1.707     bisitz   6693: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   6694:   border-right: 8px solid #FFFF77;
1.707     bisitz   6695: }
1.795     www      6696: 
1.707     bisitz   6697: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   6698:   border-right: 8px solid #FFAA77;
1.707     bisitz   6699: }
1.795     www      6700: 
1.707     bisitz   6701: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   6702:   border-right: 8px solid #FF7777;
1.707     bisitz   6703: }
1.795     www      6704: 
1.707     bisitz   6705: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   6706:   border-right: 8px solid #AAFF77;
1.707     bisitz   6707: }
1.795     www      6708: 
1.707     bisitz   6709: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   6710:   border-right: 8px solid #11CC55;
1.707     bisitz   6711: }
                   6712: 
1.388     albertel 6713: span.LC_current_location {
1.701     harmsja  6714:   font-size:larger;
1.388     albertel 6715:   background: $pgbg;
                   6716: }
1.387     albertel 6717: 
1.1029    www      6718: span.LC_current_nav_location {
                   6719:   font-weight:bold;
                   6720:   background: $sidebg;
                   6721: }
                   6722: 
1.395     albertel 6723: span.LC_parm_menu_item {
                   6724:   font-size: larger;
                   6725: }
1.795     www      6726: 
1.395     albertel 6727: span.LC_parm_scope_all {
                   6728:   color: red;
                   6729: }
1.795     www      6730: 
1.395     albertel 6731: span.LC_parm_scope_folder {
                   6732:   color: green;
                   6733: }
1.795     www      6734: 
1.395     albertel 6735: span.LC_parm_scope_resource {
                   6736:   color: orange;
                   6737: }
1.795     www      6738: 
1.395     albertel 6739: span.LC_parm_part {
                   6740:   color: blue;
                   6741: }
1.795     www      6742: 
1.911     bisitz   6743: span.LC_parm_folder,
                   6744: span.LC_parm_symb {
1.395     albertel 6745:   font-size: x-small;
                   6746:   font-family: $mono;
                   6747:   color: #AAAAAA;
                   6748: }
                   6749: 
1.977     bisitz   6750: ul.LC_parm_parmlist li {
                   6751:   display: inline-block;
                   6752:   padding: 0.3em 0.8em;
                   6753:   vertical-align: top;
                   6754:   width: 150px;
                   6755:   border-top:1px solid $lg_border_color;
                   6756: }
                   6757: 
1.795     www      6758: td.LC_parm_overview_level_menu,
                   6759: td.LC_parm_overview_map_menu,
                   6760: td.LC_parm_overview_parm_selectors,
                   6761: td.LC_parm_overview_restrictions  {
1.396     albertel 6762:   border: 1px solid black;
                   6763:   border-collapse: collapse;
                   6764: }
1.795     www      6765: 
1.396     albertel 6766: table.LC_parm_overview_restrictions td {
                   6767:   border-width: 1px 4px 1px 4px;
                   6768:   border-style: solid;
                   6769:   border-color: $pgbg;
                   6770:   text-align: center;
                   6771: }
1.795     www      6772: 
1.396     albertel 6773: table.LC_parm_overview_restrictions th {
                   6774:   background: $tabbg;
                   6775:   border-width: 1px 4px 1px 4px;
                   6776:   border-style: solid;
                   6777:   border-color: $pgbg;
                   6778: }
1.795     www      6779: 
1.398     albertel 6780: table#LC_helpmenu {
1.803     bisitz   6781:   border: none;
1.398     albertel 6782:   height: 55px;
1.803     bisitz   6783:   border-spacing: 0;
1.398     albertel 6784: }
                   6785: 
                   6786: table#LC_helpmenu fieldset legend {
                   6787:   font-size: larger;
                   6788: }
1.795     www      6789: 
1.397     albertel 6790: table#LC_helpmenu_links {
                   6791:   width: 100%;
                   6792:   border: 1px solid black;
                   6793:   background: $pgbg;
1.803     bisitz   6794:   padding: 0;
1.397     albertel 6795:   border-spacing: 1px;
                   6796: }
1.795     www      6797: 
1.397     albertel 6798: table#LC_helpmenu_links tr td {
                   6799:   padding: 1px;
                   6800:   background: $tabbg;
1.399     albertel 6801:   text-align: center;
                   6802:   font-weight: bold;
1.397     albertel 6803: }
1.396     albertel 6804: 
1.795     www      6805: table#LC_helpmenu_links a:link,
                   6806: table#LC_helpmenu_links a:visited,
1.397     albertel 6807: table#LC_helpmenu_links a:active {
                   6808:   text-decoration: none;
                   6809:   color: $font;
                   6810: }
1.795     www      6811: 
1.397     albertel 6812: table#LC_helpmenu_links a:hover {
                   6813:   text-decoration: underline;
                   6814:   color: $vlink;
                   6815: }
1.396     albertel 6816: 
1.417     albertel 6817: .LC_chrt_popup_exists {
                   6818:   border: 1px solid #339933;
                   6819:   margin: -1px;
                   6820: }
1.795     www      6821: 
1.417     albertel 6822: .LC_chrt_popup_up {
                   6823:   border: 1px solid yellow;
                   6824:   margin: -1px;
                   6825: }
1.795     www      6826: 
1.417     albertel 6827: .LC_chrt_popup {
                   6828:   border: 1px solid #8888FF;
                   6829:   background: #CCCCFF;
                   6830: }
1.795     www      6831: 
1.421     albertel 6832: table.LC_pick_box {
                   6833:   border-collapse: separate;
                   6834:   background: white;
                   6835:   border: 1px solid black;
                   6836:   border-spacing: 1px;
                   6837: }
1.795     www      6838: 
1.421     albertel 6839: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   6840:   background: $sidebg;
1.421     albertel 6841:   font-weight: bold;
1.900     bisitz   6842:   text-align: left;
1.740     bisitz   6843:   vertical-align: top;
1.421     albertel 6844:   width: 184px;
                   6845:   padding: 8px;
                   6846: }
1.795     www      6847: 
1.579     raeburn  6848: table.LC_pick_box td.LC_pick_box_value {
                   6849:   text-align: left;
                   6850:   padding: 8px;
                   6851: }
1.795     www      6852: 
1.579     raeburn  6853: table.LC_pick_box td.LC_pick_box_select {
                   6854:   text-align: left;
                   6855:   padding: 8px;
                   6856: }
1.795     www      6857: 
1.424     albertel 6858: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   6859:   padding: 0;
1.421     albertel 6860:   height: 1px;
                   6861:   background: black;
                   6862: }
1.795     www      6863: 
1.421     albertel 6864: table.LC_pick_box td.LC_pick_box_submit {
                   6865:   text-align: right;
                   6866: }
1.795     www      6867: 
1.579     raeburn  6868: table.LC_pick_box td.LC_evenrow_value {
                   6869:   text-align: left;
                   6870:   padding: 8px;
                   6871:   background-color: $data_table_light;
                   6872: }
1.795     www      6873: 
1.579     raeburn  6874: table.LC_pick_box td.LC_oddrow_value {
                   6875:   text-align: left;
                   6876:   padding: 8px;
                   6877:   background-color: $data_table_light;
                   6878: }
1.795     www      6879: 
1.579     raeburn  6880: span.LC_helpform_receipt_cat {
                   6881:   font-weight: bold;
                   6882: }
1.795     www      6883: 
1.424     albertel 6884: table.LC_group_priv_box {
                   6885:   background: white;
                   6886:   border: 1px solid black;
                   6887:   border-spacing: 1px;
                   6888: }
1.795     www      6889: 
1.424     albertel 6890: table.LC_group_priv_box td.LC_pick_box_title {
                   6891:   background: $tabbg;
                   6892:   font-weight: bold;
                   6893:   text-align: right;
                   6894:   width: 184px;
                   6895: }
1.795     www      6896: 
1.424     albertel 6897: table.LC_group_priv_box td.LC_groups_fixed {
                   6898:   background: $data_table_light;
                   6899:   text-align: center;
                   6900: }
1.795     www      6901: 
1.424     albertel 6902: table.LC_group_priv_box td.LC_groups_optional {
                   6903:   background: $data_table_dark;
                   6904:   text-align: center;
                   6905: }
1.795     www      6906: 
1.424     albertel 6907: table.LC_group_priv_box td.LC_groups_functionality {
                   6908:   background: $data_table_darker;
                   6909:   text-align: center;
                   6910:   font-weight: bold;
                   6911: }
1.795     www      6912: 
1.424     albertel 6913: table.LC_group_priv td {
                   6914:   text-align: left;
1.803     bisitz   6915:   padding: 0;
1.424     albertel 6916: }
                   6917: 
                   6918: .LC_navbuttons {
                   6919:   margin: 2ex 0ex 2ex 0ex;
                   6920: }
1.795     www      6921: 
1.423     albertel 6922: .LC_topic_bar {
                   6923:   font-weight: bold;
                   6924:   background: $tabbg;
1.918     wenzelju 6925:   margin: 1em 0em 1em 2em;
1.805     bisitz   6926:   padding: 3px;
1.918     wenzelju 6927:   font-size: 1.2em;
1.423     albertel 6928: }
1.795     www      6929: 
1.423     albertel 6930: .LC_topic_bar span {
1.918     wenzelju 6931:   left: 0.5em;
                   6932:   position: absolute;
1.423     albertel 6933:   vertical-align: middle;
1.918     wenzelju 6934:   font-size: 1.2em;
1.423     albertel 6935: }
1.795     www      6936: 
1.423     albertel 6937: table.LC_course_group_status {
                   6938:   margin: 20px;
                   6939: }
1.795     www      6940: 
1.423     albertel 6941: table.LC_status_selector td {
                   6942:   vertical-align: top;
                   6943:   text-align: center;
1.424     albertel 6944:   padding: 4px;
                   6945: }
1.795     www      6946: 
1.599     albertel 6947: div.LC_feedback_link {
1.616     albertel 6948:   clear: both;
1.829     kalberla 6949:   background: $sidebg;
1.779     bisitz   6950:   width: 100%;
1.829     kalberla 6951:   padding-bottom: 10px;
                   6952:   border: 1px $tabbg solid;
1.833     kalberla 6953:   height: 22px;
                   6954:   line-height: 22px;
                   6955:   padding-top: 5px;
                   6956: }
                   6957: 
                   6958: div.LC_feedback_link img {
                   6959:   height: 22px;
1.867     kalberla 6960:   vertical-align:middle;
1.829     kalberla 6961: }
                   6962: 
1.911     bisitz   6963: div.LC_feedback_link a {
1.829     kalberla 6964:   text-decoration: none;
1.489     raeburn  6965: }
1.795     www      6966: 
1.867     kalberla 6967: div.LC_comblock {
1.911     bisitz   6968:   display:inline;
1.867     kalberla 6969:   color:$font;
                   6970:   font-size:90%;
                   6971: }
                   6972: 
                   6973: div.LC_feedback_link div.LC_comblock {
                   6974:   padding-left:5px;
                   6975: }
                   6976: 
                   6977: div.LC_feedback_link div.LC_comblock a {
                   6978:   color:$font;
                   6979: }
                   6980: 
1.489     raeburn  6981: span.LC_feedback_link {
1.858     bisitz   6982:   /* background: $feedback_link_bg; */
1.599     albertel 6983:   font-size: larger;
                   6984: }
1.795     www      6985: 
1.599     albertel 6986: span.LC_message_link {
1.858     bisitz   6987:   /* background: $feedback_link_bg; */
1.599     albertel 6988:   font-size: larger;
                   6989:   position: absolute;
                   6990:   right: 1em;
1.489     raeburn  6991: }
1.421     albertel 6992: 
1.515     albertel 6993: table.LC_prior_tries {
1.524     albertel 6994:   border: 1px solid #000000;
                   6995:   border-collapse: separate;
                   6996:   border-spacing: 1px;
1.515     albertel 6997: }
1.523     albertel 6998: 
1.515     albertel 6999: table.LC_prior_tries td {
1.524     albertel 7000:   padding: 2px;
1.515     albertel 7001: }
1.523     albertel 7002: 
                   7003: .LC_answer_correct {
1.795     www      7004:   background: lightgreen;
                   7005:   color: darkgreen;
                   7006:   padding: 6px;
1.523     albertel 7007: }
1.795     www      7008: 
1.523     albertel 7009: .LC_answer_charged_try {
1.797     www      7010:   background: #FFAAAA;
1.795     www      7011:   color: darkred;
                   7012:   padding: 6px;
1.523     albertel 7013: }
1.795     www      7014: 
1.779     bisitz   7015: .LC_answer_not_charged_try,
1.523     albertel 7016: .LC_answer_no_grade,
                   7017: .LC_answer_late {
1.795     www      7018:   background: lightyellow;
1.523     albertel 7019:   color: black;
1.795     www      7020:   padding: 6px;
1.523     albertel 7021: }
1.795     www      7022: 
1.523     albertel 7023: .LC_answer_previous {
1.795     www      7024:   background: lightblue;
                   7025:   color: darkblue;
                   7026:   padding: 6px;
1.523     albertel 7027: }
1.795     www      7028: 
1.779     bisitz   7029: .LC_answer_no_message {
1.777     tempelho 7030:   background: #FFFFFF;
                   7031:   color: black;
1.795     www      7032:   padding: 6px;
1.779     bisitz   7033: }
1.795     www      7034: 
1.1075.2.140  raeburn  7035: .LC_answer_unknown,
                   7036: .LC_answer_warning {
1.779     bisitz   7037:   background: orange;
                   7038:   color: black;
1.795     www      7039:   padding: 6px;
1.777     tempelho 7040: }
1.795     www      7041: 
1.529     albertel 7042: span.LC_prior_numerical,
                   7043: span.LC_prior_string,
                   7044: span.LC_prior_custom,
                   7045: span.LC_prior_reaction,
                   7046: span.LC_prior_math {
1.925     bisitz   7047:   font-family: $mono;
1.523     albertel 7048:   white-space: pre;
                   7049: }
                   7050: 
1.525     albertel 7051: span.LC_prior_string {
1.925     bisitz   7052:   font-family: $mono;
1.525     albertel 7053:   white-space: pre;
                   7054: }
                   7055: 
1.523     albertel 7056: table.LC_prior_option {
                   7057:   width: 100%;
                   7058:   border-collapse: collapse;
                   7059: }
1.795     www      7060: 
1.911     bisitz   7061: table.LC_prior_rank,
1.795     www      7062: table.LC_prior_match {
1.528     albertel 7063:   border-collapse: collapse;
                   7064: }
1.795     www      7065: 
1.528     albertel 7066: table.LC_prior_option tr td,
                   7067: table.LC_prior_rank tr td,
                   7068: table.LC_prior_match tr td {
1.524     albertel 7069:   border: 1px solid #000000;
1.515     albertel 7070: }
                   7071: 
1.855     bisitz   7072: .LC_nobreak {
1.544     albertel 7073:   white-space: nowrap;
1.519     raeburn  7074: }
                   7075: 
1.576     raeburn  7076: span.LC_cusr_emph {
                   7077:   font-style: italic;
                   7078: }
                   7079: 
1.633     raeburn  7080: span.LC_cusr_subheading {
                   7081:   font-weight: normal;
                   7082:   font-size: 85%;
                   7083: }
                   7084: 
1.861     bisitz   7085: div.LC_docs_entry_move {
1.859     bisitz   7086:   border: 1px solid #BBBBBB;
1.545     albertel 7087:   background: #DDDDDD;
1.861     bisitz   7088:   width: 22px;
1.859     bisitz   7089:   padding: 1px;
                   7090:   margin: 0;
1.545     albertel 7091: }
                   7092: 
1.861     bisitz   7093: table.LC_data_table tr > td.LC_docs_entry_commands,
                   7094: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 7095:   font-size: x-small;
                   7096: }
1.795     www      7097: 
1.861     bisitz   7098: .LC_docs_entry_parameter {
                   7099:   white-space: nowrap;
                   7100: }
                   7101: 
1.544     albertel 7102: .LC_docs_copy {
1.545     albertel 7103:   color: #000099;
1.544     albertel 7104: }
1.795     www      7105: 
1.544     albertel 7106: .LC_docs_cut {
1.545     albertel 7107:   color: #550044;
1.544     albertel 7108: }
1.795     www      7109: 
1.544     albertel 7110: .LC_docs_rename {
1.545     albertel 7111:   color: #009900;
1.544     albertel 7112: }
1.795     www      7113: 
1.544     albertel 7114: .LC_docs_remove {
1.545     albertel 7115:   color: #990000;
                   7116: }
                   7117: 
1.1075.2.134  raeburn  7118: .LC_domprefs_email,
1.547     albertel 7119: .LC_docs_reinit_warn,
                   7120: .LC_docs_ext_edit {
                   7121:   font-size: x-small;
                   7122: }
                   7123: 
1.545     albertel 7124: table.LC_docs_adddocs td,
                   7125: table.LC_docs_adddocs th {
                   7126:   border: 1px solid #BBBBBB;
                   7127:   padding: 4px;
                   7128:   background: #DDDDDD;
1.543     albertel 7129: }
                   7130: 
1.584     albertel 7131: table.LC_sty_begin {
                   7132:   background: #BBFFBB;
                   7133: }
1.795     www      7134: 
1.584     albertel 7135: table.LC_sty_end {
                   7136:   background: #FFBBBB;
                   7137: }
                   7138: 
1.589     raeburn  7139: table.LC_double_column {
1.803     bisitz   7140:   border-width: 0;
1.589     raeburn  7141:   border-collapse: collapse;
                   7142:   width: 100%;
                   7143:   padding: 2px;
                   7144: }
                   7145: 
                   7146: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  7147:   top: 2px;
1.589     raeburn  7148:   left: 2px;
                   7149:   width: 47%;
                   7150:   vertical-align: top;
                   7151: }
                   7152: 
                   7153: table.LC_double_column tr td.LC_right_col {
                   7154:   top: 2px;
1.779     bisitz   7155:   right: 2px;
1.589     raeburn  7156:   width: 47%;
                   7157:   vertical-align: top;
                   7158: }
                   7159: 
1.591     raeburn  7160: div.LC_left_float {
                   7161:   float: left;
                   7162:   padding-right: 5%;
1.597     albertel 7163:   padding-bottom: 4px;
1.591     raeburn  7164: }
                   7165: 
                   7166: div.LC_clear_float_header {
1.597     albertel 7167:   padding-bottom: 2px;
1.591     raeburn  7168: }
                   7169: 
                   7170: div.LC_clear_float_footer {
1.597     albertel 7171:   padding-top: 10px;
1.591     raeburn  7172:   clear: both;
                   7173: }
                   7174: 
1.597     albertel 7175: div.LC_grade_show_user {
1.941     bisitz   7176: /*  border-left: 5px solid $sidebg; */
                   7177:   border-top: 5px solid #000000;
                   7178:   margin: 50px 0 0 0;
1.936     bisitz   7179:   padding: 15px 0 5px 10px;
1.597     albertel 7180: }
1.795     www      7181: 
1.936     bisitz   7182: div.LC_grade_show_user_odd_row {
1.941     bisitz   7183: /*  border-left: 5px solid #000000; */
                   7184: }
                   7185: 
                   7186: div.LC_grade_show_user div.LC_Box {
                   7187:   margin-right: 50px;
1.597     albertel 7188: }
                   7189: 
                   7190: div.LC_grade_submissions,
                   7191: div.LC_grade_message_center,
1.936     bisitz   7192: div.LC_grade_info_links {
1.597     albertel 7193:   margin: 5px;
                   7194:   width: 99%;
                   7195:   background: #FFFFFF;
                   7196: }
1.795     www      7197: 
1.597     albertel 7198: div.LC_grade_submissions_header,
1.936     bisitz   7199: div.LC_grade_message_center_header {
1.705     tempelho 7200:   font-weight: bold;
                   7201:   font-size: large;
1.597     albertel 7202: }
1.795     www      7203: 
1.597     albertel 7204: div.LC_grade_submissions_body,
1.936     bisitz   7205: div.LC_grade_message_center_body {
1.597     albertel 7206:   border: 1px solid black;
                   7207:   width: 99%;
                   7208:   background: #FFFFFF;
                   7209: }
1.795     www      7210: 
1.613     albertel 7211: table.LC_scantron_action {
                   7212:   width: 100%;
                   7213: }
1.795     www      7214: 
1.613     albertel 7215: table.LC_scantron_action tr th {
1.698     harmsja  7216:   font-weight:bold;
                   7217:   font-style:normal;
1.613     albertel 7218: }
1.795     www      7219: 
1.779     bisitz   7220: .LC_edit_problem_header,
1.614     albertel 7221: div.LC_edit_problem_footer {
1.705     tempelho 7222:   font-weight: normal;
                   7223:   font-size:  medium;
1.602     albertel 7224:   margin: 2px;
1.1060    bisitz   7225:   background-color: $sidebg;
1.600     albertel 7226: }
1.795     www      7227: 
1.600     albertel 7228: div.LC_edit_problem_header,
1.602     albertel 7229: div.LC_edit_problem_header div,
1.614     albertel 7230: div.LC_edit_problem_footer,
                   7231: div.LC_edit_problem_footer div,
1.602     albertel 7232: div.LC_edit_problem_editxml_header,
                   7233: div.LC_edit_problem_editxml_header div {
1.1075.2.112  raeburn  7234:   z-index: 100;
1.600     albertel 7235: }
1.795     www      7236: 
1.600     albertel 7237: div.LC_edit_problem_header_title {
1.705     tempelho 7238:   font-weight: bold;
                   7239:   font-size: larger;
1.602     albertel 7240:   background: $tabbg;
                   7241:   padding: 3px;
1.1060    bisitz   7242:   margin: 0 0 5px 0;
1.602     albertel 7243: }
1.795     www      7244: 
1.602     albertel 7245: table.LC_edit_problem_header_title {
                   7246:   width: 100%;
1.600     albertel 7247:   background: $tabbg;
1.602     albertel 7248: }
                   7249: 
1.1075.2.112  raeburn  7250: div.LC_edit_actionbar {
                   7251:     background-color: $sidebg;
                   7252:     margin: 0;
                   7253:     padding: 0;
                   7254:     line-height: 200%;
1.602     albertel 7255: }
1.795     www      7256: 
1.1075.2.112  raeburn  7257: div.LC_edit_actionbar div{
                   7258:     padding: 0;
                   7259:     margin: 0;
                   7260:     display: inline-block;
1.600     albertel 7261: }
1.795     www      7262: 
1.1075.2.34  raeburn  7263: .LC_edit_opt {
                   7264:   padding-left: 1em;
                   7265:   white-space: nowrap;
                   7266: }
                   7267: 
1.1075.2.57  raeburn  7268: .LC_edit_problem_latexhelper{
                   7269:     text-align: right;
                   7270: }
                   7271: 
                   7272: #LC_edit_problem_colorful div{
                   7273:     margin-left: 40px;
                   7274: }
                   7275: 
1.1075.2.112  raeburn  7276: #LC_edit_problem_codemirror div{
                   7277:     margin-left: 0px;
                   7278: }
                   7279: 
1.911     bisitz   7280: img.stift {
1.803     bisitz   7281:   border-width: 0;
                   7282:   vertical-align: middle;
1.677     riegler  7283: }
1.680     riegler  7284: 
1.923     bisitz   7285: table td.LC_mainmenu_col_fieldset {
1.680     riegler  7286:   vertical-align: top;
1.777     tempelho 7287: }
1.795     www      7288: 
1.716     raeburn  7289: div.LC_createcourse {
1.911     bisitz   7290:   margin: 10px 10px 10px 10px;
1.716     raeburn  7291: }
                   7292: 
1.917     raeburn  7293: .LC_dccid {
1.1075.2.38  raeburn  7294:   float: right;
1.917     raeburn  7295:   margin: 0.2em 0 0 0;
                   7296:   padding: 0;
                   7297:   font-size: 90%;
                   7298:   display:none;
                   7299: }
                   7300: 
1.897     wenzelju 7301: ol.LC_primary_menu a:hover,
1.721     harmsja  7302: ol#LC_MenuBreadcrumbs a:hover,
                   7303: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 7304: ul#LC_secondary_menu a:hover,
1.721     harmsja  7305: .LC_FormSectionClearButton input:hover
1.795     www      7306: ul.LC_TabContent   li:hover a {
1.952     onken    7307:   color:$button_hover;
1.911     bisitz   7308:   text-decoration:none;
1.693     droeschl 7309: }
                   7310: 
1.779     bisitz   7311: h1 {
1.911     bisitz   7312:   padding: 0;
                   7313:   line-height:130%;
1.693     droeschl 7314: }
1.698     harmsja  7315: 
1.911     bisitz   7316: h2,
                   7317: h3,
                   7318: h4,
                   7319: h5,
                   7320: h6 {
                   7321:   margin: 5px 0 5px 0;
                   7322:   padding: 0;
                   7323:   line-height:130%;
1.693     droeschl 7324: }
1.795     www      7325: 
                   7326: .LC_hcell {
1.911     bisitz   7327:   padding:3px 15px 3px 15px;
                   7328:   margin: 0;
                   7329:   background-color:$tabbg;
                   7330:   color:$fontmenu;
                   7331:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 7332: }
1.795     www      7333: 
1.840     bisitz   7334: .LC_Box > .LC_hcell {
1.911     bisitz   7335:   margin: 0 -10px 10px -10px;
1.835     bisitz   7336: }
                   7337: 
1.721     harmsja  7338: .LC_noBorder {
1.911     bisitz   7339:   border: 0;
1.698     harmsja  7340: }
1.693     droeschl 7341: 
1.721     harmsja  7342: .LC_FormSectionClearButton input {
1.911     bisitz   7343:   background-color:transparent;
                   7344:   border: none;
                   7345:   cursor:pointer;
                   7346:   text-decoration:underline;
1.693     droeschl 7347: }
1.763     bisitz   7348: 
                   7349: .LC_help_open_topic {
1.911     bisitz   7350:   color: #FFFFFF;
                   7351:   background-color: #EEEEFF;
                   7352:   margin: 1px;
                   7353:   padding: 4px;
                   7354:   border: 1px solid #000033;
                   7355:   white-space: nowrap;
                   7356:   /* vertical-align: middle; */
1.759     neumanie 7357: }
1.693     droeschl 7358: 
1.911     bisitz   7359: dl,
                   7360: ul,
                   7361: div,
                   7362: fieldset {
                   7363:   margin: 10px 10px 10px 0;
                   7364:   /* overflow: hidden; */
1.693     droeschl 7365: }
1.795     www      7366: 
1.1075.2.90  raeburn  7367: article.geogebraweb div {
                   7368:     margin: 0;
                   7369: }
                   7370: 
1.838     bisitz   7371: fieldset > legend {
1.911     bisitz   7372:   font-weight: bold;
                   7373:   padding: 0 5px 0 5px;
1.838     bisitz   7374: }
                   7375: 
1.813     bisitz   7376: #LC_nav_bar {
1.911     bisitz   7377:   float: left;
1.995     raeburn  7378:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   7379:   margin: 0 0 2px 0;
1.807     droeschl 7380: }
                   7381: 
1.916     droeschl 7382: #LC_realm {
                   7383:   margin: 0.2em 0 0 0;
                   7384:   padding: 0;
                   7385:   font-weight: bold;
                   7386:   text-align: center;
1.995     raeburn  7387:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 7388: }
                   7389: 
1.911     bisitz   7390: #LC_nav_bar em {
                   7391:   font-weight: bold;
                   7392:   font-style: normal;
1.807     droeschl 7393: }
                   7394: 
1.897     wenzelju 7395: ol.LC_primary_menu {
1.934     droeschl 7396:   margin: 0;
1.1075.2.2  raeburn  7397:   padding: 0;
1.807     droeschl 7398: }
                   7399: 
1.852     droeschl 7400: ol#LC_PathBreadcrumbs {
1.911     bisitz   7401:   margin: 0;
1.693     droeschl 7402: }
                   7403: 
1.897     wenzelju 7404: ol.LC_primary_menu li {
1.1075.2.2  raeburn  7405:   color: RGB(80, 80, 80);
                   7406:   vertical-align: middle;
                   7407:   text-align: left;
                   7408:   list-style: none;
1.1075.2.112  raeburn  7409:   position: relative;
1.1075.2.2  raeburn  7410:   float: left;
1.1075.2.112  raeburn  7411:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   7412:   line-height: 1.5em;
1.1075.2.2  raeburn  7413: }
                   7414: 
1.1075.2.113  raeburn  7415: ol.LC_primary_menu li a, 
1.1075.2.112  raeburn  7416: ol.LC_primary_menu li p {
1.1075.2.2  raeburn  7417:   display: block;
                   7418:   margin: 0;
                   7419:   padding: 0 5px 0 10px;
                   7420:   text-decoration: none;
                   7421: }
                   7422: 
1.1075.2.112  raeburn  7423: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   7424:   display: inline-block;
                   7425:   width: 95%;
                   7426:   text-align: left;
                   7427: }
                   7428: 
                   7429: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   7430:   display: inline-block;
                   7431:   width: 5%;
                   7432:   float: right;
                   7433:   text-align: right;
                   7434:   font-size: 70%;
                   7435: }
                   7436: 
                   7437: ol.LC_primary_menu ul {
1.1075.2.2  raeburn  7438:   display: none;
1.1075.2.112  raeburn  7439:   width: 15em;
1.1075.2.2  raeburn  7440:   background-color: $data_table_light;
1.1075.2.112  raeburn  7441:   position: absolute;
                   7442:   top: 100%;
                   7443: }
                   7444: 
                   7445: ol.LC_primary_menu ul ul {
                   7446:   left: 100%;
                   7447:   top: 0;
1.1075.2.2  raeburn  7448: }
                   7449: 
1.1075.2.112  raeburn  7450: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1075.2.2  raeburn  7451:   display: block;
                   7452:   position: absolute;
                   7453:   margin: 0;
                   7454:   padding: 0;
1.1075.2.5  raeburn  7455:   z-index: 2;
1.1075.2.2  raeburn  7456: }
                   7457: 
                   7458: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1075.2.112  raeburn  7459: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1075.2.2  raeburn  7460:   font-size: 90%;
1.911     bisitz   7461:   vertical-align: top;
1.1075.2.2  raeburn  7462:   float: none;
1.1075.2.5  raeburn  7463:   border-left: 1px solid black;
                   7464:   border-right: 1px solid black;
1.1075.2.112  raeburn  7465: /* A dark bottom border to visualize different menu options;
                   7466: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   7467:   border-bottom: 1px solid $data_table_dark;
1.1075.2.2  raeburn  7468: }
                   7469: 
1.1075.2.112  raeburn  7470: ol.LC_primary_menu li li p:hover {
                   7471:   color:$button_hover;
                   7472:   text-decoration:none;
                   7473:   background-color:$data_table_dark;
1.1075.2.2  raeburn  7474: }
                   7475: 
                   7476: ol.LC_primary_menu li li a:hover {
                   7477:    color:$button_hover;
                   7478:    background-color:$data_table_dark;
1.693     droeschl 7479: }
                   7480: 
1.1075.2.112  raeburn  7481: /* Font-size equal to the size of the predecessors*/
                   7482: ol.LC_primary_menu li:hover li li {
                   7483:   font-size: 100%;
                   7484: }
                   7485: 
1.897     wenzelju 7486: ol.LC_primary_menu li img {
1.911     bisitz   7487:   vertical-align: bottom;
1.934     droeschl 7488:   height: 1.1em;
1.1075.2.3  raeburn  7489:   margin: 0.2em 0 0 0;
1.693     droeschl 7490: }
                   7491: 
1.897     wenzelju 7492: ol.LC_primary_menu a {
1.911     bisitz   7493:   color: RGB(80, 80, 80);
                   7494:   text-decoration: none;
1.693     droeschl 7495: }
1.795     www      7496: 
1.949     droeschl 7497: ol.LC_primary_menu a.LC_new_message {
                   7498:   font-weight:bold;
                   7499:   color: darkred;
                   7500: }
                   7501: 
1.975     raeburn  7502: ol.LC_docs_parameters {
                   7503:   margin-left: 0;
                   7504:   padding: 0;
                   7505:   list-style: none;
                   7506: }
                   7507: 
                   7508: ol.LC_docs_parameters li {
                   7509:   margin: 0;
                   7510:   padding-right: 20px;
                   7511:   display: inline;
                   7512: }
                   7513: 
1.976     raeburn  7514: ol.LC_docs_parameters li:before {
                   7515:   content: "\\002022 \\0020";
                   7516: }
                   7517: 
                   7518: li.LC_docs_parameters_title {
                   7519:   font-weight: bold;
                   7520: }
                   7521: 
                   7522: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   7523:   content: "";
                   7524: }
                   7525: 
1.897     wenzelju 7526: ul#LC_secondary_menu {
1.1075.2.23  raeburn  7527:   clear: right;
1.911     bisitz   7528:   color: $fontmenu;
                   7529:   background: $tabbg;
                   7530:   list-style: none;
                   7531:   padding: 0;
                   7532:   margin: 0;
                   7533:   width: 100%;
1.995     raeburn  7534:   text-align: left;
1.1075.2.4  raeburn  7535:   float: left;
1.808     droeschl 7536: }
                   7537: 
1.897     wenzelju 7538: ul#LC_secondary_menu li {
1.911     bisitz   7539:   font-weight: bold;
                   7540:   line-height: 1.8em;
                   7541:   border-right: 1px solid black;
1.1075.2.4  raeburn  7542:   float: left;
                   7543: }
                   7544: 
                   7545: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   7546:   background-color: $data_table_light;
                   7547: }
                   7548: 
                   7549: ul#LC_secondary_menu li a {
                   7550:   padding: 0 0.8em;
                   7551: }
                   7552: 
                   7553: ul#LC_secondary_menu li ul {
                   7554:   display: none;
                   7555: }
                   7556: 
                   7557: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   7558:   display: block;
                   7559:   position: absolute;
                   7560:   margin: 0;
                   7561:   padding: 0;
                   7562:   list-style:none;
                   7563:   float: none;
                   7564:   background-color: $data_table_light;
1.1075.2.5  raeburn  7565:   z-index: 2;
1.1075.2.10  raeburn  7566:   margin-left: -1px;
1.1075.2.4  raeburn  7567: }
                   7568: 
                   7569: ul#LC_secondary_menu li ul li {
                   7570:   font-size: 90%;
                   7571:   vertical-align: top;
                   7572:   border-left: 1px solid black;
                   7573:   border-right: 1px solid black;
1.1075.2.33  raeburn  7574:   background-color: $data_table_light;
1.1075.2.4  raeburn  7575:   list-style:none;
                   7576:   float: none;
                   7577: }
                   7578: 
                   7579: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   7580:   background-color: $data_table_dark;
1.807     droeschl 7581: }
                   7582: 
1.847     tempelho 7583: ul.LC_TabContent {
1.911     bisitz   7584:   display:block;
                   7585:   background: $sidebg;
                   7586:   border-bottom: solid 1px $lg_border_color;
                   7587:   list-style:none;
1.1020    raeburn  7588:   margin: -1px -10px 0 -10px;
1.911     bisitz   7589:   padding: 0;
1.693     droeschl 7590: }
                   7591: 
1.795     www      7592: ul.LC_TabContent li,
                   7593: ul.LC_TabContentBigger li {
1.911     bisitz   7594:   float:left;
1.741     harmsja  7595: }
1.795     www      7596: 
1.897     wenzelju 7597: ul#LC_secondary_menu li a {
1.911     bisitz   7598:   color: $fontmenu;
                   7599:   text-decoration: none;
1.693     droeschl 7600: }
1.795     www      7601: 
1.721     harmsja  7602: ul.LC_TabContent {
1.952     onken    7603:   min-height:20px;
1.721     harmsja  7604: }
1.795     www      7605: 
                   7606: ul.LC_TabContent li {
1.911     bisitz   7607:   vertical-align:middle;
1.959     onken    7608:   padding: 0 16px 0 10px;
1.911     bisitz   7609:   background-color:$tabbg;
                   7610:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  7611:   border-left: solid 1px $font;
1.721     harmsja  7612: }
1.795     www      7613: 
1.847     tempelho 7614: ul.LC_TabContent .right {
1.911     bisitz   7615:   float:right;
1.847     tempelho 7616: }
                   7617: 
1.911     bisitz   7618: ul.LC_TabContent li a,
                   7619: ul.LC_TabContent li {
                   7620:   color:rgb(47,47,47);
                   7621:   text-decoration:none;
                   7622:   font-size:95%;
                   7623:   font-weight:bold;
1.952     onken    7624:   min-height:20px;
                   7625: }
                   7626: 
1.959     onken    7627: ul.LC_TabContent li a:hover,
                   7628: ul.LC_TabContent li a:focus {
1.952     onken    7629:   color: $button_hover;
1.959     onken    7630:   background:none;
                   7631:   outline:none;
1.952     onken    7632: }
                   7633: 
                   7634: ul.LC_TabContent li:hover {
                   7635:   color: $button_hover;
                   7636:   cursor:pointer;
1.721     harmsja  7637: }
1.795     www      7638: 
1.911     bisitz   7639: ul.LC_TabContent li.active {
1.952     onken    7640:   color: $font;
1.911     bisitz   7641:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    7642:   border-bottom:solid 1px #FFFFFF;
                   7643:   cursor: default;
1.744     ehlerst  7644: }
1.795     www      7645: 
1.959     onken    7646: ul.LC_TabContent li.active a {
                   7647:   color:$font;
                   7648:   background:#FFFFFF;
                   7649:   outline: none;
                   7650: }
1.1047    raeburn  7651: 
                   7652: ul.LC_TabContent li.goback {
                   7653:   float: left;
                   7654:   border-left: none;
                   7655: }
                   7656: 
1.870     tempelho 7657: #maincoursedoc {
1.911     bisitz   7658:   clear:both;
1.870     tempelho 7659: }
                   7660: 
                   7661: ul.LC_TabContentBigger {
1.911     bisitz   7662:   display:block;
                   7663:   list-style:none;
                   7664:   padding: 0;
1.870     tempelho 7665: }
                   7666: 
1.795     www      7667: ul.LC_TabContentBigger li {
1.911     bisitz   7668:   vertical-align:bottom;
                   7669:   height: 30px;
                   7670:   font-size:110%;
                   7671:   font-weight:bold;
                   7672:   color: #737373;
1.841     tempelho 7673: }
                   7674: 
1.957     onken    7675: ul.LC_TabContentBigger li.active {
                   7676:   position: relative;
                   7677:   top: 1px;
                   7678: }
                   7679: 
1.870     tempelho 7680: ul.LC_TabContentBigger li a {
1.911     bisitz   7681:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   7682:   height: 30px;
                   7683:   line-height: 30px;
                   7684:   text-align: center;
                   7685:   display: block;
                   7686:   text-decoration: none;
1.958     onken    7687:   outline: none;  
1.741     harmsja  7688: }
1.795     www      7689: 
1.870     tempelho 7690: ul.LC_TabContentBigger li.active a {
1.911     bisitz   7691:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   7692:   color:$font;
1.744     ehlerst  7693: }
1.795     www      7694: 
1.870     tempelho 7695: ul.LC_TabContentBigger li b {
1.911     bisitz   7696:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   7697:   display: block;
                   7698:   float: left;
                   7699:   padding: 0 30px;
1.957     onken    7700:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 7701: }
                   7702: 
1.956     onken    7703: ul.LC_TabContentBigger li:hover b {
                   7704:   color:$button_hover;
                   7705: }
                   7706: 
1.870     tempelho 7707: ul.LC_TabContentBigger li.active b {
1.911     bisitz   7708:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   7709:   color:$font;
1.957     onken    7710:   border: 0;
1.741     harmsja  7711: }
1.693     droeschl 7712: 
1.870     tempelho 7713: 
1.862     bisitz   7714: ul.LC_CourseBreadcrumbs {
                   7715:   background: $sidebg;
1.1020    raeburn  7716:   height: 2em;
1.862     bisitz   7717:   padding-left: 10px;
1.1020    raeburn  7718:   margin: 0;
1.862     bisitz   7719:   list-style-position: inside;
                   7720: }
                   7721: 
1.911     bisitz   7722: ol#LC_MenuBreadcrumbs,
1.862     bisitz   7723: ol#LC_PathBreadcrumbs {
1.911     bisitz   7724:   padding-left: 10px;
                   7725:   margin: 0;
1.933     droeschl 7726:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 7727: }
                   7728: 
1.911     bisitz   7729: ol#LC_MenuBreadcrumbs li,
                   7730: ol#LC_PathBreadcrumbs li,
1.862     bisitz   7731: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   7732:   display: inline;
1.933     droeschl 7733:   white-space: normal;  
1.693     droeschl 7734: }
                   7735: 
1.823     bisitz   7736: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   7737: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   7738:   text-decoration: none;
                   7739:   font-size:90%;
1.693     droeschl 7740: }
1.795     www      7741: 
1.969     droeschl 7742: ol#LC_MenuBreadcrumbs h1 {
                   7743:   display: inline;
                   7744:   font-size: 90%;
                   7745:   line-height: 2.5em;
                   7746:   margin: 0;
                   7747:   padding: 0;
                   7748: }
                   7749: 
1.795     www      7750: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   7751:   text-decoration:none;
                   7752:   font-size:100%;
                   7753:   font-weight:bold;
1.693     droeschl 7754: }
1.795     www      7755: 
1.840     bisitz   7756: .LC_Box {
1.911     bisitz   7757:   border: solid 1px $lg_border_color;
                   7758:   padding: 0 10px 10px 10px;
1.746     neumanie 7759: }
1.795     www      7760: 
1.1020    raeburn  7761: .LC_DocsBox {
                   7762:   border: solid 1px $lg_border_color;
                   7763:   padding: 0 0 10px 10px;
                   7764: }
                   7765: 
1.795     www      7766: .LC_AboutMe_Image {
1.911     bisitz   7767:   float:left;
                   7768:   margin-right:10px;
1.747     neumanie 7769: }
1.795     www      7770: 
                   7771: .LC_Clear_AboutMe_Image {
1.911     bisitz   7772:   clear:left;
1.747     neumanie 7773: }
1.795     www      7774: 
1.721     harmsja  7775: dl.LC_ListStyleClean dt {
1.911     bisitz   7776:   padding-right: 5px;
                   7777:   display: table-header-group;
1.693     droeschl 7778: }
                   7779: 
1.721     harmsja  7780: dl.LC_ListStyleClean dd {
1.911     bisitz   7781:   display: table-row;
1.693     droeschl 7782: }
                   7783: 
1.721     harmsja  7784: .LC_ListStyleClean,
                   7785: .LC_ListStyleSimple,
                   7786: .LC_ListStyleNormal,
1.795     www      7787: .LC_ListStyleSpecial {
1.911     bisitz   7788:   /* display:block; */
                   7789:   list-style-position: inside;
                   7790:   list-style-type: none;
                   7791:   overflow: hidden;
                   7792:   padding: 0;
1.693     droeschl 7793: }
                   7794: 
1.721     harmsja  7795: .LC_ListStyleSimple li,
                   7796: .LC_ListStyleSimple dd,
                   7797: .LC_ListStyleNormal li,
                   7798: .LC_ListStyleNormal dd,
                   7799: .LC_ListStyleSpecial li,
1.795     www      7800: .LC_ListStyleSpecial dd {
1.911     bisitz   7801:   margin: 0;
                   7802:   padding: 5px 5px 5px 10px;
                   7803:   clear: both;
1.693     droeschl 7804: }
                   7805: 
1.721     harmsja  7806: .LC_ListStyleClean li,
                   7807: .LC_ListStyleClean dd {
1.911     bisitz   7808:   padding-top: 0;
                   7809:   padding-bottom: 0;
1.693     droeschl 7810: }
                   7811: 
1.721     harmsja  7812: .LC_ListStyleSimple dd,
1.795     www      7813: .LC_ListStyleSimple li {
1.911     bisitz   7814:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 7815: }
                   7816: 
1.721     harmsja  7817: .LC_ListStyleSpecial li,
                   7818: .LC_ListStyleSpecial dd {
1.911     bisitz   7819:   list-style-type: none;
                   7820:   background-color: RGB(220, 220, 220);
                   7821:   margin-bottom: 4px;
1.693     droeschl 7822: }
                   7823: 
1.721     harmsja  7824: table.LC_SimpleTable {
1.911     bisitz   7825:   margin:5px;
                   7826:   border:solid 1px $lg_border_color;
1.795     www      7827: }
1.693     droeschl 7828: 
1.721     harmsja  7829: table.LC_SimpleTable tr {
1.911     bisitz   7830:   padding: 0;
                   7831:   border:solid 1px $lg_border_color;
1.693     droeschl 7832: }
1.795     www      7833: 
                   7834: table.LC_SimpleTable thead {
1.911     bisitz   7835:   background:rgb(220,220,220);
1.693     droeschl 7836: }
                   7837: 
1.721     harmsja  7838: div.LC_columnSection {
1.911     bisitz   7839:   display: block;
                   7840:   clear: both;
                   7841:   overflow: hidden;
                   7842:   margin: 0;
1.693     droeschl 7843: }
                   7844: 
1.721     harmsja  7845: div.LC_columnSection>* {
1.911     bisitz   7846:   float: left;
                   7847:   margin: 10px 20px 10px 0;
                   7848:   overflow:hidden;
1.693     droeschl 7849: }
1.721     harmsja  7850: 
1.795     www      7851: table em {
1.911     bisitz   7852:   font-weight: bold;
                   7853:   font-style: normal;
1.748     schulted 7854: }
1.795     www      7855: 
1.779     bisitz   7856: table.LC_tableBrowseRes,
1.795     www      7857: table.LC_tableOfContent {
1.911     bisitz   7858:   border:none;
                   7859:   border-spacing: 1px;
                   7860:   padding: 3px;
                   7861:   background-color: #FFFFFF;
                   7862:   font-size: 90%;
1.753     droeschl 7863: }
1.789     droeschl 7864: 
1.911     bisitz   7865: table.LC_tableOfContent {
                   7866:   border-collapse: collapse;
1.789     droeschl 7867: }
                   7868: 
1.771     droeschl 7869: table.LC_tableBrowseRes a,
1.768     schulted 7870: table.LC_tableOfContent a {
1.911     bisitz   7871:   background-color: transparent;
                   7872:   text-decoration: none;
1.753     droeschl 7873: }
                   7874: 
1.795     www      7875: table.LC_tableOfContent img {
1.911     bisitz   7876:   border: none;
                   7877:   height: 1.3em;
                   7878:   vertical-align: text-bottom;
                   7879:   margin-right: 0.3em;
1.753     droeschl 7880: }
1.757     schulted 7881: 
1.795     www      7882: a#LC_content_toolbar_firsthomework {
1.911     bisitz   7883:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  7884: }
                   7885: 
1.795     www      7886: a#LC_content_toolbar_everything {
1.911     bisitz   7887:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  7888: }
                   7889: 
1.795     www      7890: a#LC_content_toolbar_uncompleted {
1.911     bisitz   7891:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  7892: }
                   7893: 
1.795     www      7894: #LC_content_toolbar_clearbubbles {
1.911     bisitz   7895:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  7896: }
                   7897: 
1.795     www      7898: a#LC_content_toolbar_changefolder {
1.911     bisitz   7899:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 7900: }
                   7901: 
1.795     www      7902: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   7903:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 7904: }
                   7905: 
1.1043    raeburn  7906: a#LC_content_toolbar_edittoplevel {
                   7907:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   7908: }
                   7909: 
1.795     www      7910: ul#LC_toolbar li a:hover {
1.911     bisitz   7911:   background-position: bottom center;
1.757     schulted 7912: }
                   7913: 
1.795     www      7914: ul#LC_toolbar {
1.911     bisitz   7915:   padding: 0;
                   7916:   margin: 2px;
                   7917:   list-style:none;
                   7918:   position:relative;
                   7919:   background-color:white;
1.1075.2.9  raeburn  7920:   overflow: auto;
1.757     schulted 7921: }
                   7922: 
1.795     www      7923: ul#LC_toolbar li {
1.911     bisitz   7924:   border:1px solid white;
                   7925:   padding: 0;
                   7926:   margin: 0;
                   7927:   float: left;
                   7928:   display:inline;
                   7929:   vertical-align:middle;
1.1075.2.9  raeburn  7930:   white-space: nowrap;
1.911     bisitz   7931: }
1.757     schulted 7932: 
1.783     amueller 7933: 
1.795     www      7934: a.LC_toolbarItem {
1.911     bisitz   7935:   display:block;
                   7936:   padding: 0;
                   7937:   margin: 0;
                   7938:   height: 32px;
                   7939:   width: 32px;
                   7940:   color:white;
                   7941:   border: none;
                   7942:   background-repeat:no-repeat;
                   7943:   background-color:transparent;
1.757     schulted 7944: }
                   7945: 
1.915     droeschl 7946: ul.LC_funclist {
                   7947:     margin: 0;
                   7948:     padding: 0.5em 1em 0.5em 0;
                   7949: }
                   7950: 
1.933     droeschl 7951: ul.LC_funclist > li:first-child {
                   7952:     font-weight:bold; 
                   7953:     margin-left:0.8em;
                   7954: }
                   7955: 
1.915     droeschl 7956: ul.LC_funclist + ul.LC_funclist {
                   7957:     /* 
                   7958:        left border as a seperator if we have more than
                   7959:        one list 
                   7960:     */
                   7961:     border-left: 1px solid $sidebg;
                   7962:     /* 
                   7963:        this hides the left border behind the border of the 
                   7964:        outer box if element is wrapped to the next 'line' 
                   7965:     */
                   7966:     margin-left: -1px;
                   7967: }
                   7968: 
1.843     bisitz   7969: ul.LC_funclist li {
1.915     droeschl 7970:   display: inline;
1.782     bisitz   7971:   white-space: nowrap;
1.915     droeschl 7972:   margin: 0 0 0 25px;
                   7973:   line-height: 150%;
1.782     bisitz   7974: }
                   7975: 
1.974     wenzelju 7976: .LC_hidden {
                   7977:   display: none;
                   7978: }
                   7979: 
1.1030    www      7980: .LCmodal-overlay {
                   7981: 		position:fixed;
                   7982: 		top:0;
                   7983: 		right:0;
                   7984: 		bottom:0;
                   7985: 		left:0;
                   7986: 		height:100%;
                   7987: 		width:100%;
                   7988: 		margin:0;
                   7989: 		padding:0;
                   7990: 		background:#999;
                   7991: 		opacity:.75;
                   7992: 		filter: alpha(opacity=75);
                   7993: 		-moz-opacity: 0.75;
                   7994: 		z-index:101;
                   7995: }
                   7996: 
                   7997: * html .LCmodal-overlay {   
                   7998: 		position: absolute;
                   7999: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   8000: }
                   8001: 
                   8002: .LCmodal-window {
                   8003: 		position:fixed;
                   8004: 		top:50%;
                   8005: 		left:50%;
                   8006: 		margin:0;
                   8007: 		padding:0;
                   8008: 		z-index:102;
                   8009: 	}
                   8010: 
                   8011: * html .LCmodal-window {
                   8012: 		position:absolute;
                   8013: }
                   8014: 
                   8015: .LCclose-window {
                   8016: 		position:absolute;
                   8017: 		width:32px;
                   8018: 		height:32px;
                   8019: 		right:8px;
                   8020: 		top:8px;
                   8021: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   8022: 		text-indent:-99999px;
                   8023: 		overflow:hidden;
                   8024: 		cursor:pointer;
                   8025: }
                   8026: 
1.1075.2.158  raeburn  8027: .LCisDisabled {
                   8028:   cursor: not-allowed;
                   8029:   opacity: 0.5;
                   8030: }
                   8031: 
                   8032: a[aria-disabled="true"] {
                   8033:   color: currentColor;
                   8034:   display: inline-block;  /* For IE11/ MS Edge bug */
                   8035:   pointer-events: none;
                   8036:   text-decoration: none;
                   8037: }
                   8038: 
1.1075.2.141  raeburn  8039: pre.LC_wordwrap {
                   8040:   white-space: pre-wrap;
                   8041:   white-space: -moz-pre-wrap;
                   8042:   white-space: -pre-wrap;
                   8043:   white-space: -o-pre-wrap;
                   8044:   word-wrap: break-word;
                   8045: }
                   8046: 
1.1075.2.17  raeburn  8047: /*
                   8048:   styles used by TTH when "Default set of options to pass to tth/m
                   8049:   when converting TeX" in course settings has been set
                   8050: 
                   8051:   option passed: -t
                   8052: 
                   8053: */
                   8054: 
                   8055: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   8056: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   8057: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   8058: td div.norm {line-height:normal;}
                   8059: 
                   8060: /*
                   8061:   option passed -y3
                   8062: */
                   8063: 
                   8064: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   8065: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   8066: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   8067: 
1.1075.2.121  raeburn  8068: #LC_minitab_header {
                   8069:   float:left;
                   8070:   width:100%;
                   8071:   background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
                   8072:   font-size:93%;
                   8073:   line-height:normal;
                   8074:   margin: 0.5em 0 0.5em 0;
                   8075: }
                   8076: #LC_minitab_header ul {
                   8077:   margin:0;
                   8078:   padding:10px 10px 0;
                   8079:   list-style:none;
                   8080: }
                   8081: #LC_minitab_header li {
                   8082:   float:left;
                   8083:   background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
                   8084:   margin:0;
                   8085:   padding:0 0 0 9px;
                   8086: }
                   8087: #LC_minitab_header a {
                   8088:   display:block;
                   8089:   background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
                   8090:   padding:5px 15px 4px 6px;
                   8091: }
                   8092: #LC_minitab_header #LC_current_minitab {
                   8093:   background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
                   8094: }
                   8095: #LC_minitab_header #LC_current_minitab a {
                   8096:   background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
                   8097:   padding-bottom:5px;
                   8098: }
                   8099: 
                   8100: 
1.343     albertel 8101: END
                   8102: }
                   8103: 
1.306     albertel 8104: =pod
                   8105: 
                   8106: =item * &headtag()
                   8107: 
                   8108: Returns a uniform footer for LON-CAPA web pages.
                   8109: 
1.307     albertel 8110: Inputs: $title - optional title for the head
                   8111:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 8112:         $args - optional arguments
1.319     albertel 8113:             force_register - if is true call registerurl so the remote is 
                   8114:                              informed
1.415     albertel 8115:             redirect       -> array ref of
                   8116:                                    1- seconds before redirect occurs
                   8117:                                    2- url to redirect to
                   8118:                                    3- whether the side effect should occur
1.315     albertel 8119:                            (side effect of setting 
                   8120:                                $env{'internal.head.redirect'} to the url 
                   8121:                                redirected too)
1.352     albertel 8122:             domain         -> force to color decorate a page for a specific
                   8123:                                domain
                   8124:             function       -> force usage of a specific rolish color scheme
                   8125:             bgcolor        -> override the default page bgcolor
1.460     albertel 8126:             no_auto_mt_title
                   8127:                            -> prevent &mt()ing the title arg
1.464     albertel 8128: 
1.306     albertel 8129: =cut
                   8130: 
                   8131: sub headtag {
1.313     albertel 8132:     my ($title,$head_extra,$args) = @_;
1.306     albertel 8133:     
1.363     albertel 8134:     my $function = $args->{'function'} || &get_users_function();
                   8135:     my $domain   = $args->{'domain'}   || &determinedomain();
                   8136:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1075.2.52  raeburn  8137:     my $httphost = $args->{'use_absolute'};
1.418     albertel 8138:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 8139: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 8140: 		   #time(),
1.418     albertel 8141: 		   $env{'environment.color.timestamp'},
1.363     albertel 8142: 		   $function,$domain,$bgcolor);
                   8143: 
1.369     www      8144:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 8145: 
1.308     albertel 8146:     my $result =
                   8147: 	'<head>'.
1.1075.2.56  raeburn  8148: 	&font_settings($args);
1.319     albertel 8149: 
1.1075.2.72  raeburn  8150:     my $inhibitprint;
                   8151:     if ($args->{'print_suppress'}) {
                   8152:         $inhibitprint = &print_suppression();
                   8153:     }
1.1064    raeburn  8154: 
1.461     albertel 8155:     if (!$args->{'frameset'}) {
                   8156: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   8157:     }
1.1075.2.12  raeburn  8158:     if ($args->{'force_register'}) {
                   8159:         $result .= &Apache::lonmenu::registerurl(1);
1.319     albertel 8160:     }
1.436     albertel 8161:     if (!$args->{'no_nav_bar'} 
                   8162: 	&& !$args->{'only_body'}
                   8163: 	&& !$args->{'frameset'}) {
1.1075.2.52  raeburn  8164: 	$result .= &help_menu_js($httphost);
1.1032    www      8165:         $result.=&modal_window();
1.1038    www      8166:         $result.=&togglebox_script();
1.1034    www      8167:         $result.=&wishlist_window();
1.1041    www      8168:         $result.=&LCprogressbarUpdate_script();
1.1034    www      8169:     } else {
                   8170:         if ($args->{'add_modal'}) {
                   8171:            $result.=&modal_window();
                   8172:         }
                   8173:         if ($args->{'add_wishlist'}) {
                   8174:            $result.=&wishlist_window();
                   8175:         }
1.1038    www      8176:         if ($args->{'add_togglebox'}) {
                   8177:            $result.=&togglebox_script();
                   8178:         }
1.1041    www      8179:         if ($args->{'add_progressbar'}) {
                   8180:            $result.=&LCprogressbarUpdate_script();
                   8181:         }
1.436     albertel 8182:     }
1.314     albertel 8183:     if (ref($args->{'redirect'})) {
1.414     albertel 8184: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 8185: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 8186: 	if (!$inhibit_continue) {
                   8187: 	    $env{'internal.head.redirect'} = $url;
                   8188: 	}
1.313     albertel 8189: 	$result.=<<ADDMETA
                   8190: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 8191: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 8192: ADDMETA
1.1075.2.89  raeburn  8193:     } else {
                   8194:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
                   8195:             my $requrl = $env{'request.uri'};
                   8196:             if ($requrl eq '') {
                   8197:                 $requrl = $ENV{'REQUEST_URI'};
                   8198:                 $requrl =~ s/\?.+$//;
                   8199:             }
                   8200:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
                   8201:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
                   8202:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
                   8203:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
                   8204:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
                   8205:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1075.2.145  raeburn  8206:                     my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1075.2.151  raeburn  8207:                     my ($offload,$offloadoth);
1.1075.2.89  raeburn  8208:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
                   8209:                         if ($domdefs{'offloadnow'}{$lonhost}) {
1.1075.2.145  raeburn  8210:                             $offload = 1;
1.1075.2.151  raeburn  8211:                             if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8212:                                 (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8213:                                 unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8214:                                     $offloadoth = 1;
                   8215:                                     $dom_in_use = $env{'user.domain'};
                   8216:                                 }
                   8217:                             }
1.1075.2.145  raeburn  8218:                         }
                   8219:                     }
                   8220:                     unless ($offload) {
                   8221:                         if (ref($domdefs{'offloadoth'}) eq 'HASH') {
                   8222:                             if ($domdefs{'offloadoth'}{$lonhost}) {
                   8223:                                 if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8224:                                     (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8225:                                     unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8226:                                         $offload = 1;
1.1075.2.151  raeburn  8227:                                         $offloadoth = 1;
1.1075.2.145  raeburn  8228:                                         $dom_in_use = $env{'user.domain'};
                   8229:                                     }
1.1075.2.89  raeburn  8230:                                 }
1.1075.2.145  raeburn  8231:                             }
                   8232:                         }
                   8233:                     }
                   8234:                     if ($offload) {
1.1075.2.158  raeburn  8235:                         my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1075.2.151  raeburn  8236:                         if (($newserver eq '') && ($offloadoth)) {
                   8237:                             my @domains = &Apache::lonnet::current_machine_domains();
1.1075.2.161.  .1(raebu 8238:21):                             if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
1.1075.2.151  raeburn  8239:                                 ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
                   8240:                             }
                   8241:                         }
1.1075.2.145  raeburn  8242:                         if (($newserver) && ($newserver ne $lonhost)) {
                   8243:                             my $numsec = 5;
                   8244:                             my $timeout = $numsec * 1000;
                   8245:                             my ($newurl,$locknum,%locks,$msg);
                   8246:                             if ($env{'request.role.adv'}) {
                   8247:                                 ($locknum,%locks) = &Apache::lonnet::get_locks();
                   8248:                             }
                   8249:                             my $disable_submit = 0;
                   8250:                             if ($requrl =~ /$LONCAPA::assess_re/) {
                   8251:                                 $disable_submit = 1;
                   8252:                             }
                   8253:                             if ($locknum) {
                   8254:                                 my @lockinfo = sort(values(%locks));
1.1075.2.153  raeburn  8255:                                 $msg = &mt('Once the following tasks are complete:')." \n".
1.1075.2.145  raeburn  8256:                                        join(", ",sort(values(%locks)))."\n";
                   8257:                                 if (&show_course()) {
                   8258:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
1.1075.2.89  raeburn  8259:                                 } else {
1.1075.2.145  raeburn  8260:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
                   8261:                                 }
                   8262:                             } else {
                   8263:                                 if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
                   8264:                                     $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
                   8265:                                 }
                   8266:                                 $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
                   8267:                                 $newurl = '/adm/switchserver?otherserver='.$newserver;
                   8268:                                 if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
                   8269:                                     $newurl .= '&role='.$env{'request.role'};
                   8270:                                 }
                   8271:                                 if ($env{'request.symb'}) {
                   8272:                                     my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
                   8273:                                     if ($shownsymb =~ m{^/enc/}) {
                   8274:                                         my $reqdmajor = 2;
                   8275:                                         my $reqdminor = 11;
                   8276:                                         my $reqdsubminor = 3;
                   8277:                                         my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
                   8278:                                         my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
                   8279:                                         my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
                   8280:                                         if (($major eq '' && $minor eq '') ||
                   8281:                                             (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
                   8282:                                             (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
                   8283:                                              ($reqdsubminor > $subminor))))) {
                   8284:                                             undef($shownsymb);
                   8285:                                         }
1.1075.2.89  raeburn  8286:                                     }
1.1075.2.145  raeburn  8287:                                     if ($shownsymb) {
                   8288:                                         &js_escape(\$shownsymb);
                   8289:                                         $newurl .= '&symb='.$shownsymb;
1.1075.2.89  raeburn  8290:                                     }
1.1075.2.145  raeburn  8291:                                 } else {
                   8292:                                     my $shownurl = &Apache::lonenc::check_encrypt($requrl);
                   8293:                                     &js_escape(\$shownurl);
                   8294:                                     $newurl .= '&origurl='.$shownurl;
1.1075.2.89  raeburn  8295:                                 }
1.1075.2.145  raeburn  8296:                             }
                   8297:                             &js_escape(\$msg);
                   8298:                             $result.=<<OFFLOAD
1.1075.2.89  raeburn  8299: <meta http-equiv="pragma" content="no-cache" />
                   8300: <script type="text/javascript">
1.1075.2.92  raeburn  8301: // <![CDATA[
1.1075.2.89  raeburn  8302: function LC_Offload_Now() {
                   8303:     var dest = "$newurl";
                   8304:     if (dest != '') {
                   8305:         window.location.href="$newurl";
                   8306:     }
                   8307: }
1.1075.2.92  raeburn  8308: \$(document).ready(function () {
                   8309:     window.alert('$msg');
                   8310:     if ($disable_submit) {
1.1075.2.89  raeburn  8311:         \$(".LC_hwk_submit").prop("disabled", true);
                   8312:         \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1075.2.92  raeburn  8313:     }
                   8314:     setTimeout('LC_Offload_Now()', $timeout);
                   8315: });
                   8316: // ]]>
1.1075.2.89  raeburn  8317: </script>
                   8318: OFFLOAD
                   8319:                         }
                   8320:                     }
                   8321:                 }
                   8322:             }
                   8323:         }
1.313     albertel 8324:     }
1.306     albertel 8325:     if (!defined($title)) {
                   8326: 	$title = 'The LearningOnline Network with CAPA';
                   8327:     }
1.460     albertel 8328:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   8329:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.1075.2.61  raeburn  8330: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'"';
                   8331:     if (!$args->{'frameset'}) {
                   8332:         $result .= ' /';
                   8333:     }
                   8334:     $result .= '>'
1.1064    raeburn  8335:         .$inhibitprint
1.414     albertel 8336: 	.$head_extra;
1.1075.2.108  raeburn  8337:     my $clientmobile;
                   8338:     if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   8339:         (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
                   8340:     } else {
                   8341:         $clientmobile = $env{'browser.mobile'};
                   8342:     }
                   8343:     if ($clientmobile) {
1.1075.2.42  raeburn  8344:         $result .= '
                   8345: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
                   8346: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   8347:     }
1.1075.2.126  raeburn  8348:     $result .= '<meta name="google" content="notranslate" />'."\n";
1.962     droeschl 8349:     return $result.'</head>';
1.306     albertel 8350: }
                   8351: 
                   8352: =pod
                   8353: 
1.340     albertel 8354: =item * &font_settings()
                   8355: 
                   8356: Returns neccessary <meta> to set the proper encoding
                   8357: 
1.1075.2.56  raeburn  8358: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 8359: 
                   8360: =cut
                   8361: 
                   8362: sub font_settings {
1.1075.2.56  raeburn  8363:     my ($args) = @_;
1.340     albertel 8364:     my $headerstring='';
1.1075.2.56  raeburn  8365:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   8366:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.340     albertel 8367: 	$headerstring.=
1.1075.2.61  raeburn  8368: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   8369:         if (!$args->{'frameset'}) {
                   8370:             $headerstring.= ' /';
                   8371:         }
                   8372:         $headerstring .= '>'."\n";
1.340     albertel 8373:     }
                   8374:     return $headerstring;
                   8375: }
                   8376: 
1.341     albertel 8377: =pod
                   8378: 
1.1064    raeburn  8379: =item * &print_suppression()
                   8380: 
                   8381: In course context returns css which causes the body to be blank when media="print",
                   8382: if printout generation is unavailable for the current resource.
                   8383: 
                   8384: This could be because:
                   8385: 
                   8386: (a) printstartdate is in the future
                   8387: 
                   8388: (b) printenddate is in the past
                   8389: 
                   8390: (c) there is an active exam block with "printout"
                   8391: functionality blocked
                   8392: 
                   8393: Users with pav, pfo or evb privileges are exempt.
                   8394: 
                   8395: Inputs: none
                   8396: 
                   8397: =cut
                   8398: 
                   8399: 
                   8400: sub print_suppression {
                   8401:     my $noprint;
                   8402:     if ($env{'request.course.id'}) {
                   8403:         my $scope = $env{'request.course.id'};
                   8404:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8405:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   8406:             return;
                   8407:         }
                   8408:         if ($env{'request.course.sec'} ne '') {
                   8409:             $scope .= "/$env{'request.course.sec'}";
                   8410:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8411:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  8412:                 return;
1.1064    raeburn  8413:             }
                   8414:         }
                   8415:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8416:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.158  raeburn  8417:         my $clientip = &Apache::lonnet::get_requestor_ip();
                   8418:         my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064    raeburn  8419:         if ($blocked) {
                   8420:             my $checkrole = "cm./$cdom/$cnum";
                   8421:             if ($env{'request.course.sec'} ne '') {
                   8422:                 $checkrole .= "/$env{'request.course.sec'}";
                   8423:             }
                   8424:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   8425:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   8426:                 $noprint = 1;
                   8427:             }
                   8428:         }
                   8429:         unless ($noprint) {
                   8430:             my $symb = &Apache::lonnet::symbread();
                   8431:             if ($symb ne '') {
                   8432:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   8433:                 if (ref($navmap)) {
                   8434:                     my $res = $navmap->getBySymb($symb);
                   8435:                     if (ref($res)) {
                   8436:                         if (!$res->resprintable()) {
                   8437:                             $noprint = 1;
                   8438:                         }
                   8439:                     }
                   8440:                 }
                   8441:             }
                   8442:         }
                   8443:         if ($noprint) {
                   8444:             return <<"ENDSTYLE";
                   8445: <style type="text/css" media="print">
                   8446:     body { display:none }
                   8447: </style>
                   8448: ENDSTYLE
                   8449:         }
                   8450:     }
                   8451:     return;
                   8452: }
                   8453: 
                   8454: =pod
                   8455: 
1.341     albertel 8456: =item * &xml_begin()
                   8457: 
                   8458: Returns the needed doctype and <html>
                   8459: 
                   8460: Inputs: none
                   8461: 
                   8462: =cut
                   8463: 
                   8464: sub xml_begin {
1.1075.2.61  raeburn  8465:     my ($is_frameset) = @_;
1.341     albertel 8466:     my $output='';
                   8467: 
                   8468:     if ($env{'browser.mathml'}) {
                   8469: 	$output='<?xml version="1.0"?>'
                   8470:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   8471: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   8472:             
                   8473: #	    .'<!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">] >'
                   8474: 	    .'<!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">'
                   8475:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   8476: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1075.2.61  raeburn  8477:     } elsif ($is_frameset) {
                   8478:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
                   8479:                 '<html>'."\n";
1.341     albertel 8480:     } else {
1.1075.2.61  raeburn  8481: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   8482:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 8483:     }
                   8484:     return $output;
                   8485: }
1.340     albertel 8486: 
                   8487: =pod
                   8488: 
1.306     albertel 8489: =item * &start_page()
                   8490: 
                   8491: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   8492: 
1.648     raeburn  8493: Inputs:
                   8494: 
                   8495: =over 4
                   8496: 
                   8497: $title - optional title for the page
                   8498: 
                   8499: $head_extra - optional extra HTML to incude inside the <head>
                   8500: 
                   8501: $args - additional optional args supported are:
                   8502: 
                   8503: =over 8
                   8504: 
                   8505:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 8506:                                     arg on
1.814     bisitz   8507:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  8508:              add_entries    -> additional attributes to add to the  <body>
                   8509:              domain         -> force to color decorate a page for a 
1.317     albertel 8510:                                     specific domain
1.648     raeburn  8511:              function       -> force usage of a specific rolish color
1.317     albertel 8512:                                     scheme
1.648     raeburn  8513:              redirect       -> see &headtag()
                   8514:              bgcolor        -> override the default page bg color
                   8515:              js_ready       -> return a string ready for being used in 
1.317     albertel 8516:                                     a javascript writeln
1.648     raeburn  8517:              html_encode    -> return a string ready for being used in 
1.320     albertel 8518:                                     a html attribute
1.648     raeburn  8519:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 8520:                                     $forcereg arg
1.648     raeburn  8521:              frameset       -> if true will start with a <frameset>
1.330     albertel 8522:                                     rather than <body>
1.648     raeburn  8523:              skip_phases    -> hash ref of 
1.338     albertel 8524:                                     head -> skip the <html><head> generation
                   8525:                                     body -> skip all <body> generation
1.1075.2.12  raeburn  8526:              no_inline_link -> if true and in remote mode, don't show the
                   8527:                                     'Switch To Inline Menu' link
1.648     raeburn  8528:              no_auto_mt_title -> prevent &mt()ing the title arg
1.867     kalberla 8529:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  8530:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1075.2.123  raeburn  8531:              bread_crumbs_nomenu -> if true will pass false as the value of $menulink
                   8532:                                     to lonhtmlcommon::breadcrumbs
1.1075.2.15  raeburn  8533:              group          -> includes the current group, if page is for a
                   8534:                                specific group
1.1075.2.133  raeburn  8535:              use_absolute   -> for request for external resource or syllabus, this
                   8536:                                will contain https://<hostname> if server uses
                   8537:                                https (as per hosts.tab), but request is for http
                   8538:              hostname       -> hostname, originally from $r->hostname(), (optional).
1.1075.2.158  raeburn  8539:              links_disabled -> Links in primary and secondary menus are disabled
                   8540:                                (Can enable them once page has loaded - see lonroles.pm
                   8541:                                for an example).
1.361     albertel 8542: 
1.648     raeburn  8543: =back
1.460     albertel 8544: 
1.648     raeburn  8545: =back
1.562     albertel 8546: 
1.306     albertel 8547: =cut
                   8548: 
                   8549: sub start_page {
1.309     albertel 8550:     my ($title,$head_extra,$args) = @_;
1.318     albertel 8551:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 8552: 
1.315     albertel 8553:     $env{'internal.start_page'}++;
1.1075.2.161.  .1(raebu 8554:21):     my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964     droeschl 8555: 
1.338     albertel 8556:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1075.2.62  raeburn  8557:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 8558:     }
1.1075.2.161.  .1(raebu 8559:21): 
                   8560:21):     if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
                   8561:21):         if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
                   8562:21):             unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
                   8563:21):                 $args->{'no_primary_menu'} = 1;
                   8564:21):             }
                   8565:21):             unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
                   8566:21):                 $args->{'no_inline_menu'} = 1;
                   8567:21):             }
                   8568:21):             if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
                   8569:21):                 map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
                   8570:21):             }
                   8571:21):         } else {
                   8572:21):             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8573:21):             my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
                   8574:21):             if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
                   8575:21):                 unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
                   8576:21):                     $args->{'no_primary_menu'} = 1;
                   8577:21):                 }
                   8578:21):                 unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
                   8579:21):                     $args->{'no_inline_menu'} = 1;
                   8580:21):                 }
                   8581:21):                 if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
                   8582:21):                     map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
                   8583:21):                 }
                   8584:21):             }
                   8585:21):         }
                   8586:21):         ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
                   8587:21):                                   $env{'course.'.$env{'request.course.id'}.'.domain'},
                   8588:21):                                   $env{'course.'.$env{'request.course.id'}.'.num'});
                   8589:21):     } elsif ($env{'request.course.id'}) {
                   8590:21):         my $expiretime=600;
                   8591:21):         if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
                   8592:21):             &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
                   8593:21):         }
                   8594:21):         my ($deeplinkmenu,$menuref);
                   8595:21):         ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
                   8596:21):         if ($menucoll) {
                   8597:21):             if (ref($menuref) eq 'HASH') {
                   8598:21):                 %menu = %{$menuref};
                   8599:21):             }
                   8600:21):             if ($menu{'top'} eq 'n') {
                   8601:21):                 $args->{'no_primary_menu'} = 1;
                   8602:21):             }
                   8603:21):             if ($menu{'inline'} eq 'n') {
                   8604:21):                 unless (&Apache::lonnet::allowed('opa')) {
                   8605:21):                     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8606:21):                     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   8607:21):                     my $crstype = &course_type();
                   8608:21):                     my $now = time;
                   8609:21):                     my $ccrole;
                   8610:21):                     if ($crstype eq 'Community') {
                   8611:21):                         $ccrole = 'co';
                   8612:21):                     } else {
                   8613:21):                         $ccrole = 'cc';
                   8614:21):                     }
                   8615:21):                     if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
                   8616:21):                         my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
                   8617:21):                         if ((($start) && ($start<0)) ||
                   8618:21):                             (($end) && ($end<$now))  ||
                   8619:21):                             (($start) && ($now<$start))) {
                   8620:21):                             $args->{'no_inline_menu'} = 1;
                   8621:21):                         }
                   8622:21):                     } else {
                   8623:21):                         $args->{'no_inline_menu'} = 1;
                   8624:21):                     }
                   8625:21):                 }
                   8626:21):             }
                   8627:21):         }
                   8628:21):     }
1.338     albertel 8629:     
                   8630:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   8631: 	if ($args->{'frameset'}) {
                   8632: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   8633: 						$args->{'add_entries'});
                   8634: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   8635:         } else {
                   8636:             $result .=
                   8637:                 &bodytag($title, 
                   8638:                          $args->{'function'},       $args->{'add_entries'},
                   8639:                          $args->{'only_body'},      $args->{'domain'},
                   8640:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12  raeburn  8641:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
1.1075.2.161.  .1(raebu 8642:21):                          $args,                     \@advtools,
                   8643:21):                          $ltiscope,$ltiuri,\%ltimenu,$menucoll,\%menu);
1.831     bisitz   8644:         }
1.330     albertel 8645:     }
1.338     albertel 8646: 
1.315     albertel 8647:     if ($args->{'js_ready'}) {
1.713     kaisler  8648: 		$result = &js_ready($result);
1.315     albertel 8649:     }
1.320     albertel 8650:     if ($args->{'html_encode'}) {
1.713     kaisler  8651: 		$result = &html_encode($result);
                   8652:     }
                   8653: 
1.813     bisitz   8654:     # Preparation for new and consistent functionlist at top of screen
                   8655:     # if ($args->{'functionlist'}) {
                   8656:     #            $result .= &build_functionlist();
                   8657:     #}
                   8658: 
1.964     droeschl 8659:     # Don't add anything more if only_body wanted or in const space
                   8660:     return $result if    $args->{'only_body'} 
                   8661:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   8662: 
                   8663:     #Breadcrumbs
1.758     kaisler  8664:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   8665: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   8666: 		#if any br links exists, add them to the breadcrumbs
                   8667: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   8668: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   8669: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   8670: 			}
                   8671: 		}
1.1075.2.19  raeburn  8672:                 # if @advtools array contains items add then to the breadcrumbs
                   8673:                 if (@advtools > 0) {
                   8674:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   8675:                 }
1.1075.2.123  raeburn  8676:                 my $menulink;
                   8677:                 # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
1.1075.2.161.  .1(raebu 8678:21):                 if ((exists($args->{'bread_crumbs_nomenu'})) ||
                   8679:21):                     ($ltiscope eq 'map') || ($ltiscope eq 'resource')) {
1.1075.2.123  raeburn  8680:                     $menulink = 0;
                   8681:                 } else {
                   8682:                     undef($menulink);
                   8683:                 }
1.758     kaisler  8684: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   8685: 		if(exists($args->{'bread_crumbs_component'})){
1.1075.2.123  raeburn  8686: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.1075.2.161.  .1(raebu 8687:21): 		} else {
1.1075.2.123  raeburn  8688: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758     kaisler  8689: 		}
1.1075.2.24  raeburn  8690:     } elsif (($env{'environment.remote'} eq 'on') &&
                   8691:              ($env{'form.inhibitmenu'} ne 'yes') &&
                   8692:              ($env{'request.noversionuri'} =~ m{^/res/}) &&
                   8693:              ($env{'request.noversionuri'} !~ m{^/res/adm/pages/})) {
1.1075.2.21  raeburn  8694:         $result .= '<div style="padding:0;margin:0;clear:both"><hr /></div>';
1.320     albertel 8695:     }
1.315     albertel 8696:     return $result;
1.306     albertel 8697: }
                   8698: 
                   8699: sub end_page {
1.315     albertel 8700:     my ($args) = @_;
                   8701:     $env{'internal.end_page'}++;
1.330     albertel 8702:     my $result;
1.335     albertel 8703:     if ($args->{'discussion'}) {
                   8704: 	my ($target,$parser);
                   8705: 	if (ref($args->{'discussion'})) {
                   8706: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   8707: 				$args->{'discussion'}{'parser'});
                   8708: 	}
                   8709: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   8710:     }
1.330     albertel 8711:     if ($args->{'frameset'}) {
                   8712: 	$result .= '</frameset>';
                   8713:     } else {
1.635     raeburn  8714: 	$result .= &endbodytag($args);
1.330     albertel 8715:     }
1.1075.2.6  raeburn  8716:     unless ($args->{'notbody'}) {
                   8717:         $result .= "\n</html>";
                   8718:     }
1.330     albertel 8719: 
1.315     albertel 8720:     if ($args->{'js_ready'}) {
1.317     albertel 8721: 	$result = &js_ready($result);
1.315     albertel 8722:     }
1.335     albertel 8723: 
1.320     albertel 8724:     if ($args->{'html_encode'}) {
                   8725: 	$result = &html_encode($result);
                   8726:     }
1.335     albertel 8727: 
1.315     albertel 8728:     return $result;
                   8729: }
                   8730: 
1.1075.2.161.  .1(raebu 8731:21): sub menucoll_in_effect {
                   8732:21):     my ($menucoll,$deeplinkmenu,%menu);
                   8733:21):     if ($env{'request.course.id'}) {
                   8734:21):         $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
                   8735:21):         if ($env{'request.deeplink.login'}) {
                   8736:21):             my ($deeplink_symb,$deeplink,$check_login_symb);
                   8737:21):             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   8738:21):             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8739:21):             if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
                   8740:21):                 if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
                   8741:21):                     my $navmap = Apache::lonnavmaps::navmap->new();
                   8742:21):                     if (ref($navmap)) {
                   8743:21):                         $deeplink = $navmap->get_mapparam(undef,
                   8744:21):                                                           &Apache::lonnet::declutter($env{'request.noversionuri'}),
                   8745:21):                                                           '0.deeplink');
                   8746:21):                     } else {
                   8747:21):                         $check_login_symb = 1;
                   8748:21):                     }
                   8749:21):                 } else {
                   8750:21):                     my $symb=&Apache::lonnet::symbread();
                   8751:21):                     if ($symb) {
                   8752:21):                         $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
                   8753:21):                     } else {
                   8754:21):                         $check_login_symb = 1;
                   8755:21):                     }
                   8756:21):                 }
                   8757:21):             } else {
                   8758:21):                 $check_login_symb = 1;
                   8759:21):             }
                   8760:21):             if ($check_login_symb) {
                   8761:21):                 $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
                   8762:21):                 if ($deeplink_symb =~ /\.(page|sequence)$/) {
                   8763:21):                     my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
                   8764:21):                     my $navmap = Apache::lonnavmaps::navmap->new();
                   8765:21):                     if (ref($navmap)) {
                   8766:21):                         $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
                   8767:21):                     }
                   8768:21):                 } else {
                   8769:21):                     $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
                   8770:21):                 }
                   8771:21):             }
                   8772:21):             if ($deeplink ne '') {
                   8773:21):                 my ($state,$others,$listed,$scope,$protect,$display) = split(/,/,$deeplink);
                   8774:21):                 if ($display =~ /^\d+$/) {
                   8775:21):                     $deeplinkmenu = 1;
                   8776:21):                     $menucoll = $display;
                   8777:21):                 }
                   8778:21):             }
                   8779:21):         }
                   8780:21):         if ($menucoll) {
                   8781:21):             %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
                   8782:21):         }
                   8783:21):     }
                   8784:21):     return ($menucoll,$deeplinkmenu,\%menu);
                   8785:21): }
                   8786:21): 
                   8787:21): sub deeplink_login_symb {
                   8788:21):     my ($cnum,$cdom) = @_;
                   8789:21):     my $login_symb;
                   8790:21):     if ($env{'request.deeplink.login'}) {
                   8791:21):         $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
                   8792:21):     }
                   8793:21):     return $login_symb;
                   8794:21): }
                   8795:21): 
                   8796:21): sub symb_from_tinyurl {
                   8797:21):     my ($url,$cnum,$cdom) = @_;
                   8798:21):     if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
                   8799:21):         my $key = $1;
                   8800:21):         my ($tinyurl,$login);
                   8801:21):         my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
                   8802:21):         if (defined($cached)) {
                   8803:21):             $tinyurl = $result;
                   8804:21):         } else {
                   8805:21):             my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
                   8806:21):             my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
                   8807:21):             if ($currtiny{$key} ne '') {
                   8808:21):                 $tinyurl = $currtiny{$key};
                   8809:21):                 &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
                   8810:21):             }
                   8811:21):         }
                   8812:21):         if ($tinyurl ne '') {
                   8813:21):             my ($cnumreq,$symb) = split(/\&/,$tinyurl);
                   8814:21):             if (wantarray) {
                   8815:21):                 return ($cnumreq,$symb);
                   8816:21):             } elsif ($cnumreq eq $cnum) {
                   8817:21):                 return $symb;
                   8818:21):             }
                   8819:21):         }
                   8820:21):     }
                   8821:21):     if (wantarray) {
                   8822:21):         return ();
                   8823:21):     } else {
                   8824:21):         return;
                   8825:21):     }
                   8826:21): }
                   8827:21): 
1.1034    www      8828: sub wishlist_window {
                   8829:     return(<<'ENDWISHLIST');
1.1046    raeburn  8830: <script type="text/javascript">
1.1034    www      8831: // <![CDATA[
                   8832: // <!-- BEGIN LON-CAPA Internal
                   8833: function set_wishlistlink(title, path) {
                   8834:     if (!title) {
                   8835:         title = document.title;
                   8836:         title = title.replace(/^LON-CAPA /,'');
                   8837:     }
1.1075.2.65  raeburn  8838:     title = encodeURIComponent(title);
1.1075.2.83  raeburn  8839:     title = title.replace("'","\\\'");
1.1034    www      8840:     if (!path) {
                   8841:         path = location.pathname;
                   8842:     }
1.1075.2.65  raeburn  8843:     path = encodeURIComponent(path);
1.1075.2.83  raeburn  8844:     path = path.replace("'","\\\'");
1.1034    www      8845:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   8846:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   8847: }
                   8848: // END LON-CAPA Internal -->
                   8849: // ]]>
                   8850: </script>
                   8851: ENDWISHLIST
                   8852: }
                   8853: 
1.1030    www      8854: sub modal_window {
                   8855:     return(<<'ENDMODAL');
1.1046    raeburn  8856: <script type="text/javascript">
1.1030    www      8857: // <![CDATA[
                   8858: // <!-- BEGIN LON-CAPA Internal
                   8859: var modalWindow = {
                   8860: 	parent:"body",
                   8861: 	windowId:null,
                   8862: 	content:null,
                   8863: 	width:null,
                   8864: 	height:null,
                   8865: 	close:function()
                   8866: 	{
                   8867: 	        $(".LCmodal-window").remove();
                   8868: 	        $(".LCmodal-overlay").remove();
                   8869: 	},
                   8870: 	open:function()
                   8871: 	{
                   8872: 		var modal = "";
                   8873: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   8874: 		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;\">";
                   8875: 		modal += this.content;
                   8876: 		modal += "</div>";	
                   8877: 
                   8878: 		$(this.parent).append(modal);
                   8879: 
                   8880: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   8881: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   8882: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   8883: 	}
                   8884: };
1.1075.2.42  raeburn  8885: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      8886: 	{
1.1075.2.119  raeburn  8887:                 source = source.replace(/'/g,"&#39;");
1.1030    www      8888: 		modalWindow.windowId = "myModal";
                   8889: 		modalWindow.width = width;
                   8890: 		modalWindow.height = height;
1.1075.2.80  raeburn  8891: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      8892: 		modalWindow.open();
1.1075.2.87  raeburn  8893: 	};
1.1030    www      8894: // END LON-CAPA Internal -->
                   8895: // ]]>
                   8896: </script>
                   8897: ENDMODAL
                   8898: }
                   8899: 
                   8900: sub modal_link {
1.1075.2.42  raeburn  8901:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      8902:     unless ($width) { $width=480; }
                   8903:     unless ($height) { $height=400; }
1.1031    www      8904:     unless ($scrolling) { $scrolling='yes'; }
1.1075.2.42  raeburn  8905:     unless ($transparency) { $transparency='true'; }
                   8906: 
1.1074    raeburn  8907:     my $target_attr;
                   8908:     if (defined($target)) {
                   8909:         $target_attr = 'target="'.$target.'"';
                   8910:     }
                   8911:     return <<"ENDLINK";
1.1075.2.143  raeburn  8912: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074    raeburn  8913: ENDLINK
1.1030    www      8914: }
                   8915: 
1.1032    www      8916: sub modal_adhoc_script {
1.1075.2.155  raeburn  8917:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
                   8918:     my $mathjax;
                   8919:     if ($possmathjax) {
                   8920:         $mathjax = <<'ENDJAX';
                   8921:                if (typeof MathJax == 'object') {
                   8922:                    MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
                   8923:                }
                   8924: ENDJAX
                   8925:     }
1.1032    www      8926:     return (<<ENDADHOC);
1.1046    raeburn  8927: <script type="text/javascript">
1.1032    www      8928: // <![CDATA[
                   8929:         var $funcname = function()
                   8930:         {
                   8931:                 modalWindow.windowId = "myModal";
                   8932:                 modalWindow.width = $width;
                   8933:                 modalWindow.height = $height;
                   8934:                 modalWindow.content = '$content';
                   8935:                 modalWindow.open();
1.1075.2.155  raeburn  8936:                 $mathjax
1.1032    www      8937:         };  
                   8938: // ]]>
                   8939: </script>
                   8940: ENDADHOC
                   8941: }
                   8942: 
1.1041    www      8943: sub modal_adhoc_inner {
1.1075.2.155  raeburn  8944:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041    www      8945:     my $innerwidth=$width-20;
                   8946:     $content=&js_ready(
1.1042    www      8947:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1075.2.42  raeburn  8948:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   8949:                  $content.
1.1041    www      8950:                  &end_scrollbox().
1.1075.2.42  raeburn  8951:                  &end_page()
1.1041    www      8952:              );
1.1075.2.155  raeburn  8953:     return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041    www      8954: }
                   8955: 
                   8956: sub modal_adhoc_window {
1.1075.2.155  raeburn  8957:     my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
                   8958:     return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041    www      8959:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   8960: }
                   8961: 
                   8962: sub modal_adhoc_launch {
                   8963:     my ($funcname,$width,$height,$content)=@_;
                   8964:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   8965: <script type="text/javascript">
                   8966: // <![CDATA[
                   8967: $funcname();
                   8968: // ]]>
                   8969: </script>
                   8970: ENDLAUNCH
                   8971: }
                   8972: 
                   8973: sub modal_adhoc_close {
                   8974:     return (<<ENDCLOSE);
                   8975: <script type="text/javascript">
                   8976: // <![CDATA[
                   8977: modalWindow.close();
                   8978: // ]]>
                   8979: </script>
                   8980: ENDCLOSE
                   8981: }
                   8982: 
1.1038    www      8983: sub togglebox_script {
                   8984:    return(<<ENDTOGGLE);
                   8985: <script type="text/javascript"> 
                   8986: // <![CDATA[
                   8987: function LCtoggleDisplay(id,hidetext,showtext) {
                   8988:    link = document.getElementById(id + "link").childNodes[0];
                   8989:    with (document.getElementById(id).style) {
                   8990:       if (display == "none" ) {
                   8991:           display = "inline";
                   8992:           link.nodeValue = hidetext;
                   8993:         } else {
                   8994:           display = "none";
                   8995:           link.nodeValue = showtext;
                   8996:        }
                   8997:    }
                   8998: }
                   8999: // ]]>
                   9000: </script>
                   9001: ENDTOGGLE
                   9002: }
                   9003: 
1.1039    www      9004: sub start_togglebox {
                   9005:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   9006:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   9007:     unless ($showtext) { $showtext=&mt('show'); }
                   9008:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   9009:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   9010:     return &start_data_table().
                   9011:            &start_data_table_header_row().
                   9012:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   9013:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   9014:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   9015:            &end_data_table_header_row().
                   9016:            '<tr id="'.$id.'" style="display:none""><td>';
                   9017: }
                   9018: 
                   9019: sub end_togglebox {
                   9020:     return '</td></tr>'.&end_data_table();
                   9021: }
                   9022: 
1.1041    www      9023: sub LCprogressbar_script {
1.1075.2.130  raeburn  9024:    my ($id,$number_to_do)=@_;
                   9025:    if ($number_to_do) {
                   9026:        return(<<ENDPROGRESS);
1.1041    www      9027: <script type="text/javascript">
                   9028: // <![CDATA[
1.1045    www      9029: \$('#progressbar$id').progressbar({
1.1041    www      9030:   value: 0,
                   9031:   change: function(event, ui) {
                   9032:     var newVal = \$(this).progressbar('option', 'value');
                   9033:     \$('.pblabel', this).text(LCprogressTxt);
                   9034:   }
                   9035: });
                   9036: // ]]>
                   9037: </script>
                   9038: ENDPROGRESS
1.1075.2.130  raeburn  9039:    } else {
                   9040:        return(<<ENDPROGRESS);
                   9041: <script type="text/javascript">
                   9042: // <![CDATA[
                   9043: \$('#progressbar$id').progressbar({
                   9044:   value: false,
                   9045:   create: function(event, ui) {
                   9046:     \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
                   9047:     \$('.ui-progressbar-overlay', this).css({'margin':'0'});
                   9048:   }
                   9049: });
                   9050: // ]]>
                   9051: </script>
                   9052: ENDPROGRESS
                   9053:    }
1.1041    www      9054: }
                   9055: 
                   9056: sub LCprogressbarUpdate_script {
                   9057:    return(<<ENDPROGRESSUPDATE);
                   9058: <style type="text/css">
                   9059: .ui-progressbar { position:relative; }
1.1075.2.130  raeburn  9060: .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      9061: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   9062: </style>
                   9063: <script type="text/javascript">
                   9064: // <![CDATA[
1.1045    www      9065: var LCprogressTxt='---';
                   9066: 
1.1075.2.130  raeburn  9067: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041    www      9068:    LCprogressTxt=progresstext;
1.1075.2.130  raeburn  9069:    if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
                   9070:        \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
                   9071:    } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
                   9072:        \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
                   9073:    } else {
                   9074:        \$('#progressbar'+id).progressbar('value',percent);
                   9075:    }
1.1041    www      9076: }
                   9077: // ]]>
                   9078: </script>
                   9079: ENDPROGRESSUPDATE
                   9080: }
                   9081: 
1.1042    www      9082: my $LClastpercent;
1.1045    www      9083: my $LCidcnt;
                   9084: my $LCcurrentid;
1.1042    www      9085: 
1.1041    www      9086: sub LCprogressbar {
1.1075.2.130  raeburn  9087:     my ($r,$number_to_do,$preamble)=@_;
1.1042    www      9088:     $LClastpercent=0;
1.1045    www      9089:     $LCidcnt++;
                   9090:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1075.2.130  raeburn  9091:     my ($starting,$content);
                   9092:     if ($number_to_do) {
                   9093:         $starting=&mt('Starting');
                   9094:         $content=(<<ENDPROGBAR);
                   9095: $preamble
1.1045    www      9096:   <div id="progressbar$LCcurrentid">
1.1041    www      9097:     <span class="pblabel">$starting</span>
                   9098:   </div>
                   9099: ENDPROGBAR
1.1075.2.130  raeburn  9100:     } else {
                   9101:         $starting=&mt('Loading...');
                   9102:         $LClastpercent='false';
                   9103:         $content=(<<ENDPROGBAR);
                   9104: $preamble
                   9105:   <div id="progressbar$LCcurrentid">
                   9106:       <div class="progress-label">$starting</div>
                   9107:   </div>
                   9108: ENDPROGBAR
                   9109:     }
                   9110:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041    www      9111: }
                   9112: 
                   9113: sub LCprogressbarUpdate {
1.1075.2.130  raeburn  9114:     my ($r,$val,$text,$number_to_do)=@_;
                   9115:     if ($number_to_do) {
                   9116:         unless ($val) { 
                   9117:             if ($LClastpercent) {
                   9118:                 $val=$LClastpercent;
                   9119:             } else {
                   9120:                 $val=0;
                   9121:             }
                   9122:         }
                   9123:         if ($val<0) { $val=0; }
                   9124:         if ($val>100) { $val=0; }
                   9125:         $LClastpercent=$val;
                   9126:         unless ($text) { $text=$val.'%'; }
                   9127:     } else {
                   9128:         $val = 'false';
1.1042    www      9129:     }
1.1041    www      9130:     $text=&js_ready($text);
1.1044    www      9131:     &r_print($r,<<ENDUPDATE);
1.1041    www      9132: <script type="text/javascript">
                   9133: // <![CDATA[
1.1075.2.130  raeburn  9134: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041    www      9135: // ]]>
                   9136: </script>
                   9137: ENDUPDATE
1.1035    www      9138: }
                   9139: 
1.1042    www      9140: sub LCprogressbarClose {
                   9141:     my ($r)=@_;
                   9142:     $LClastpercent=0;
1.1044    www      9143:     &r_print($r,<<ENDCLOSE);
1.1042    www      9144: <script type="text/javascript">
                   9145: // <![CDATA[
1.1045    www      9146: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      9147: // ]]>
                   9148: </script>
                   9149: ENDCLOSE
1.1044    www      9150: }
                   9151: 
                   9152: sub r_print {
                   9153:     my ($r,$to_print)=@_;
                   9154:     if ($r) {
                   9155:       $r->print($to_print);
                   9156:       $r->rflush();
                   9157:     } else {
                   9158:       print($to_print);
                   9159:     }
1.1042    www      9160: }
                   9161: 
1.320     albertel 9162: sub html_encode {
                   9163:     my ($result) = @_;
                   9164: 
1.322     albertel 9165:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 9166:     
                   9167:     return $result;
                   9168: }
1.1044    www      9169: 
1.317     albertel 9170: sub js_ready {
                   9171:     my ($result) = @_;
                   9172: 
1.323     albertel 9173:     $result =~ s/[\n\r]/ /xmsg;
                   9174:     $result =~ s/\\/\\\\/xmsg;
                   9175:     $result =~ s/'/\\'/xmsg;
1.372     albertel 9176:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 9177:     
                   9178:     return $result;
                   9179: }
                   9180: 
1.315     albertel 9181: sub validate_page {
                   9182:     if (  exists($env{'internal.start_page'})
1.316     albertel 9183: 	  &&     $env{'internal.start_page'} > 1) {
                   9184: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 9185: 				 $env{'internal.start_page'}.' '.
1.316     albertel 9186: 				 $ENV{'request.filename'});
1.315     albertel 9187:     }
                   9188:     if (  exists($env{'internal.end_page'})
1.316     albertel 9189: 	  &&     $env{'internal.end_page'} > 1) {
                   9190: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 9191: 				 $env{'internal.end_page'}.' '.
1.316     albertel 9192: 				 $env{'request.filename'});
1.315     albertel 9193:     }
                   9194:     if (     exists($env{'internal.start_page'})
                   9195: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 9196: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   9197: 				 $env{'request.filename'});
1.315     albertel 9198:     }
                   9199:     if (   ! exists($env{'internal.start_page'})
                   9200: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 9201: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   9202: 				 $env{'request.filename'});
1.315     albertel 9203:     }
1.306     albertel 9204: }
1.315     albertel 9205: 
1.996     www      9206: 
                   9207: sub start_scrollbox {
1.1075.2.56  raeburn  9208:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  9209:     unless ($outerwidth) { $outerwidth='520px'; }
                   9210:     unless ($width) { $width='500px'; }
                   9211:     unless ($height) { $height='200px'; }
1.1075    raeburn  9212:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  9213:     if ($id ne '') {
1.1075.2.42  raeburn  9214:         $table_id = ' id="table_'.$id.'"';
                   9215:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  9216:     }
1.1075    raeburn  9217:     if ($bgcolor ne '') {
                   9218:         $tdcol = "background-color: $bgcolor;";
                   9219:     }
1.1075.2.42  raeburn  9220:     my $nicescroll_js;
                   9221:     if ($env{'browser.mobile'}) {
                   9222:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   9223:     }
1.1075    raeburn  9224:     return <<"END";
1.1075.2.42  raeburn  9225: $nicescroll_js
                   9226: 
                   9227: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
1.1075.2.56  raeburn  9228: <div style="overflow:auto; width:$width; height:$height;"$div_id>
1.1075    raeburn  9229: END
1.996     www      9230: }
                   9231: 
                   9232: sub end_scrollbox {
1.1036    www      9233:     return '</div></td></tr></table>';
1.996     www      9234: }
                   9235: 
1.1075.2.42  raeburn  9236: sub nicescroll_javascript {
                   9237:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   9238:     my %options;
                   9239:     if (ref($cursor) eq 'HASH') {
                   9240:         %options = %{$cursor};
                   9241:     }
                   9242:     unless ($options{'railalign'} =~ /^left|right$/) {
                   9243:         $options{'railalign'} = 'left';
                   9244:     }
                   9245:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   9246:         my $function  = &get_users_function();
                   9247:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
                   9248:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   9249:             $options{'cursorcolor'} = '#00F';
                   9250:         }
                   9251:     }
                   9252:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   9253:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
                   9254:             $options{'cursoropacity'}='1.0';
                   9255:         }
                   9256:     } else {
                   9257:         $options{'cursoropacity'}='1.0';
                   9258:     }
                   9259:     if ($options{'cursorfixedheight'} eq 'none') {
                   9260:         delete($options{'cursorfixedheight'});
                   9261:     } else {
                   9262:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   9263:     }
                   9264:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   9265:         delete($options{'railoffset'});
                   9266:     }
                   9267:     my @niceoptions;
                   9268:     while (my($key,$value) = each(%options)) {
                   9269:         if ($value =~ /^\{.+\}$/) {
                   9270:             push(@niceoptions,$key.':'.$value);
                   9271:         } else {
                   9272:             push(@niceoptions,$key.':"'.$value.'"');
                   9273:         }
                   9274:     }
                   9275:     my $nicescroll_js = '
                   9276: $(document).ready(
                   9277:       function() {
                   9278:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   9279:       }
                   9280: );
                   9281: ';
                   9282:     if ($framecheck) {
                   9283:         $nicescroll_js .= '
                   9284: function expand_div(caller) {
                   9285:     if (top === self) {
                   9286:         document.getElementById("'.$id.'").style.width = "auto";
                   9287:         document.getElementById("'.$id.'").style.height = "auto";
                   9288:     } else {
                   9289:         try {
                   9290:             if (parent.frames) {
                   9291:                 if (parent.frames.length > 1) {
                   9292:                     var framesrc = parent.frames[1].location.href;
                   9293:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   9294:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   9295:                         document.getElementById("'.$id.'").style.width = "auto";
                   9296:                         document.getElementById("'.$id.'").style.height = "auto";
                   9297:                     }
                   9298:                 }
                   9299:             }
                   9300:         } catch (e) {
                   9301:             return;
                   9302:         }
                   9303:     }
                   9304:     return;
                   9305: }
                   9306: ';
                   9307:     }
                   9308:     if ($needjsready) {
                   9309:         $nicescroll_js = '
                   9310: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   9311:     } else {
                   9312:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   9313:     }
                   9314:     return $nicescroll_js;
                   9315: }
                   9316: 
1.318     albertel 9317: sub simple_error_page {
1.1075.2.49  raeburn  9318:     my ($r,$title,$msg,$args) = @_;
                   9319:     if (ref($args) eq 'HASH') {
                   9320:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
                   9321:     } else {
                   9322:         $msg = &mt($msg);
                   9323:     }
                   9324: 
1.318     albertel 9325:     my $page =
                   9326: 	&Apache::loncommon::start_page($title).
1.1075.2.49  raeburn  9327: 	'<p class="LC_error">'.$msg.'</p>'.
1.318     albertel 9328: 	&Apache::loncommon::end_page();
                   9329:     if (ref($r)) {
                   9330: 	$r->print($page);
1.327     albertel 9331: 	return;
1.318     albertel 9332:     }
                   9333:     return $page;
                   9334: }
1.347     albertel 9335: 
                   9336: {
1.610     albertel 9337:     my @row_count;
1.961     onken    9338: 
                   9339:     sub start_data_table_count {
                   9340:         unshift(@row_count, 0);
                   9341:         return;
                   9342:     }
                   9343: 
                   9344:     sub end_data_table_count {
                   9345:         shift(@row_count);
                   9346:         return;
                   9347:     }
                   9348: 
1.347     albertel 9349:     sub start_data_table {
1.1018    raeburn  9350: 	my ($add_class,$id) = @_;
1.422     albertel 9351: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  9352:         my $table_id;
                   9353:         if (defined($id)) {
                   9354:             $table_id = ' id="'.$id.'"';
                   9355:         }
1.961     onken    9356: 	&start_data_table_count();
1.1018    raeburn  9357: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 9358:     }
                   9359: 
                   9360:     sub end_data_table {
1.961     onken    9361: 	&end_data_table_count();
1.389     albertel 9362: 	return '</table>'."\n";;
1.347     albertel 9363:     }
                   9364: 
                   9365:     sub start_data_table_row {
1.974     wenzelju 9366: 	my ($add_class, $id) = @_;
1.610     albertel 9367: 	$row_count[0]++;
                   9368: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   9369: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 9370:         $id = (' id="'.$id.'"') unless ($id eq '');
                   9371:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 9372:     }
1.471     banghart 9373:     
                   9374:     sub continue_data_table_row {
1.974     wenzelju 9375: 	my ($add_class, $id) = @_;
1.610     albertel 9376: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 9377: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   9378:         $id = (' id="'.$id.'"') unless ($id eq '');
                   9379:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 9380:     }
1.347     albertel 9381: 
                   9382:     sub end_data_table_row {
1.389     albertel 9383: 	return '</tr>'."\n";;
1.347     albertel 9384:     }
1.367     www      9385: 
1.421     albertel 9386:     sub start_data_table_empty_row {
1.707     bisitz   9387: #	$row_count[0]++;
1.421     albertel 9388: 	return  '<tr class="LC_empty_row" >'."\n";;
                   9389:     }
                   9390: 
                   9391:     sub end_data_table_empty_row {
                   9392: 	return '</tr>'."\n";;
                   9393:     }
                   9394: 
1.367     www      9395:     sub start_data_table_header_row {
1.389     albertel 9396: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      9397:     }
                   9398: 
                   9399:     sub end_data_table_header_row {
1.389     albertel 9400: 	return '</tr>'."\n";;
1.367     www      9401:     }
1.890     droeschl 9402: 
                   9403:     sub data_table_caption {
                   9404:         my $caption = shift;
                   9405:         return "<caption class=\"LC_caption\">$caption</caption>";
                   9406:     }
1.347     albertel 9407: }
                   9408: 
1.548     albertel 9409: =pod
                   9410: 
                   9411: =item * &inhibit_menu_check($arg)
                   9412: 
                   9413: Checks for a inhibitmenu state and generates output to preserve it
                   9414: 
                   9415: Inputs:         $arg - can be any of
                   9416:                      - undef - in which case the return value is a string 
                   9417:                                to add  into arguments list of a uri
                   9418:                      - 'input' - in which case the return value is a HTML
                   9419:                                  <form> <input> field of type hidden to
                   9420:                                  preserve the value
                   9421:                      - a url - in which case the return value is the url with
                   9422:                                the neccesary cgi args added to preserve the
                   9423:                                inhibitmenu state
                   9424:                      - a ref to a url - no return value, but the string is
                   9425:                                         updated to include the neccessary cgi
                   9426:                                         args to preserve the inhibitmenu state
                   9427: 
                   9428: =cut
                   9429: 
                   9430: sub inhibit_menu_check {
                   9431:     my ($arg) = @_;
                   9432:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   9433:     if ($arg eq 'input') {
                   9434: 	if ($env{'form.inhibitmenu'}) {
                   9435: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   9436: 	} else {
                   9437: 	    return
                   9438: 	}
                   9439:     }
                   9440:     if ($env{'form.inhibitmenu'}) {
                   9441: 	if (ref($arg)) {
                   9442: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9443: 	} elsif ($arg eq '') {
                   9444: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   9445: 	} else {
                   9446: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9447: 	}
                   9448:     }
                   9449:     if (!ref($arg)) {
                   9450: 	return $arg;
                   9451:     }
                   9452: }
                   9453: 
1.251     albertel 9454: ###############################################
1.182     matthew  9455: 
                   9456: =pod
                   9457: 
1.549     albertel 9458: =back
                   9459: 
                   9460: =head1 User Information Routines
                   9461: 
                   9462: =over 4
                   9463: 
1.405     albertel 9464: =item * &get_users_function()
1.182     matthew  9465: 
                   9466: Used by &bodytag to determine the current users primary role.
                   9467: Returns either 'student','coordinator','admin', or 'author'.
                   9468: 
                   9469: =cut
                   9470: 
                   9471: ###############################################
                   9472: sub get_users_function {
1.815     tempelho 9473:     my $function = 'norole';
1.818     tempelho 9474:     if ($env{'request.role'}=~/^(st)/) {
                   9475:         $function='student';
                   9476:     }
1.907     raeburn  9477:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  9478:         $function='coordinator';
                   9479:     }
1.258     albertel 9480:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  9481:         $function='admin';
                   9482:     }
1.826     bisitz   9483:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  9484:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  9485:         $function='author';
                   9486:     }
                   9487:     return $function;
1.54      www      9488: }
1.99      www      9489: 
                   9490: ###############################################
                   9491: 
1.233     raeburn  9492: =pod
                   9493: 
1.821     raeburn  9494: =item * &show_course()
                   9495: 
                   9496: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   9497: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   9498: 
                   9499: Inputs:
                   9500: None
                   9501: 
                   9502: Outputs:
                   9503: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   9504: 
                   9505: =cut
                   9506: 
                   9507: ###############################################
                   9508: sub show_course {
                   9509:     my $course = !$env{'user.adv'};
                   9510:     if (!$env{'user.adv'}) {
                   9511:         foreach my $env (keys(%env)) {
                   9512:             next if ($env !~ m/^user\.priv\./);
                   9513:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   9514:                 $course = 0;
                   9515:                 last;
                   9516:             }
                   9517:         }
                   9518:     }
                   9519:     return $course;
                   9520: }
                   9521: 
                   9522: ###############################################
                   9523: 
                   9524: =pod
                   9525: 
1.542     raeburn  9526: =item * &check_user_status()
1.274     raeburn  9527: 
                   9528: Determines current status of supplied role for a
                   9529: specific user. Roles can be active, previous or future.
                   9530: 
                   9531: Inputs: 
                   9532: user's domain, user's username, course's domain,
1.375     raeburn  9533: course's number, optional section ID.
1.274     raeburn  9534: 
                   9535: Outputs:
                   9536: role status: active, previous or future. 
                   9537: 
                   9538: =cut
                   9539: 
                   9540: sub check_user_status {
1.412     raeburn  9541:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  9542:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1075.2.85  raeburn  9543:     my @uroles = keys(%userinfo);
1.274     raeburn  9544:     my $srchstr;
                   9545:     my $active_chk = 'none';
1.412     raeburn  9546:     my $now = time;
1.274     raeburn  9547:     if (@uroles > 0) {
1.908     raeburn  9548:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  9549:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   9550:         } else {
1.412     raeburn  9551:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   9552:         }
                   9553:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  9554:             my $role_end = 0;
                   9555:             my $role_start = 0;
                   9556:             $active_chk = 'active';
1.412     raeburn  9557:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   9558:                 $role_end = $1;
                   9559:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   9560:                     $role_start = $1;
1.274     raeburn  9561:                 }
                   9562:             }
                   9563:             if ($role_start > 0) {
1.412     raeburn  9564:                 if ($now < $role_start) {
1.274     raeburn  9565:                     $active_chk = 'future';
                   9566:                 }
                   9567:             }
                   9568:             if ($role_end > 0) {
1.412     raeburn  9569:                 if ($now > $role_end) {
1.274     raeburn  9570:                     $active_chk = 'previous';
                   9571:                 }
                   9572:             }
                   9573:         }
                   9574:     }
                   9575:     return $active_chk;
                   9576: }
                   9577: 
                   9578: ###############################################
                   9579: 
                   9580: =pod
                   9581: 
1.405     albertel 9582: =item * &get_sections()
1.233     raeburn  9583: 
                   9584: Determines all the sections for a course including
                   9585: sections with students and sections containing other roles.
1.419     raeburn  9586: Incoming parameters: 
                   9587: 
                   9588: 1. domain
                   9589: 2. course number 
                   9590: 3. reference to array containing roles for which sections should 
                   9591: be gathered (optional).
                   9592: 4. reference to array containing status types for which sections 
                   9593: should be gathered (optional).
                   9594: 
                   9595: If the third argument is undefined, sections are gathered for any role. 
                   9596: If the fourth argument is undefined, sections are gathered for any status.
                   9597: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  9598:  
1.374     raeburn  9599: Returns section hash (keys are section IDs, values are
                   9600: number of users in each section), subject to the
1.419     raeburn  9601: optional roles filter, optional status filter 
1.233     raeburn  9602: 
                   9603: =cut
                   9604: 
                   9605: ###############################################
                   9606: sub get_sections {
1.419     raeburn  9607:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 9608:     if (!defined($cdom) || !defined($cnum)) {
                   9609:         my $cid =  $env{'request.course.id'};
                   9610: 
                   9611: 	return if (!defined($cid));
                   9612: 
                   9613:         $cdom = $env{'course.'.$cid.'.domain'};
                   9614:         $cnum = $env{'course.'.$cid.'.num'};
                   9615:     }
                   9616: 
                   9617:     my %sectioncount;
1.419     raeburn  9618:     my $now = time;
1.240     albertel 9619: 
1.1075.2.33  raeburn  9620:     my $check_students = 1;
                   9621:     my $only_students = 0;
                   9622:     if (ref($possible_roles) eq 'ARRAY') {
                   9623:         if (grep(/^st$/,@{$possible_roles})) {
                   9624:             if (@{$possible_roles} == 1) {
                   9625:                 $only_students = 1;
                   9626:             }
                   9627:         } else {
                   9628:             $check_students = 0;
                   9629:         }
                   9630:     }
                   9631: 
                   9632:     if ($check_students) {
1.276     albertel 9633: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 9634: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   9635: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  9636:         my $start_index = &Apache::loncoursedata::CL_START();
                   9637:         my $end_index = &Apache::loncoursedata::CL_END();
                   9638:         my $status;
1.366     albertel 9639: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  9640: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   9641: 				                     $data->[$status_index],
                   9642:                                                      $data->[$start_index],
                   9643:                                                      $data->[$end_index]);
                   9644:             if ($stu_status eq 'Active') {
                   9645:                 $status = 'active';
                   9646:             } elsif ($end < $now) {
                   9647:                 $status = 'previous';
                   9648:             } elsif ($start > $now) {
                   9649:                 $status = 'future';
                   9650:             } 
                   9651: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   9652:                 if ((!defined($possible_status)) || (($status ne '') && 
                   9653:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   9654: 		    $sectioncount{$section}++;
                   9655:                 }
1.240     albertel 9656: 	    }
                   9657: 	}
                   9658:     }
1.1075.2.33  raeburn  9659:     if ($only_students) {
                   9660:         return %sectioncount;
                   9661:     }
1.240     albertel 9662:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9663:     foreach my $user (sort(keys(%courseroles))) {
                   9664: 	if ($user !~ /^(\w{2})/) { next; }
                   9665: 	my ($role) = ($user =~ /^(\w{2})/);
                   9666: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  9667: 	my ($section,$status);
1.240     albertel 9668: 	if ($role eq 'cr' &&
                   9669: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   9670: 	    $section=$1;
                   9671: 	}
                   9672: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   9673: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  9674:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   9675:         if ($end == -1 && $start == -1) {
                   9676:             next; #deleted role
                   9677:         }
                   9678:         if (!defined($possible_status)) { 
                   9679:             $sectioncount{$section}++;
                   9680:         } else {
                   9681:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   9682:                 $status = 'active';
                   9683:             } elsif ($end < $now) {
                   9684:                 $status = 'future';
                   9685:             } elsif ($start > $now) {
                   9686:                 $status = 'previous';
                   9687:             }
                   9688:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   9689:                 $sectioncount{$section}++;
                   9690:             }
                   9691:         }
1.233     raeburn  9692:     }
1.366     albertel 9693:     return %sectioncount;
1.233     raeburn  9694: }
                   9695: 
1.274     raeburn  9696: ###############################################
1.294     raeburn  9697: 
                   9698: =pod
1.405     albertel 9699: 
                   9700: =item * &get_course_users()
                   9701: 
1.275     raeburn  9702: Retrieves usernames:domains for users in the specified course
                   9703: with specific role(s), and access status. 
                   9704: 
                   9705: Incoming parameters:
1.277     albertel 9706: 1. course domain
                   9707: 2. course number
                   9708: 3. access status: users must have - either active, 
1.275     raeburn  9709: previous, future, or all.
1.277     albertel 9710: 4. reference to array of permissible roles
1.288     raeburn  9711: 5. reference to array of section restrictions (optional)
                   9712: 6. reference to results object (hash of hashes).
                   9713: 7. reference to optional userdata hash
1.609     raeburn  9714: 8. reference to optional statushash
1.630     raeburn  9715: 9. flag if privileged users (except those set to unhide in
                   9716:    course settings) should be excluded    
1.609     raeburn  9717: Keys of top level results hash are roles.
1.275     raeburn  9718: Keys of inner hashes are username:domain, with 
                   9719: values set to access type.
1.288     raeburn  9720: Optional userdata hash returns an array with arguments in the 
                   9721: same order as loncoursedata::get_classlist() for student data.
                   9722: 
1.609     raeburn  9723: Optional statushash returns
                   9724: 
1.288     raeburn  9725: Entries for end, start, section and status are blank because
                   9726: of the possibility of multiple values for non-student roles.
                   9727: 
1.275     raeburn  9728: =cut
1.405     albertel 9729: 
1.275     raeburn  9730: ###############################################
1.405     albertel 9731: 
1.275     raeburn  9732: sub get_course_users {
1.630     raeburn  9733:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  9734:     my %idx = ();
1.419     raeburn  9735:     my %seclists;
1.288     raeburn  9736: 
                   9737:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   9738:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   9739:     $idx{end} = &Apache::loncoursedata::CL_END();
                   9740:     $idx{start} = &Apache::loncoursedata::CL_START();
                   9741:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   9742:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   9743:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   9744:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   9745: 
1.290     albertel 9746:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 9747:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  9748:         my $now = time;
1.277     albertel 9749:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  9750:             my $match = 0;
1.412     raeburn  9751:             my $secmatch = 0;
1.419     raeburn  9752:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  9753:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  9754:             if ($section eq '') {
                   9755:                 $section = 'none';
                   9756:             }
1.291     albertel 9757:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9758:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9759:                     $secmatch = 1;
                   9760:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 9761:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9762:                         $secmatch = 1;
                   9763:                     }
                   9764:                 } else {  
1.419     raeburn  9765: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  9766: 		        $secmatch = 1;
                   9767:                     }
1.290     albertel 9768: 		}
1.412     raeburn  9769:                 if (!$secmatch) {
                   9770:                     next;
                   9771:                 }
1.419     raeburn  9772:             }
1.275     raeburn  9773:             if (defined($$types{'active'})) {
1.288     raeburn  9774:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  9775:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  9776:                     $match = 1;
1.275     raeburn  9777:                 }
                   9778:             }
                   9779:             if (defined($$types{'previous'})) {
1.609     raeburn  9780:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  9781:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  9782:                     $match = 1;
1.275     raeburn  9783:                 }
                   9784:             }
                   9785:             if (defined($$types{'future'})) {
1.609     raeburn  9786:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  9787:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  9788:                     $match = 1;
1.275     raeburn  9789:                 }
                   9790:             }
1.609     raeburn  9791:             if ($match) {
                   9792:                 push(@{$seclists{$student}},$section);
                   9793:                 if (ref($userdata) eq 'HASH') {
                   9794:                     $$userdata{$student} = $$classlist{$student};
                   9795:                 }
                   9796:                 if (ref($statushash) eq 'HASH') {
                   9797:                     $statushash->{$student}{'st'}{$section} = $status;
                   9798:                 }
1.288     raeburn  9799:             }
1.275     raeburn  9800:         }
                   9801:     }
1.412     raeburn  9802:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  9803:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9804:         my $now = time;
1.609     raeburn  9805:         my %displaystatus = ( previous => 'Expired',
                   9806:                               active   => 'Active',
                   9807:                               future   => 'Future',
                   9808:                             );
1.1075.2.36  raeburn  9809:         my (%nothide,@possdoms);
1.630     raeburn  9810:         if ($hidepriv) {
                   9811:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   9812:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   9813:                 if ($user !~ /:/) {
                   9814:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   9815:                 } else {
                   9816:                     $nothide{$user} = 1;
                   9817:                 }
                   9818:             }
1.1075.2.36  raeburn  9819:             my @possdoms = ($cdom);
                   9820:             if ($coursehash{'checkforpriv'}) {
                   9821:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   9822:             }
1.630     raeburn  9823:         }
1.439     raeburn  9824:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  9825:             my $match = 0;
1.412     raeburn  9826:             my $secmatch = 0;
1.439     raeburn  9827:             my $status;
1.412     raeburn  9828:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  9829:             $user =~ s/:$//;
1.439     raeburn  9830:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   9831:             if ($end == -1 || $start == -1) {
                   9832:                 next;
                   9833:             }
                   9834:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   9835:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  9836:                 my ($uname,$udom) = split(/:/,$user);
                   9837:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9838:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9839:                         $secmatch = 1;
                   9840:                     } elsif ($usec eq '') {
1.420     albertel 9841:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9842:                             $secmatch = 1;
                   9843:                         }
                   9844:                     } else {
                   9845:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   9846:                             $secmatch = 1;
                   9847:                         }
                   9848:                     }
                   9849:                     if (!$secmatch) {
                   9850:                         next;
                   9851:                     }
1.288     raeburn  9852:                 }
1.419     raeburn  9853:                 if ($usec eq '') {
                   9854:                     $usec = 'none';
                   9855:                 }
1.275     raeburn  9856:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  9857:                     if ($hidepriv) {
1.1075.2.36  raeburn  9858:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  9859:                             (!$nothide{$uname.':'.$udom})) {
                   9860:                             next;
                   9861:                         }
                   9862:                     }
1.503     raeburn  9863:                     if ($end > 0 && $end < $now) {
1.439     raeburn  9864:                         $status = 'previous';
                   9865:                     } elsif ($start > $now) {
                   9866:                         $status = 'future';
                   9867:                     } else {
                   9868:                         $status = 'active';
                   9869:                     }
1.277     albertel 9870:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  9871:                         if ($status eq $type) {
1.420     albertel 9872:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  9873:                                 push(@{$$users{$role}{$user}},$type);
                   9874:                             }
1.288     raeburn  9875:                             $match = 1;
                   9876:                         }
                   9877:                     }
1.419     raeburn  9878:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   9879:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   9880: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   9881:                         }
1.420     albertel 9882:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  9883:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   9884:                         }
1.609     raeburn  9885:                         if (ref($statushash) eq 'HASH') {
                   9886:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   9887:                         }
1.275     raeburn  9888:                     }
                   9889:                 }
                   9890:             }
                   9891:         }
1.290     albertel 9892:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  9893:             if ((defined($cdom)) && (defined($cnum))) {
                   9894:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   9895:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   9896:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  9897:                     next if ($owner eq '');
                   9898:                     my ($ownername,$ownerdom);
                   9899:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   9900:                         $ownername = $1;
                   9901:                         $ownerdom = $2;
                   9902:                     } else {
                   9903:                         $ownername = $owner;
                   9904:                         $ownerdom = $cdom;
                   9905:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  9906:                     }
                   9907:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 9908:                     if (defined($userdata) && 
1.609     raeburn  9909: 			!exists($$userdata{$owner})) {
                   9910: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   9911:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   9912:                             push(@{$seclists{$owner}},'none');
                   9913:                         }
                   9914:                         if (ref($statushash) eq 'HASH') {
                   9915:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  9916:                         }
1.290     albertel 9917: 		    }
1.279     raeburn  9918:                 }
                   9919:             }
                   9920:         }
1.419     raeburn  9921:         foreach my $user (keys(%seclists)) {
                   9922:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   9923:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   9924:         }
1.275     raeburn  9925:     }
                   9926:     return;
                   9927: }
                   9928: 
1.288     raeburn  9929: sub get_user_info {
                   9930:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 9931:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   9932: 	&plainname($uname,$udom,'lastname');
1.291     albertel 9933:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  9934:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  9935:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   9936:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  9937:     return;
                   9938: }
1.275     raeburn  9939: 
1.472     raeburn  9940: ###############################################
                   9941: 
                   9942: =pod
                   9943: 
                   9944: =item * &get_user_quota()
                   9945: 
1.1075.2.41  raeburn  9946: Retrieves quota assigned for storage of user files.
                   9947: Default is to report quota for portfolio files.
1.472     raeburn  9948: 
                   9949: Incoming parameters:
                   9950: 1. user's username
                   9951: 2. user's domain
1.1075.2.41  raeburn  9952: 3. quota name - portfolio, author, or course
                   9953:    (if no quota name provided, defaults to portfolio).
1.1075.2.59  raeburn  9954: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1075.2.42  raeburn  9955:    course
1.472     raeburn  9956: 
                   9957: Returns:
1.1075.2.58  raeburn  9958: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  9959: 2. (Optional) Type of setting: custom or default
                   9960:    (individually assigned or default for user's 
                   9961:    institutional status).
                   9962: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   9963:    or student - types as defined in localenroll::inst_usertypes 
                   9964:    for user's domain, which determines default quota for user.
                   9965: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  9966: 
                   9967: If a value has been stored in the user's environment, 
1.536     raeburn  9968: it will return that, otherwise it returns the maximal default
1.1075.2.41  raeburn  9969: defined for the user's institutional status(es) in the domain.
1.472     raeburn  9970: 
                   9971: =cut
                   9972: 
                   9973: ###############################################
                   9974: 
                   9975: 
                   9976: sub get_user_quota {
1.1075.2.42  raeburn  9977:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  9978:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  9979:     if (!defined($udom)) {
                   9980:         $udom = $env{'user.domain'};
                   9981:     }
                   9982:     if (!defined($uname)) {
                   9983:         $uname = $env{'user.name'};
                   9984:     }
                   9985:     if (($udom eq '' || $uname eq '') ||
                   9986:         ($udom eq 'public') && ($uname eq 'public')) {
                   9987:         $quota = 0;
1.536     raeburn  9988:         $quotatype = 'default';
                   9989:         $defquota = 0; 
1.472     raeburn  9990:     } else {
1.536     raeburn  9991:         my $inststatus;
1.1075.2.41  raeburn  9992:         if ($quotaname eq 'course') {
                   9993:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   9994:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   9995:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   9996:             } else {
                   9997:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   9998:                 $quota = $cenv{'internal.uploadquota'};
                   9999:             }
1.536     raeburn  10000:         } else {
1.1075.2.41  raeburn  10001:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   10002:                 if ($quotaname eq 'author') {
                   10003:                     $quota = $env{'environment.authorquota'};
                   10004:                 } else {
                   10005:                     $quota = $env{'environment.portfolioquota'};
                   10006:                 }
                   10007:                 $inststatus = $env{'environment.inststatus'};
                   10008:             } else {
                   10009:                 my %userenv = 
                   10010:                     &Apache::lonnet::get('environment',['portfolioquota',
                   10011:                                          'authorquota','inststatus'],$udom,$uname);
                   10012:                 my ($tmp) = keys(%userenv);
                   10013:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10014:                     if ($quotaname eq 'author') {
                   10015:                         $quota = $userenv{'authorquota'};
                   10016:                     } else {
                   10017:                         $quota = $userenv{'portfolioquota'};
                   10018:                     }
                   10019:                     $inststatus = $userenv{'inststatus'};
                   10020:                 } else {
                   10021:                     undef(%userenv);
                   10022:                 }
                   10023:             }
                   10024:         }
                   10025:         if ($quota eq '' || wantarray) {
                   10026:             if ($quotaname eq 'course') {
                   10027:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1075.2.59  raeburn  10028:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
                   10029:                     ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1075.2.42  raeburn  10030:                     $defquota = $domdefs{$crstype.'quota'};
                   10031:                 }
                   10032:                 if ($defquota eq '') {
                   10033:                     $defquota = 500;
                   10034:                 }
1.1075.2.41  raeburn  10035:             } else {
                   10036:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   10037:             }
                   10038:             if ($quota eq '') {
                   10039:                 $quota = $defquota;
                   10040:                 $quotatype = 'default';
                   10041:             } else {
                   10042:                 $quotatype = 'custom';
                   10043:             }
1.472     raeburn  10044:         }
                   10045:     }
1.536     raeburn  10046:     if (wantarray) {
                   10047:         return ($quota,$quotatype,$settingstatus,$defquota);
                   10048:     } else {
                   10049:         return $quota;
                   10050:     }
1.472     raeburn  10051: }
                   10052: 
                   10053: ###############################################
                   10054: 
                   10055: =pod
                   10056: 
                   10057: =item * &default_quota()
                   10058: 
1.536     raeburn  10059: Retrieves default quota assigned for storage of user portfolio files,
                   10060: given an (optional) user's institutional status.
1.472     raeburn  10061: 
                   10062: Incoming parameters:
1.1075.2.42  raeburn  10063: 
1.472     raeburn  10064: 1. domain
1.536     raeburn  10065: 2. (Optional) institutional status(es).  This is a : separated list of 
                   10066:    status types (e.g., faculty, staff, student etc.)
                   10067:    which apply to the user for whom the default is being retrieved.
                   10068:    If the institutional status string in undefined, the domain
1.1075.2.41  raeburn  10069:    default quota will be returned.
                   10070: 3.  quota name - portfolio, author, or course
                   10071:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  10072: 
                   10073: Returns:
1.1075.2.42  raeburn  10074: 
1.1075.2.58  raeburn  10075: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  10076: 2. (Optional) institutional type which determined the value of the
                   10077:    default quota.
1.472     raeburn  10078: 
                   10079: If a value has been stored in the domain's configuration db,
                   10080: it will return that, otherwise it returns 20 (for backwards 
                   10081: compatibility with domains which have not set up a configuration
1.1075.2.58  raeburn  10082: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  10083: 
1.536     raeburn  10084: If the user's status includes multiple types (e.g., staff and student),
                   10085: the largest default quota which applies to the user determines the
                   10086: default quota returned.
                   10087: 
1.472     raeburn  10088: =cut
                   10089: 
                   10090: ###############################################
                   10091: 
                   10092: 
                   10093: sub default_quota {
1.1075.2.41  raeburn  10094:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  10095:     my ($defquota,$settingstatus);
                   10096:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  10097:                                             ['quotas'],$udom);
1.1075.2.41  raeburn  10098:     my $key = 'defaultquota';
                   10099:     if ($quotaname eq 'author') {
                   10100:         $key = 'authorquota';
                   10101:     }
1.622     raeburn  10102:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  10103:         if ($inststatus ne '') {
1.765     raeburn  10104:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  10105:             foreach my $item (@statuses) {
1.1075.2.41  raeburn  10106:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   10107:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  10108:                         if ($defquota eq '') {
1.1075.2.41  raeburn  10109:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  10110:                             $settingstatus = $item;
1.1075.2.41  raeburn  10111:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   10112:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  10113:                             $settingstatus = $item;
                   10114:                         }
                   10115:                     }
1.1075.2.41  raeburn  10116:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  10117:                     if ($quotahash{'quotas'}{$item} ne '') {
                   10118:                         if ($defquota eq '') {
                   10119:                             $defquota = $quotahash{'quotas'}{$item};
                   10120:                             $settingstatus = $item;
                   10121:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   10122:                             $defquota = $quotahash{'quotas'}{$item};
                   10123:                             $settingstatus = $item;
                   10124:                         }
1.536     raeburn  10125:                     }
                   10126:                 }
                   10127:             }
                   10128:         }
                   10129:         if ($defquota eq '') {
1.1075.2.41  raeburn  10130:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   10131:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   10132:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  10133:                 $defquota = $quotahash{'quotas'}{'default'};
                   10134:             }
1.536     raeburn  10135:             $settingstatus = 'default';
1.1075.2.42  raeburn  10136:             if ($defquota eq '') {
                   10137:                 if ($quotaname eq 'author') {
                   10138:                     $defquota = 500;
                   10139:                 }
                   10140:             }
1.536     raeburn  10141:         }
                   10142:     } else {
                   10143:         $settingstatus = 'default';
1.1075.2.41  raeburn  10144:         if ($quotaname eq 'author') {
                   10145:             $defquota = 500;
                   10146:         } else {
                   10147:             $defquota = 20;
                   10148:         }
1.536     raeburn  10149:     }
                   10150:     if (wantarray) {
                   10151:         return ($defquota,$settingstatus);
1.472     raeburn  10152:     } else {
1.536     raeburn  10153:         return $defquota;
1.472     raeburn  10154:     }
                   10155: }
                   10156: 
1.1075.2.41  raeburn  10157: ###############################################
                   10158: 
                   10159: =pod
                   10160: 
1.1075.2.42  raeburn  10161: =item * &excess_filesize_warning()
1.1075.2.41  raeburn  10162: 
                   10163: Returns warning message if upload of file to authoring space, or copying
1.1075.2.42  raeburn  10164: of existing file within authoring space will cause quota for the authoring
                   10165: space to be exceeded.
                   10166: 
                   10167: Same, if upload of a file directly to a course/community via Course Editor
                   10168: will cause quota for uploaded content for the course to be exceeded.
1.1075.2.41  raeburn  10169: 
1.1075.2.61  raeburn  10170: Inputs: 7 
1.1075.2.42  raeburn  10171: 1. username or coursenum
1.1075.2.41  raeburn  10172: 2. domain
1.1075.2.42  raeburn  10173: 3. context ('author' or 'course')
1.1075.2.41  raeburn  10174: 4. filename of file for which action is being requested
                   10175: 5. filesize (kB) of file
                   10176: 6. action being taken: copy or upload.
1.1075.2.59  raeburn  10177: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1075.2.41  raeburn  10178: 
                   10179: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
                   10180:          otherwise return null.
                   10181: 
1.1075.2.42  raeburn  10182: =back
                   10183: 
1.1075.2.41  raeburn  10184: =cut
                   10185: 
1.1075.2.42  raeburn  10186: sub excess_filesize_warning {
1.1075.2.59  raeburn  10187:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1075.2.42  raeburn  10188:     my $current_disk_usage = 0;
1.1075.2.59  raeburn  10189:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1075.2.42  raeburn  10190:     if ($context eq 'author') {
                   10191:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   10192:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   10193:     } else {
                   10194:         foreach my $subdir ('docs','supplemental') {
                   10195:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   10196:         }
                   10197:     }
1.1075.2.41  raeburn  10198:     $disk_quota = int($disk_quota * 1000);
                   10199:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1075.2.69  raeburn  10200:         return '<p class="LC_warning">'.
1.1075.2.41  raeburn  10201:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1075.2.69  raeburn  10202:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   10203:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1075.2.41  raeburn  10204:                             $disk_quota,$current_disk_usage).
                   10205:                '</p>';
                   10206:     }
                   10207:     return;
                   10208: }
                   10209: 
                   10210: ###############################################
                   10211: 
                   10212: 
1.384     raeburn  10213: sub get_secgrprole_info {
                   10214:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   10215:     my %sections_count = &get_sections($cdom,$cnum);
                   10216:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   10217:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   10218:     my @groups = sort(keys(%curr_groups));
                   10219:     my $allroles = [];
                   10220:     my $rolehash;
                   10221:     my $accesshash = {
                   10222:                      active => 'Currently has access',
                   10223:                      future => 'Will have future access',
                   10224:                      previous => 'Previously had access',
                   10225:                   };
                   10226:     if ($needroles) {
                   10227:         $rolehash = {'all' => 'all'};
1.385     albertel 10228:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   10229: 	if (&Apache::lonnet::error(%user_roles)) {
                   10230: 	    undef(%user_roles);
                   10231: 	}
                   10232:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  10233:             my ($role)=split(/\:/,$item,2);
                   10234:             if ($role eq 'cr') { next; }
                   10235:             if ($role =~ /^cr/) {
                   10236:                 $$rolehash{$role} = (split('/',$role))[3];
                   10237:             } else {
                   10238:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   10239:             }
                   10240:         }
                   10241:         foreach my $key (sort(keys(%{$rolehash}))) {
                   10242:             push(@{$allroles},$key);
                   10243:         }
                   10244:         push (@{$allroles},'st');
                   10245:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   10246:     }
                   10247:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   10248: }
                   10249: 
1.555     raeburn  10250: sub user_picker {
1.1075.2.127  raeburn  10251:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  10252:     my $currdom = $dom;
1.1075.2.114  raeburn  10253:     my @alldoms = &Apache::lonnet::all_domains();
                   10254:     if (@alldoms == 1) {
                   10255:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   10256:                                                ['directorysrch'],$alldoms[0]);
                   10257:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   10258:         my $showdom = $domdesc;
                   10259:         if ($showdom eq '') {
                   10260:             $showdom = $dom;
                   10261:         }
                   10262:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   10263:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   10264:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   10265:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   10266:             }
                   10267:         }
                   10268:     }
1.555     raeburn  10269:     my %curr_selected = (
                   10270:                         srchin => 'dom',
1.580     raeburn  10271:                         srchby => 'lastname',
1.555     raeburn  10272:                       );
                   10273:     my $srchterm;
1.625     raeburn  10274:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  10275:         if ($srch->{'srchby'} ne '') {
                   10276:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   10277:         }
                   10278:         if ($srch->{'srchin'} ne '') {
                   10279:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   10280:         }
                   10281:         if ($srch->{'srchtype'} ne '') {
                   10282:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   10283:         }
                   10284:         if ($srch->{'srchdomain'} ne '') {
                   10285:             $currdom = $srch->{'srchdomain'};
                   10286:         }
                   10287:         $srchterm = $srch->{'srchterm'};
                   10288:     }
1.1075.2.98  raeburn  10289:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  10290:                     'usr'       => 'Search criteria',
1.563     raeburn  10291:                     'doma'      => 'Domain/institution to search',
1.558     albertel 10292:                     'uname'     => 'username',
                   10293:                     'lastname'  => 'last name',
1.555     raeburn  10294:                     'lastfirst' => 'last name, first name',
1.558     albertel 10295:                     'crs'       => 'in this course',
1.576     raeburn  10296:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 10297:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  10298:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 10299:                     'exact'     => 'is',
                   10300:                     'contains'  => 'contains',
1.569     raeburn  10301:                     'begins'    => 'begins with',
1.1075.2.98  raeburn  10302:                                        );
                   10303:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  10304:                     'youm'      => "You must include some text to search for.",
                   10305:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   10306:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   10307:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   10308:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   10309:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   10310:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   10311:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  10312:                                        );
1.1075.2.98  raeburn  10313:     &html_escape(\%html_lt);
                   10314:     &js_escape(\%js_lt);
1.1075.2.115  raeburn  10315:     my $domform;
1.1075.2.126  raeburn  10316:     my $allow_blank = 1;
1.1075.2.115  raeburn  10317:     if ($fixeddom) {
1.1075.2.126  raeburn  10318:         $allow_blank = 0;
                   10319:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1075.2.115  raeburn  10320:     } else {
1.1075.2.126  raeburn  10321:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1);
1.1075.2.115  raeburn  10322:     }
1.563     raeburn  10323:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  10324: 
                   10325:     my @srchins = ('crs','dom','alc','instd');
                   10326: 
                   10327:     foreach my $option (@srchins) {
                   10328:         # FIXME 'alc' option unavailable until 
                   10329:         #       loncreateuser::print_user_query_page()
                   10330:         #       has been completed.
                   10331:         next if ($option eq 'alc');
1.880     raeburn  10332:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  10333:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1075.2.127  raeburn  10334:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  10335:         if ($curr_selected{'srchin'} eq $option) {
                   10336:             $srchinsel .= ' 
1.1075.2.98  raeburn  10337:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  10338:         } else {
                   10339:             $srchinsel .= '
1.1075.2.98  raeburn  10340:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  10341:         }
1.555     raeburn  10342:     }
1.563     raeburn  10343:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  10344: 
                   10345:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  10346:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  10347:         if ($curr_selected{'srchby'} eq $option) {
                   10348:             $srchbysel .= '
1.1075.2.98  raeburn  10349:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  10350:         } else {
                   10351:             $srchbysel .= '
1.1075.2.98  raeburn  10352:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  10353:          }
                   10354:     }
                   10355:     $srchbysel .= "\n  </select>\n";
                   10356: 
                   10357:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  10358:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  10359:         if ($curr_selected{'srchtype'} eq $option) {
                   10360:             $srchtypesel .= '
1.1075.2.98  raeburn  10361:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  10362:         } else {
                   10363:             $srchtypesel .= '
1.1075.2.98  raeburn  10364:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  10365:         }
                   10366:     }
                   10367:     $srchtypesel .= "\n  </select>\n";
                   10368: 
1.558     albertel 10369:     my ($newuserscript,$new_user_create);
1.994     raeburn  10370:     my $context_dom = $env{'request.role.domain'};
                   10371:     if ($context eq 'requestcrs') {
                   10372:         if ($env{'form.coursedom'} ne '') { 
                   10373:             $context_dom = $env{'form.coursedom'};
                   10374:         }
                   10375:     }
1.556     raeburn  10376:     if ($forcenewuser) {
1.576     raeburn  10377:         if (ref($srch) eq 'HASH') {
1.994     raeburn  10378:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  10379:                 if ($cancreate) {
                   10380:                     $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>';
                   10381:                 } else {
1.799     bisitz   10382:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  10383:                     my %usertypetext = (
                   10384:                         official   => 'institutional',
                   10385:                         unofficial => 'non-institutional',
                   10386:                     );
1.799     bisitz   10387:                     $new_user_create = '<p class="LC_warning">'
                   10388:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   10389:                                       .' '
                   10390:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   10391:                                           ,'<a href="'.$helplink.'">','</a>')
                   10392:                                       .'</p><br />';
1.627     raeburn  10393:                 }
1.576     raeburn  10394:             }
                   10395:         }
                   10396: 
1.556     raeburn  10397:         $newuserscript = <<"ENDSCRIPT";
                   10398: 
1.570     raeburn  10399: function setSearch(createnew,callingForm) {
1.556     raeburn  10400:     if (createnew == 1) {
1.570     raeburn  10401:         for (var i=0; i<callingForm.srchby.length; i++) {
                   10402:             if (callingForm.srchby.options[i].value == 'uname') {
                   10403:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  10404:             }
                   10405:         }
1.570     raeburn  10406:         for (var i=0; i<callingForm.srchin.length; i++) {
                   10407:             if ( callingForm.srchin.options[i].value == 'dom') {
                   10408: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  10409:             }
                   10410:         }
1.570     raeburn  10411:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   10412:             if (callingForm.srchtype.options[i].value == 'exact') {
                   10413:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  10414:             }
                   10415:         }
1.570     raeburn  10416:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  10417:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  10418:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  10419:             }
                   10420:         }
                   10421:     }
                   10422: }
                   10423: ENDSCRIPT
1.558     albertel 10424: 
1.556     raeburn  10425:     }
                   10426: 
1.555     raeburn  10427:     my $output = <<"END_BLOCK";
1.556     raeburn  10428: <script type="text/javascript">
1.824     bisitz   10429: // <![CDATA[
1.570     raeburn  10430: function validateEntry(callingForm) {
1.558     albertel 10431: 
1.556     raeburn  10432:     var checkok = 1;
1.558     albertel 10433:     var srchin;
1.570     raeburn  10434:     for (var i=0; i<callingForm.srchin.length; i++) {
                   10435: 	if ( callingForm.srchin[i].checked ) {
                   10436: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 10437: 	}
                   10438:     }
                   10439: 
1.570     raeburn  10440:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   10441:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   10442:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   10443:     var srchterm =  callingForm.srchterm.value;
                   10444:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  10445:     var msg = "";
                   10446: 
                   10447:     if (srchterm == "") {
                   10448:         checkok = 0;
1.1075.2.98  raeburn  10449:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  10450:     }
                   10451: 
1.569     raeburn  10452:     if (srchtype== 'begins') {
                   10453:         if (srchterm.length < 2) {
                   10454:             checkok = 0;
1.1075.2.98  raeburn  10455:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  10456:         }
                   10457:     }
                   10458: 
1.556     raeburn  10459:     if (srchtype== 'contains') {
                   10460:         if (srchterm.length < 3) {
                   10461:             checkok = 0;
1.1075.2.98  raeburn  10462:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  10463:         }
                   10464:     }
                   10465:     if (srchin == 'instd') {
                   10466:         if (srchdomain == '') {
                   10467:             checkok = 0;
1.1075.2.98  raeburn  10468:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  10469:         }
                   10470:     }
                   10471:     if (srchin == 'dom') {
                   10472:         if (srchdomain == '') {
                   10473:             checkok = 0;
1.1075.2.98  raeburn  10474:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  10475:         }
                   10476:     }
                   10477:     if (srchby == 'lastfirst') {
                   10478:         if (srchterm.indexOf(",") == -1) {
                   10479:             checkok = 0;
1.1075.2.98  raeburn  10480:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  10481:         }
                   10482:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   10483:             checkok = 0;
1.1075.2.98  raeburn  10484:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  10485:         }
                   10486:     }
                   10487:     if (checkok == 0) {
1.1075.2.98  raeburn  10488:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  10489:         return;
                   10490:     }
                   10491:     if (checkok == 1) {
1.570     raeburn  10492:         callingForm.submit();
1.556     raeburn  10493:     }
                   10494: }
                   10495: 
                   10496: $newuserscript
                   10497: 
1.824     bisitz   10498: // ]]>
1.556     raeburn  10499: </script>
1.558     albertel 10500: 
                   10501: $new_user_create
                   10502: 
1.555     raeburn  10503: END_BLOCK
1.558     albertel 10504: 
1.876     raeburn  10505:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1075.2.98  raeburn  10506:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  10507:                $domform.
                   10508:                &Apache::lonhtmlcommon::row_closure().
1.1075.2.98  raeburn  10509:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  10510:                $srchbysel.
                   10511:                $srchtypesel. 
                   10512:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   10513:                $srchinsel.
                   10514:                &Apache::lonhtmlcommon::row_closure(1). 
                   10515:                &Apache::lonhtmlcommon::end_pick_box().
                   10516:                '<br />';
1.1075.2.114  raeburn  10517:     return ($output,1);
1.555     raeburn  10518: }
                   10519: 
1.612     raeburn  10520: sub user_rule_check {
1.615     raeburn  10521:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1075.2.99  raeburn  10522:     my ($response,%inst_response);
1.612     raeburn  10523:     if (ref($usershash) eq 'HASH') {
1.1075.2.99  raeburn  10524:         if (keys(%{$usershash}) > 1) {
                   10525:             my (%by_username,%by_id,%userdoms);
                   10526:             my $checkid;
1.612     raeburn  10527:             if (ref($checks) eq 'HASH') {
1.1075.2.99  raeburn  10528:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   10529:                     $checkid = 1;
                   10530:                 }
                   10531:             }
                   10532:             foreach my $user (keys(%{$usershash})) {
                   10533:                 my ($uname,$udom) = split(/:/,$user);
                   10534:                 if ($checkid) {
                   10535:                     if (ref($usershash->{$user}) eq 'HASH') {
                   10536:                         if ($usershash->{$user}->{'id'} ne '') {
                   10537:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
                   10538:                             $userdoms{$udom} = 1;
                   10539:                             if (ref($inst_results) eq 'HASH') {
                   10540:                                 $inst_results->{$uname.':'.$udom} = {};
                   10541:                             }
                   10542:                         }
                   10543:                     }
                   10544:                 } else {
                   10545:                     $by_username{$udom}{$uname} = 1;
                   10546:                     $userdoms{$udom} = 1;
                   10547:                     if (ref($inst_results) eq 'HASH') {
                   10548:                         $inst_results->{$uname.':'.$udom} = {};
                   10549:                     }
                   10550:                 }
                   10551:             }
                   10552:             foreach my $udom (keys(%userdoms)) {
                   10553:                 if (!$got_rules->{$udom}) {
                   10554:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10555:                                                              ['usercreation'],$udom);
                   10556:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10557:                         foreach my $item ('username','id') {
                   10558:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10559:                                 $$curr_rules{$udom}{$item} =
                   10560:                                     $domconfig{'usercreation'}{$item.'_rule'};
                   10561:                             }
                   10562:                         }
                   10563:                     }
                   10564:                     $got_rules->{$udom} = 1;
                   10565:                 }
                   10566:             }
                   10567:             if ($checkid) {
                   10568:                 foreach my $udom (keys(%by_id)) {
                   10569:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   10570:                     if ($outcome eq 'ok') {
                   10571:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   10572:                             my $uname = $by_id{$udom}{$id};
                   10573:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10574:                         }
                   10575:                         if (ref($results) eq 'HASH') {
                   10576:                             foreach my $uname (keys(%{$results})) {
                   10577:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   10578:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   10579:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10580:                                 }
                   10581:                             }
                   10582:                         }
                   10583:                     }
1.612     raeburn  10584:                 }
1.615     raeburn  10585:             } else {
1.1075.2.99  raeburn  10586:                 foreach my $udom (keys(%by_username)) {
                   10587:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   10588:                     if ($outcome eq 'ok') {
                   10589:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   10590:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10591:                         }
                   10592:                         if (ref($results) eq 'HASH') {
                   10593:                             foreach my $uname (keys(%{$results})) {
                   10594:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10595:                             }
                   10596:                         }
                   10597:                     }
                   10598:                 }
1.612     raeburn  10599:             }
1.1075.2.99  raeburn  10600:         } elsif (keys(%{$usershash}) == 1) {
                   10601:             my $user = (keys(%{$usershash}))[0];
                   10602:             my ($uname,$udom) = split(/:/,$user);
                   10603:             if (($udom ne '') && ($uname ne '')) {
                   10604:                 if (ref($usershash->{$user}) eq 'HASH') {
                   10605:                     if (ref($checks) eq 'HASH') {
                   10606:                         if (defined($checks->{'username'})) {
                   10607:                             ($inst_response{$user},%{$inst_results->{$user}}) =
                   10608:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   10609:                         } elsif (defined($checks->{'id'})) {
                   10610:                             if ($usershash->{$user}->{'id'} ne '') {
                   10611:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10612:                                     &Apache::lonnet::get_instuser($udom,undef,
                   10613:                                                                   $usershash->{$user}->{'id'});
                   10614:                             } else {
                   10615:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10616:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   10617:                             }
                   10618:                         }
                   10619:                     } else {
                   10620:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   10621:                             &Apache::lonnet::get_instuser($udom,$uname);
                   10622:                        return;
                   10623:                     }
                   10624:                     if (!$got_rules->{$udom}) {
                   10625:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10626:                                                                  ['usercreation'],$udom);
                   10627:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10628:                             foreach my $item ('username','id') {
                   10629:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10630:                                    $$curr_rules{$udom}{$item} =
                   10631:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   10632:                                 }
                   10633:                             }
1.585     raeburn  10634:                         }
1.1075.2.99  raeburn  10635:                         $got_rules->{$udom} = 1;
1.585     raeburn  10636:                     }
                   10637:                 }
1.1075.2.99  raeburn  10638:             } else {
                   10639:                 return;
                   10640:             }
                   10641:         } else {
                   10642:             return;
                   10643:         }
                   10644:         foreach my $user (keys(%{$usershash})) {
                   10645:             my ($uname,$udom) = split(/:/,$user);
                   10646:             next if (($udom eq '') || ($uname eq ''));
                   10647:             my $id;
                   10648:             if (ref($inst_results) eq 'HASH') {
                   10649:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   10650:                     $id = $inst_results->{$user}->{'id'};
                   10651:                 }
                   10652:             }
                   10653:             if ($id eq '') {
                   10654:                 if (ref($usershash->{$user})) {
                   10655:                     $id = $usershash->{$user}->{'id'};
                   10656:                 }
1.585     raeburn  10657:             }
1.612     raeburn  10658:             foreach my $item (keys(%{$checks})) {
                   10659:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   10660:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   10661:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1075.2.99  raeburn  10662:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   10663:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  10664:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   10665:                                 if ($rule_check{$rule}) {
                   10666:                                     $$rulematch{$user}{$item} = $rule;
1.1075.2.99  raeburn  10667:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  10668:                                         if (ref($inst_results) eq 'HASH') {
                   10669:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   10670:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   10671:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1075.2.99  raeburn  10672:                                                 } elsif ($item eq 'id') {
                   10673:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   10674:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   10675:                                                     }
1.615     raeburn  10676:                                                 }
1.612     raeburn  10677:                                             }
                   10678:                                         }
1.615     raeburn  10679:                                     }
                   10680:                                     last;
1.585     raeburn  10681:                                 }
                   10682:                             }
                   10683:                         }
                   10684:                     }
                   10685:                 }
                   10686:             }
                   10687:         }
                   10688:     }
1.612     raeburn  10689:     return;
                   10690: }
                   10691: 
                   10692: sub user_rule_formats {
                   10693:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   10694:     my %text = ( 
                   10695:                  'username' => 'Usernames',
                   10696:                  'id'       => 'IDs',
                   10697:                );
                   10698:     my $output;
                   10699:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   10700:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   10701:         if (@{$ruleorder} > 0) {
1.1075.2.20  raeburn  10702:             $output = '<br />'.
                   10703:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   10704:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   10705:                       ' <ul>';
1.612     raeburn  10706:             foreach my $rule (@{$ruleorder}) {
                   10707:                 if (ref($curr_rules) eq 'ARRAY') {
                   10708:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   10709:                         if (ref($rules->{$rule}) eq 'HASH') {
                   10710:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   10711:                                         $rules->{$rule}{'desc'}.'</li>';
                   10712:                         }
                   10713:                     }
                   10714:                 }
                   10715:             }
                   10716:             $output .= '</ul>';
                   10717:         }
                   10718:     }
                   10719:     return $output;
                   10720: }
                   10721: 
                   10722: sub instrule_disallow_msg {
1.615     raeburn  10723:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  10724:     my $response;
                   10725:     my %text = (
                   10726:                   item   => 'username',
                   10727:                   items  => 'usernames',
                   10728:                   match  => 'matches',
                   10729:                   do     => 'does',
                   10730:                   action => 'a username',
                   10731:                   one    => 'one',
                   10732:                );
                   10733:     if ($count > 1) {
                   10734:         $text{'item'} = 'usernames';
                   10735:         $text{'match'} ='match';
                   10736:         $text{'do'} = 'do';
                   10737:         $text{'action'} = 'usernames',
                   10738:         $text{'one'} = 'ones';
                   10739:     }
                   10740:     if ($checkitem eq 'id') {
                   10741:         $text{'items'} = 'IDs';
                   10742:         $text{'item'} = 'ID';
                   10743:         $text{'action'} = 'an ID';
1.615     raeburn  10744:         if ($count > 1) {
                   10745:             $text{'item'} = 'IDs';
                   10746:             $text{'action'} = 'IDs';
                   10747:         }
1.612     raeburn  10748:     }
1.674     bisitz   10749:     $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  10750:     if ($mode eq 'upload') {
                   10751:         if ($checkitem eq 'username') {
                   10752:             $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'}.");
                   10753:         } elsif ($checkitem eq 'id') {
1.674     bisitz   10754:             $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  10755:         }
1.669     raeburn  10756:     } elsif ($mode eq 'selfcreate') {
                   10757:         if ($checkitem eq 'id') {
                   10758:             $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.");
                   10759:         }
1.615     raeburn  10760:     } else {
                   10761:         if ($checkitem eq 'username') {
                   10762:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   10763:         } elsif ($checkitem eq 'id') {
                   10764:             $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.");
                   10765:         }
1.612     raeburn  10766:     }
                   10767:     return $response;
1.585     raeburn  10768: }
                   10769: 
1.624     raeburn  10770: sub personal_data_fieldtitles {
                   10771:     my %fieldtitles = &Apache::lonlocal::texthash (
                   10772:                         id => 'Student/Employee ID',
                   10773:                         permanentemail => 'E-mail address',
                   10774:                         lastname => 'Last Name',
                   10775:                         firstname => 'First Name',
                   10776:                         middlename => 'Middle Name',
                   10777:                         generation => 'Generation',
                   10778:                         gen => 'Generation',
1.765     raeburn  10779:                         inststatus => 'Affiliation',
1.624     raeburn  10780:                    );
                   10781:     return %fieldtitles;
                   10782: }
                   10783: 
1.642     raeburn  10784: sub sorted_inst_types {
                   10785:     my ($dom) = @_;
1.1075.2.70  raeburn  10786:     my ($usertypes,$order);
                   10787:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   10788:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   10789:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   10790:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   10791:     } else {
                   10792:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   10793:     }
1.642     raeburn  10794:     my $othertitle = &mt('All users');
                   10795:     if ($env{'request.course.id'}) {
1.668     raeburn  10796:         $othertitle  = &mt('Any users');
1.642     raeburn  10797:     }
                   10798:     my @types;
                   10799:     if (ref($order) eq 'ARRAY') {
                   10800:         @types = @{$order};
                   10801:     }
                   10802:     if (@types == 0) {
                   10803:         if (ref($usertypes) eq 'HASH') {
                   10804:             @types = sort(keys(%{$usertypes}));
                   10805:         }
                   10806:     }
                   10807:     if (keys(%{$usertypes}) > 0) {
                   10808:         $othertitle = &mt('Other users');
                   10809:     }
                   10810:     return ($othertitle,$usertypes,\@types);
                   10811: }
                   10812: 
1.645     raeburn  10813: sub get_institutional_codes {
1.1075.2.157  raeburn  10814:     my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645     raeburn  10815: # Get complete list of course sections to update
                   10816:     my @currsections = ();
                   10817:     my @currxlists = ();
1.1075.2.157  raeburn  10818:     my (%unclutteredsec,%unclutteredlcsec);
1.645     raeburn  10819:     my $coursecode = $$settings{'internal.coursecode'};
1.1075.2.157  raeburn  10820:     my $crskey = $crs.':'.$coursecode;
                   10821:     @{$unclutteredsec{$crskey}} = ();
                   10822:     @{$unclutteredlcsec{$crskey}} = ();
1.645     raeburn  10823: 
                   10824:     if ($$settings{'internal.sectionnums'} ne '') {
                   10825:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   10826:     }
                   10827: 
                   10828:     if ($$settings{'internal.crosslistings'} ne '') {
                   10829:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   10830:     }
                   10831: 
                   10832:     if (@currxlists > 0) {
1.1075.2.157  raeburn  10833:         foreach my $xl (@currxlists) {
                   10834:             if ($xl =~ /^([^:]+):(\w*)$/) {
1.645     raeburn  10835:                 unless (grep/^$1$/,@{$allcourses}) {
1.1075.2.119  raeburn  10836:                     push(@{$allcourses},$1);
1.645     raeburn  10837:                     $$LC_code{$1} = $2;
                   10838:                 }
                   10839:             }
                   10840:         }
                   10841:     }
1.1075.2.157  raeburn  10842: 
1.645     raeburn  10843:     if (@currsections > 0) {
1.1075.2.157  raeburn  10844:         foreach my $sec (@currsections) {
                   10845:             if ($sec =~ m/^(\w+):(\w*)$/ ) {
                   10846:                 my $instsec = $1;
1.645     raeburn  10847:                 my $lc_sec = $2;
1.1075.2.157  raeburn  10848:                 unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
                   10849:                     push(@{$unclutteredsec{$crskey}},$instsec);
                   10850:                     push(@{$unclutteredlcsec{$crskey}},$lc_sec);
                   10851:                 }
                   10852:             }
                   10853:         }
                   10854:     }
                   10855: 
                   10856:     if (@{$unclutteredsec{$crskey}} > 0) {
                   10857:         my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
                   10858:         if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
                   10859:             for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
                   10860:                 my $sec = $coursecode.$formattedsec{$crskey}[$i];
                   10861:                 unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1075.2.119  raeburn  10862:                     push(@{$allcourses},$sec);
1.1075.2.157  raeburn  10863:                     $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645     raeburn  10864:                 }
                   10865:             }
                   10866:         }
                   10867:     }
                   10868:     return;
                   10869: }
                   10870: 
1.971     raeburn  10871: sub get_standard_codeitems {
                   10872:     return ('Year','Semester','Department','Number','Section');
                   10873: }
                   10874: 
1.112     bowersj2 10875: =pod
                   10876: 
1.780     raeburn  10877: =head1 Slot Helpers
                   10878: 
                   10879: =over 4
                   10880: 
                   10881: =item * sorted_slots()
                   10882: 
1.1040    raeburn  10883: Sorts an array of slot names in order of an optional sort key,
                   10884: default sort is by slot start time (earliest first). 
1.780     raeburn  10885: 
                   10886: Inputs:
                   10887: 
                   10888: =over 4
                   10889: 
                   10890: slotsarr  - Reference to array of unsorted slot names.
                   10891: 
                   10892: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   10893: 
1.1040    raeburn  10894: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   10895: 
1.549     albertel 10896: =back
                   10897: 
1.780     raeburn  10898: Returns:
                   10899: 
                   10900: =over 4
                   10901: 
1.1040    raeburn  10902: sorted   - An array of slot names sorted by a specified sort key 
                   10903:            (default sort key is start time of the slot).
1.780     raeburn  10904: 
                   10905: =back
                   10906: 
                   10907: =cut
                   10908: 
                   10909: 
                   10910: sub sorted_slots {
1.1040    raeburn  10911:     my ($slotsarr,$slots,$sortkey) = @_;
                   10912:     if ($sortkey eq '') {
                   10913:         $sortkey = 'starttime';
                   10914:     }
1.780     raeburn  10915:     my @sorted;
                   10916:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   10917:         @sorted =
                   10918:             sort {
                   10919:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  10920:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  10921:                      }
                   10922:                      if (ref($slots->{$a})) { return -1;}
                   10923:                      if (ref($slots->{$b})) { return 1;}
                   10924:                      return 0;
                   10925:                  } @{$slotsarr};
                   10926:     }
                   10927:     return @sorted;
                   10928: }
                   10929: 
1.1040    raeburn  10930: =pod
                   10931: 
                   10932: =item * get_future_slots()
                   10933: 
                   10934: Inputs:
                   10935: 
                   10936: =over 4
                   10937: 
                   10938: cnum - course number
                   10939: 
                   10940: cdom - course domain
                   10941: 
                   10942: now - current UNIX time
                   10943: 
                   10944: symb - optional symb
                   10945: 
                   10946: =back
                   10947: 
                   10948: Returns:
                   10949: 
                   10950: =over 4
                   10951: 
                   10952: sorted_reservable - ref to array of student_schedulable slots currently 
                   10953:                     reservable, ordered by end date of reservation period.
                   10954: 
                   10955: reservable_now - ref to hash of student_schedulable slots currently
                   10956:                  reservable.
                   10957: 
                   10958:     Keys in inner hash are:
                   10959:     (a) symb: either blank or symb to which slot use is restricted.
1.1075.2.104  raeburn  10960:     (b) endreserve: end date of reservation period.
                   10961:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10962:         selected.
1.1040    raeburn  10963: 
                   10964: sorted_future - ref to array of student_schedulable slots reservable in
                   10965:                 the future, ordered by start date of reservation period.
                   10966: 
                   10967: future_reservable - ref to hash of student_schedulable slots reservable
                   10968:                     in the future.
                   10969: 
                   10970:     Keys in inner hash are:
                   10971:     (a) symb: either blank or symb to which slot use is restricted.
                   10972:     (b) startreserve:  start date of reservation period.
1.1075.2.104  raeburn  10973:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10974:         selected.
1.1040    raeburn  10975: 
                   10976: =back
                   10977: 
                   10978: =cut
                   10979: 
                   10980: sub get_future_slots {
                   10981:     my ($cnum,$cdom,$now,$symb) = @_;
                   10982:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   10983:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   10984:     foreach my $slot (keys(%slots)) {
                   10985:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   10986:         if ($symb) {
                   10987:             next if (($slots{$slot}->{'symb'} ne '') && 
                   10988:                      ($slots{$slot}->{'symb'} ne $symb));
                   10989:         }
                   10990:         if (($slots{$slot}->{'starttime'} > $now) &&
                   10991:             ($slots{$slot}->{'endtime'} > $now)) {
                   10992:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   10993:                 my $userallowed = 0;
                   10994:                 if ($slots{$slot}->{'allowedsections'}) {
                   10995:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   10996:                     if (!defined($env{'request.role.sec'})
                   10997:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   10998:                         $userallowed=1;
                   10999:                     } else {
                   11000:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   11001:                             $userallowed=1;
                   11002:                         }
                   11003:                     }
                   11004:                     unless ($userallowed) {
                   11005:                         if (defined($env{'request.course.groups'})) {
                   11006:                             my @groups = split(/:/,$env{'request.course.groups'});
                   11007:                             foreach my $group (@groups) {
                   11008:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   11009:                                     $userallowed=1;
                   11010:                                     last;
                   11011:                                 }
                   11012:                             }
                   11013:                         }
                   11014:                     }
                   11015:                 }
                   11016:                 if ($slots{$slot}->{'allowedusers'}) {
                   11017:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   11018:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   11019:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   11020:                         $userallowed = 1;
                   11021:                     }
                   11022:                 }
                   11023:                 next unless($userallowed);
                   11024:             }
                   11025:             my $startreserve = $slots{$slot}->{'startreserve'};
                   11026:             my $endreserve = $slots{$slot}->{'endreserve'};
                   11027:             my $symb = $slots{$slot}->{'symb'};
1.1075.2.104  raeburn  11028:             my $uniqueperiod;
                   11029:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   11030:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   11031:             }
1.1040    raeburn  11032:             if (($startreserve < $now) &&
                   11033:                 (!$endreserve || $endreserve > $now)) {
                   11034:                 my $lastres = $endreserve;
                   11035:                 if (!$lastres) {
                   11036:                     $lastres = $slots{$slot}->{'starttime'};
                   11037:                 }
                   11038:                 $reservable_now{$slot} = {
                   11039:                                            symb       => $symb,
1.1075.2.104  raeburn  11040:                                            endreserve => $lastres,
                   11041:                                            uniqueperiod => $uniqueperiod,   
1.1040    raeburn  11042:                                          };
                   11043:             } elsif (($startreserve > $now) &&
                   11044:                      (!$endreserve || $endreserve > $startreserve)) {
                   11045:                 $future_reservable{$slot} = {
                   11046:                                               symb         => $symb,
1.1075.2.104  raeburn  11047:                                               startreserve => $startreserve,
                   11048:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  11049:                                             };
                   11050:             }
                   11051:         }
                   11052:     }
                   11053:     my @unsorted_reservable = keys(%reservable_now);
                   11054:     if (@unsorted_reservable > 0) {
                   11055:         @sorted_reservable = 
                   11056:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   11057:     }
                   11058:     my @unsorted_future = keys(%future_reservable);
                   11059:     if (@unsorted_future > 0) {
                   11060:         @sorted_future =
                   11061:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   11062:     }
                   11063:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   11064: }
1.780     raeburn  11065: 
                   11066: =pod
                   11067: 
1.1057    foxr     11068: =back
                   11069: 
1.549     albertel 11070: =head1 HTTP Helpers
                   11071: 
                   11072: =over 4
                   11073: 
1.648     raeburn  11074: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 11075: 
1.258     albertel 11076: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 11077: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 11078: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 11079: 
                   11080: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   11081: $possible_names is an ref to an array of form element names.  As an example:
                   11082: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 11083: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 11084: 
                   11085: =cut
1.1       albertel 11086: 
1.6       albertel 11087: sub get_unprocessed_cgi {
1.25      albertel 11088:   my ($query,$possible_names)= @_;
1.26      matthew  11089:   # $Apache::lonxml::debug=1;
1.356     albertel 11090:   foreach my $pair (split(/&/,$query)) {
                   11091:     my ($name, $value) = split(/=/,$pair);
1.369     www      11092:     $name = &unescape($name);
1.25      albertel 11093:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   11094:       $value =~ tr/+/ /;
                   11095:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 11096:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 11097:     }
1.16      harris41 11098:   }
1.6       albertel 11099: }
                   11100: 
1.112     bowersj2 11101: =pod
                   11102: 
1.648     raeburn  11103: =item * &cacheheader() 
1.112     bowersj2 11104: 
                   11105: returns cache-controlling header code
                   11106: 
                   11107: =cut
                   11108: 
1.7       albertel 11109: sub cacheheader {
1.258     albertel 11110:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 11111:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   11112:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 11113:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   11114:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 11115:     return $output;
1.7       albertel 11116: }
                   11117: 
1.112     bowersj2 11118: =pod
                   11119: 
1.648     raeburn  11120: =item * &no_cache($r) 
1.112     bowersj2 11121: 
                   11122: specifies header code to not have cache
                   11123: 
                   11124: =cut
                   11125: 
1.9       albertel 11126: sub no_cache {
1.216     albertel 11127:     my ($r) = @_;
                   11128:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 11129: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 11130:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   11131:     $r->no_cache(1);
                   11132:     $r->header_out("Expires" => $date);
                   11133:     $r->header_out("Pragma" => "no-cache");
1.123     www      11134: }
                   11135: 
                   11136: sub content_type {
1.181     albertel 11137:     my ($r,$type,$charset) = @_;
1.299     foxr     11138:     if ($r) {
                   11139: 	#  Note that printout.pl calls this with undef for $r.
                   11140: 	&no_cache($r);
                   11141:     }
1.258     albertel 11142:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 11143:     unless ($charset) {
                   11144: 	$charset=&Apache::lonlocal::current_encoding;
                   11145:     }
                   11146:     if ($charset) { $type.='; charset='.$charset; }
                   11147:     if ($r) {
                   11148: 	$r->content_type($type);
                   11149:     } else {
                   11150: 	print("Content-type: $type\n\n");
                   11151:     }
1.9       albertel 11152: }
1.25      albertel 11153: 
1.112     bowersj2 11154: =pod
                   11155: 
1.648     raeburn  11156: =item * &add_to_env($name,$value) 
1.112     bowersj2 11157: 
1.258     albertel 11158: adds $name to the %env hash with value
1.112     bowersj2 11159: $value, if $name already exists, the entry is converted to an array
                   11160: reference and $value is added to the array.
                   11161: 
                   11162: =cut
                   11163: 
1.25      albertel 11164: sub add_to_env {
                   11165:   my ($name,$value)=@_;
1.258     albertel 11166:   if (defined($env{$name})) {
                   11167:     if (ref($env{$name})) {
1.25      albertel 11168:       #already have multiple values
1.258     albertel 11169:       push(@{ $env{$name} },$value);
1.25      albertel 11170:     } else {
                   11171:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 11172:       my $first=$env{$name};
                   11173:       undef($env{$name});
                   11174:       push(@{ $env{$name} },$first,$value);
1.25      albertel 11175:     }
                   11176:   } else {
1.258     albertel 11177:     $env{$name}=$value;
1.25      albertel 11178:   }
1.31      albertel 11179: }
1.149     albertel 11180: 
                   11181: =pod
                   11182: 
1.648     raeburn  11183: =item * &get_env_multiple($name) 
1.149     albertel 11184: 
1.258     albertel 11185: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 11186: values may be defined and end up as an array ref.
                   11187: 
                   11188: returns an array of values
                   11189: 
                   11190: =cut
                   11191: 
                   11192: sub get_env_multiple {
                   11193:     my ($name) = @_;
                   11194:     my @values;
1.258     albertel 11195:     if (defined($env{$name})) {
1.149     albertel 11196:         # exists is it an array
1.258     albertel 11197:         if (ref($env{$name})) {
                   11198:             @values=@{ $env{$name} };
1.149     albertel 11199:         } else {
1.258     albertel 11200:             $values[0]=$env{$name};
1.149     albertel 11201:         }
                   11202:     }
                   11203:     return(@values);
                   11204: }
                   11205: 
1.660     raeburn  11206: sub ask_for_embedded_content {
                   11207:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  11208:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11  raeburn  11209:         %currsubfile,%unused,$rem);
1.1071    raeburn  11210:     my $counter = 0;
                   11211:     my $numnew = 0;
1.987     raeburn  11212:     my $numremref = 0;
                   11213:     my $numinvalid = 0;
                   11214:     my $numpathchg = 0;
                   11215:     my $numexisting = 0;
1.1071    raeburn  11216:     my $numunused = 0;
                   11217:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1075.2.53  raeburn  11218:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  11219:     my $heading = &mt('Upload embedded files');
                   11220:     my $buttontext = &mt('Upload');
                   11221: 
1.1075.2.11  raeburn  11222:     if ($env{'request.course.id'}) {
1.1075.2.35  raeburn  11223:         if ($actionurl eq '/adm/dependencies') {
                   11224:             $navmap = Apache::lonnavmaps::navmap->new();
                   11225:         }
                   11226:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   11227:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11  raeburn  11228:     }
1.1075.2.35  raeburn  11229:     if (($actionurl eq '/adm/portfolio') ||
                   11230:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  11231:         my $current_path='/';
                   11232:         if ($env{'form.currentpath'}) {
                   11233:             $current_path = $env{'form.currentpath'};
                   11234:         }
                   11235:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35  raeburn  11236:             $udom = $cdom;
                   11237:             $uname = $cnum;
1.984     raeburn  11238:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   11239:         } else {
                   11240:             $udom = $env{'user.domain'};
                   11241:             $uname = $env{'user.name'};
                   11242:             $url = '/userfiles/portfolio';
                   11243:         }
1.987     raeburn  11244:         $toplevel = $url.'/';
1.984     raeburn  11245:         $url .= $current_path;
                   11246:         $getpropath = 1;
1.987     raeburn  11247:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   11248:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      11249:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  11250:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  11251:         $toplevel = $url;
1.984     raeburn  11252:         if ($rest ne '') {
1.987     raeburn  11253:             $url .= $rest;
                   11254:         }
                   11255:     } elsif ($actionurl eq '/adm/coursedocs') {
                   11256:         if (ref($args) eq 'HASH') {
1.1071    raeburn  11257:             $url = $args->{'docs_url'};
                   11258:             $toplevel = $url;
1.1075.2.11  raeburn  11259:             if ($args->{'context'} eq 'paste') {
                   11260:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   11261:                 ($path) =
                   11262:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   11263:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   11264:                 $fileloc =~ s{^/}{};
                   11265:             }
1.1071    raeburn  11266:         }
                   11267:     } elsif ($actionurl eq '/adm/dependencies') {
                   11268:         if ($env{'request.course.id'} ne '') {
                   11269:             if (ref($args) eq 'HASH') {
                   11270:                 $url = $args->{'docs_url'};
                   11271:                 $title = $args->{'docs_title'};
1.1075.2.35  raeburn  11272:                 $toplevel = $url;
                   11273:                 unless ($toplevel =~ m{^/}) {
                   11274:                     $toplevel = "/$url";
                   11275:                 }
1.1075.2.11  raeburn  11276:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35  raeburn  11277:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   11278:                     $path = $1;
                   11279:                 } else {
                   11280:                     ($path) =
                   11281:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   11282:                 }
1.1075.2.79  raeburn  11283:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   11284:                     $fileloc = $toplevel;
                   11285:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   11286:                     my ($udom,$uname,$fname) =
                   11287:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   11288:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   11289:                 } else {
                   11290:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   11291:                 }
1.1071    raeburn  11292:                 $fileloc =~ s{^/}{};
                   11293:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   11294:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   11295:             }
1.987     raeburn  11296:         }
1.1075.2.35  raeburn  11297:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   11298:         $udom = $cdom;
                   11299:         $uname = $cnum;
                   11300:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   11301:         $toplevel = $url;
                   11302:         $path = $url;
                   11303:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   11304:         $fileloc =~ s{^/}{};
                   11305:     }
                   11306:     foreach my $file (keys(%{$allfiles})) {
                   11307:         my $embed_file;
                   11308:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   11309:             $embed_file = $1;
                   11310:         } else {
                   11311:             $embed_file = $file;
                   11312:         }
1.1075.2.55  raeburn  11313:         my ($absolutepath,$cleaned_file);
                   11314:         if ($embed_file =~ m{^\w+://}) {
                   11315:             $cleaned_file = $embed_file;
1.1075.2.47  raeburn  11316:             $newfiles{$cleaned_file} = 1;
                   11317:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  11318:         } else {
1.1075.2.55  raeburn  11319:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  11320:             if ($embed_file =~ m{^/}) {
                   11321:                 $absolutepath = $embed_file;
                   11322:             }
1.1075.2.47  raeburn  11323:             if ($cleaned_file =~ m{/}) {
                   11324:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  11325:                 $path = &check_for_traversal($path,$url,$toplevel);
                   11326:                 my $item = $fname;
                   11327:                 if ($path ne '') {
                   11328:                     $item = $path.'/'.$fname;
                   11329:                     $subdependencies{$path}{$fname} = 1;
                   11330:                 } else {
                   11331:                     $dependencies{$item} = 1;
                   11332:                 }
                   11333:                 if ($absolutepath) {
                   11334:                     $mapping{$item} = $absolutepath;
                   11335:                 } else {
                   11336:                     $mapping{$item} = $embed_file;
                   11337:                 }
                   11338:             } else {
                   11339:                 $dependencies{$embed_file} = 1;
                   11340:                 if ($absolutepath) {
1.1075.2.47  raeburn  11341:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  11342:                 } else {
1.1075.2.47  raeburn  11343:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  11344:                 }
                   11345:             }
1.984     raeburn  11346:         }
                   11347:     }
1.1071    raeburn  11348:     my $dirptr = 16384;
1.984     raeburn  11349:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  11350:         $currsubfile{$path} = {};
1.1075.2.35  raeburn  11351:         if (($actionurl eq '/adm/portfolio') ||
                   11352:             ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  11353:             my ($sublistref,$listerror) =
                   11354:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   11355:             if (ref($sublistref) eq 'ARRAY') {
                   11356:                 foreach my $line (@{$sublistref}) {
                   11357:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  11358:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  11359:                 }
1.984     raeburn  11360:             }
1.987     raeburn  11361:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11362:             if (opendir(my $dir,$url.'/'.$path)) {
                   11363:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  11364:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   11365:             }
1.1075.2.11  raeburn  11366:         } elsif (($actionurl eq '/adm/dependencies') ||
                   11367:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11368:                   ($args->{'context'} eq 'paste')) ||
                   11369:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11370:             if ($env{'request.course.id'} ne '') {
1.1075.2.35  raeburn  11371:                 my $dir;
                   11372:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   11373:                     $dir = $fileloc;
                   11374:                 } else {
                   11375:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11376:                 }
1.1071    raeburn  11377:                 if ($dir ne '') {
                   11378:                     my ($sublistref,$listerror) =
                   11379:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   11380:                     if (ref($sublistref) eq 'ARRAY') {
                   11381:                         foreach my $line (@{$sublistref}) {
                   11382:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   11383:                                 undef,$mtime)=split(/\&/,$line,12);
                   11384:                             unless (($testdir&$dirptr) ||
                   11385:                                     ($file_name =~ /^\.\.?$/)) {
                   11386:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   11387:                             }
                   11388:                         }
                   11389:                     }
                   11390:                 }
1.984     raeburn  11391:             }
                   11392:         }
                   11393:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  11394:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  11395:                 my $item = $path.'/'.$file;
                   11396:                 unless ($mapping{$item} eq $item) {
                   11397:                     $pathchanges{$item} = 1;
                   11398:                 }
                   11399:                 $existing{$item} = 1;
                   11400:                 $numexisting ++;
                   11401:             } else {
                   11402:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  11403:             }
                   11404:         }
1.1071    raeburn  11405:         if ($actionurl eq '/adm/dependencies') {
                   11406:             foreach my $path (keys(%currsubfile)) {
                   11407:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   11408:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   11409:                          unless ($subdependencies{$path}{$file}) {
1.1075.2.11  raeburn  11410:                              next if (($rem ne '') &&
                   11411:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   11412:                                        (ref($navmap) &&
                   11413:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   11414:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11415:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  11416:                              $unused{$path.'/'.$file} = 1; 
                   11417:                          }
                   11418:                     }
                   11419:                 }
                   11420:             }
                   11421:         }
1.984     raeburn  11422:     }
1.987     raeburn  11423:     my %currfile;
1.1075.2.35  raeburn  11424:     if (($actionurl eq '/adm/portfolio') ||
                   11425:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  11426:         my ($dirlistref,$listerror) =
                   11427:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   11428:         if (ref($dirlistref) eq 'ARRAY') {
                   11429:             foreach my $line (@{$dirlistref}) {
                   11430:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   11431:                 $currfile{$file_name} = 1;
                   11432:             }
1.984     raeburn  11433:         }
1.987     raeburn  11434:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11435:         if (opendir(my $dir,$url)) {
1.987     raeburn  11436:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  11437:             map {$currfile{$_} = 1;} @dir_list;
                   11438:         }
1.1075.2.11  raeburn  11439:     } elsif (($actionurl eq '/adm/dependencies') ||
                   11440:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11441:               ($args->{'context'} eq 'paste')) ||
                   11442:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11443:         if ($env{'request.course.id'} ne '') {
                   11444:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11445:             if ($dir ne '') {
                   11446:                 my ($dirlistref,$listerror) =
                   11447:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   11448:                 if (ref($dirlistref) eq 'ARRAY') {
                   11449:                     foreach my $line (@{$dirlistref}) {
                   11450:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   11451:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   11452:                         unless (($testdir&$dirptr) ||
                   11453:                                 ($file_name =~ /^\.\.?$/)) {
                   11454:                             $currfile{$file_name} = [$size,$mtime];
                   11455:                         }
                   11456:                     }
                   11457:                 }
                   11458:             }
                   11459:         }
1.984     raeburn  11460:     }
                   11461:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  11462:         if (exists($currfile{$file})) {
1.987     raeburn  11463:             unless ($mapping{$file} eq $file) {
                   11464:                 $pathchanges{$file} = 1;
                   11465:             }
                   11466:             $existing{$file} = 1;
                   11467:             $numexisting ++;
                   11468:         } else {
1.984     raeburn  11469:             $newfiles{$file} = 1;
                   11470:         }
                   11471:     }
1.1071    raeburn  11472:     foreach my $file (keys(%currfile)) {
                   11473:         unless (($file eq $filename) ||
                   11474:                 ($file eq $filename.'.bak') ||
                   11475:                 ($dependencies{$file})) {
1.1075.2.11  raeburn  11476:             if ($actionurl eq '/adm/dependencies') {
1.1075.2.35  raeburn  11477:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   11478:                     next if (($rem ne '') &&
                   11479:                              (($env{"httpref.$rem".$file} ne '') ||
                   11480:                               (ref($navmap) &&
                   11481:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   11482:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11483:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   11484:                 }
1.1075.2.11  raeburn  11485:             }
1.1071    raeburn  11486:             $unused{$file} = 1;
                   11487:         }
                   11488:     }
1.1075.2.11  raeburn  11489:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   11490:         ($args->{'context'} eq 'paste')) {
                   11491:         $counter = scalar(keys(%existing));
                   11492:         $numpathchg = scalar(keys(%pathchanges));
                   11493:         return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35  raeburn  11494:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
                   11495:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   11496:         $counter = scalar(keys(%existing));
                   11497:         $numpathchg = scalar(keys(%pathchanges));
                   11498:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11  raeburn  11499:     }
1.984     raeburn  11500:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  11501:         if ($actionurl eq '/adm/dependencies') {
                   11502:             next if ($embed_file =~ m{^\w+://});
                   11503:         }
1.660     raeburn  11504:         $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11505:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  11506:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  11507:         unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35  raeburn  11508:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   11509:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  11510:         }
1.1075.2.35  raeburn  11511:         $upload_output .= '</td>';
1.1071    raeburn  11512:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1075.2.35  raeburn  11513:             $upload_output.='<td align="right">'.
                   11514:                             '<span class="LC_info LC_fontsize_medium">'.
                   11515:                             &mt("URL points to web address").'</span>';
1.987     raeburn  11516:             $numremref++;
1.660     raeburn  11517:         } elsif ($args->{'error_on_invalid_names'}
                   11518:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35  raeburn  11519:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   11520:                             &mt('Invalid characters').'</span>';
1.987     raeburn  11521:             $numinvalid++;
1.660     raeburn  11522:         } else {
1.1075.2.35  raeburn  11523:             $upload_output .= '<td>'.
                   11524:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  11525:                                                      $embed_file,\%mapping,
1.1071    raeburn  11526:                                                      $allfiles,$codebase,'upload');
                   11527:             $counter ++;
                   11528:             $numnew ++;
1.987     raeburn  11529:         }
                   11530:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   11531:     }
                   11532:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  11533:         if ($actionurl eq '/adm/dependencies') {
                   11534:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   11535:             $modify_output .= &start_data_table_row().
                   11536:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   11537:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   11538:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   11539:                               '<td>'.$size.'</td>'.
                   11540:                               '<td>'.$mtime.'</td>'.
                   11541:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   11542:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   11543:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   11544:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   11545:                               &embedded_file_element('upload_embedded',$counter,
                   11546:                                                      $embed_file,\%mapping,
                   11547:                                                      $allfiles,$codebase,'modify').
                   11548:                               '</div></td>'.
                   11549:                               &end_data_table_row()."\n";
                   11550:             $counter ++;
                   11551:         } else {
                   11552:             $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11553:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   11554:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   11555:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  11556:                               &Apache::loncommon::end_data_table_row()."\n";
                   11557:         }
                   11558:     }
                   11559:     my $delidx = $counter;
                   11560:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   11561:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   11562:         $delete_output .= &start_data_table_row().
                   11563:                           '<td><img src="'.&icon($oldfile).'" />'.
                   11564:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   11565:                           '<td>'.$size.'</td>'.
                   11566:                           '<td>'.$mtime.'</td>'.
                   11567:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   11568:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   11569:                           &embedded_file_element('upload_embedded',$delidx,
                   11570:                                                  $oldfile,\%mapping,$allfiles,
                   11571:                                                  $codebase,'delete').'</td>'.
                   11572:                           &end_data_table_row()."\n"; 
                   11573:         $numunused ++;
                   11574:         $delidx ++;
1.987     raeburn  11575:     }
                   11576:     if ($upload_output) {
                   11577:         $upload_output = &start_data_table().
                   11578:                          $upload_output.
                   11579:                          &end_data_table()."\n";
                   11580:     }
1.1071    raeburn  11581:     if ($modify_output) {
                   11582:         $modify_output = &start_data_table().
                   11583:                          &start_data_table_header_row().
                   11584:                          '<th>'.&mt('File').'</th>'.
                   11585:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11586:                          '<th>'.&mt('Modified').'</th>'.
                   11587:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   11588:                          &end_data_table_header_row().
                   11589:                          $modify_output.
                   11590:                          &end_data_table()."\n";
                   11591:     }
                   11592:     if ($delete_output) {
                   11593:         $delete_output = &start_data_table().
                   11594:                          &start_data_table_header_row().
                   11595:                          '<th>'.&mt('File').'</th>'.
                   11596:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11597:                          '<th>'.&mt('Modified').'</th>'.
                   11598:                          '<th>'.&mt('Delete?').'</th>'.
                   11599:                          &end_data_table_header_row().
                   11600:                          $delete_output.
                   11601:                          &end_data_table()."\n";
                   11602:     }
1.987     raeburn  11603:     my $applies = 0;
                   11604:     if ($numremref) {
                   11605:         $applies ++;
                   11606:     }
                   11607:     if ($numinvalid) {
                   11608:         $applies ++;
                   11609:     }
                   11610:     if ($numexisting) {
                   11611:         $applies ++;
                   11612:     }
1.1071    raeburn  11613:     if ($counter || $numunused) {
1.987     raeburn  11614:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   11615:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  11616:                   $state.'<h3>'.$heading.'</h3>'; 
                   11617:         if ($actionurl eq '/adm/dependencies') {
                   11618:             if ($numnew) {
                   11619:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   11620:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   11621:                            $upload_output.'<br />'."\n";
                   11622:             }
                   11623:             if ($numexisting) {
                   11624:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   11625:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   11626:                            $modify_output.'<br />'."\n";
                   11627:                            $buttontext = &mt('Save changes');
                   11628:             }
                   11629:             if ($numunused) {
                   11630:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   11631:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   11632:                            $delete_output.'<br />'."\n";
                   11633:                            $buttontext = &mt('Save changes');
                   11634:             }
                   11635:         } else {
                   11636:             $output .= $upload_output.'<br />'."\n";
                   11637:         }
                   11638:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   11639:                    $counter.'" />'."\n";
                   11640:         if ($actionurl eq '/adm/dependencies') { 
                   11641:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   11642:                        $numnew.'" />'."\n";
                   11643:         } elsif ($actionurl eq '') {
1.987     raeburn  11644:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   11645:         }
                   11646:     } elsif ($applies) {
                   11647:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   11648:         if ($applies > 1) {
                   11649:             $output .=  
1.1075.2.35  raeburn  11650:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  11651:             if ($numremref) {
                   11652:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   11653:             }
                   11654:             if ($numinvalid) {
                   11655:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   11656:             }
                   11657:             if ($numexisting) {
                   11658:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   11659:             }
                   11660:             $output .= '</ul><br />';
                   11661:         } elsif ($numremref) {
                   11662:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   11663:         } elsif ($numinvalid) {
                   11664:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   11665:         } elsif ($numexisting) {
                   11666:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   11667:         }
                   11668:         $output .= $upload_output.'<br />';
                   11669:     }
                   11670:     my ($pathchange_output,$chgcount);
1.1071    raeburn  11671:     $chgcount = $counter;
1.987     raeburn  11672:     if (keys(%pathchanges) > 0) {
                   11673:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  11674:             if ($counter) {
1.987     raeburn  11675:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   11676:                                                   $embed_file,\%mapping,
1.1071    raeburn  11677:                                                   $allfiles,$codebase,'change');
1.987     raeburn  11678:             } else {
                   11679:                 $pathchange_output .= 
                   11680:                     &start_data_table_row().
                   11681:                     '<td><input type ="checkbox" name="namechange" value="'.
                   11682:                     $chgcount.'" checked="checked" /></td>'.
                   11683:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   11684:                     '<td>'.$embed_file.
                   11685:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  11686:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  11687:                     '</td>'.&end_data_table_row();
1.660     raeburn  11688:             }
1.987     raeburn  11689:             $numpathchg ++;
                   11690:             $chgcount ++;
1.660     raeburn  11691:         }
                   11692:     }
1.1075.2.35  raeburn  11693:     if (($counter) || ($numunused)) {
1.987     raeburn  11694:         if ($numpathchg) {
                   11695:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   11696:                        $numpathchg.'" />'."\n";
                   11697:         }
                   11698:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   11699:             ($actionurl eq '/adm/imsimport')) {
                   11700:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   11701:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   11702:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  11703:         } elsif ($actionurl eq '/adm/dependencies') {
                   11704:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  11705:         }
1.1075.2.35  raeburn  11706:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  11707:     } elsif ($numpathchg) {
                   11708:         my %pathchange = ();
                   11709:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   11710:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11711:             $output .= '<p>'.&mt('or').'</p>'; 
1.1075.2.35  raeburn  11712:         }
1.987     raeburn  11713:     }
1.1071    raeburn  11714:     return ($output,$counter,$numpathchg);
1.987     raeburn  11715: }
                   11716: 
1.1075.2.47  raeburn  11717: =pod
                   11718: 
                   11719: =item * clean_path($name)
                   11720: 
                   11721: Performs clean-up of directories, subdirectories and filename in an
                   11722: embedded object, referenced in an HTML file which is being uploaded
                   11723: to a course or portfolio, where
                   11724: "Upload embedded images/multimedia files if HTML file" checkbox was
                   11725: checked.
                   11726: 
                   11727: Clean-up is similar to replacements in lonnet::clean_filename()
                   11728: except each / between sub-directory and next level is preserved.
                   11729: 
                   11730: =cut
                   11731: 
                   11732: sub clean_path {
                   11733:     my ($embed_file) = @_;
                   11734:     $embed_file =~s{^/+}{};
                   11735:     my @contents;
                   11736:     if ($embed_file =~ m{/}) {
                   11737:         @contents = split(/\//,$embed_file);
                   11738:     } else {
                   11739:         @contents = ($embed_file);
                   11740:     }
                   11741:     my $lastidx = scalar(@contents)-1;
                   11742:     for (my $i=0; $i<=$lastidx; $i++) {
                   11743:         $contents[$i]=~s{\\}{/}g;
                   11744:         $contents[$i]=~s/\s+/\_/g;
                   11745:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   11746:         if ($i == $lastidx) {
                   11747:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   11748:         }
                   11749:     }
                   11750:     if ($lastidx > 0) {
                   11751:         return join('/',@contents);
                   11752:     } else {
                   11753:         return $contents[0];
                   11754:     }
                   11755: }
                   11756: 
1.987     raeburn  11757: sub embedded_file_element {
1.1071    raeburn  11758:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  11759:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   11760:                    (ref($codebase) eq 'HASH'));
                   11761:     my $output;
1.1071    raeburn  11762:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  11763:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   11764:     }
                   11765:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   11766:                &escape($embed_file).'" />';
                   11767:     unless (($context eq 'upload_embedded') && 
                   11768:             ($mapping->{$embed_file} eq $embed_file)) {
                   11769:         $output .='
                   11770:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   11771:     }
                   11772:     my $attrib;
                   11773:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   11774:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   11775:     }
                   11776:     $output .=
                   11777:         "\n\t\t".
                   11778:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   11779:         $attrib.'" />';
                   11780:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   11781:         $output .=
                   11782:             "\n\t\t".
                   11783:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   11784:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  11785:     }
1.987     raeburn  11786:     return $output;
1.660     raeburn  11787: }
                   11788: 
1.1071    raeburn  11789: sub get_dependency_details {
                   11790:     my ($currfile,$currsubfile,$embed_file) = @_;
                   11791:     my ($size,$mtime,$showsize,$showmtime);
                   11792:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   11793:         if ($embed_file =~ m{/}) {
                   11794:             my ($path,$fname) = split(/\//,$embed_file);
                   11795:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   11796:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   11797:             }
                   11798:         } else {
                   11799:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   11800:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   11801:             }
                   11802:         }
                   11803:         $showsize = $size/1024.0;
                   11804:         $showsize = sprintf("%.1f",$showsize);
                   11805:         if ($mtime > 0) {
                   11806:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   11807:         }
                   11808:     }
                   11809:     return ($showsize,$showmtime);
                   11810: }
                   11811: 
                   11812: sub ask_embedded_js {
                   11813:     return <<"END";
                   11814: <script type="text/javascript"">
                   11815: // <![CDATA[
                   11816: function toggleBrowse(counter) {
                   11817:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   11818:     var fileid = document.getElementById('embedded_item_'+counter);
                   11819:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   11820:     if (chkboxid.checked == true) {
                   11821:         uploaddivid.style.display='block';
                   11822:     } else {
                   11823:         uploaddivid.style.display='none';
                   11824:         fileid.value = '';
                   11825:     }
                   11826: }
                   11827: // ]]>
                   11828: </script>
                   11829: 
                   11830: END
                   11831: }
                   11832: 
1.661     raeburn  11833: sub upload_embedded {
                   11834:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  11835:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   11836:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  11837:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   11838:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   11839:         my $orig_uploaded_filename =
                   11840:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  11841:         foreach my $type ('orig','ref','attrib','codebase') {
                   11842:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   11843:                 $env{'form.embedded_'.$type.'_'.$i} =
                   11844:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   11845:             }
                   11846:         }
1.661     raeburn  11847:         my ($path,$fname) =
                   11848:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   11849:         # no path, whole string is fname
                   11850:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   11851:         $fname = &Apache::lonnet::clean_filename($fname);
                   11852:         # See if there is anything left
                   11853:         next if ($fname eq '');
                   11854: 
                   11855:         # Check if file already exists as a file or directory.
                   11856:         my ($state,$msg);
                   11857:         if ($context eq 'portfolio') {
                   11858:             my $port_path = $dirpath;
                   11859:             if ($group ne '') {
                   11860:                 $port_path = "groups/$group/$port_path";
                   11861:             }
1.987     raeburn  11862:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   11863:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  11864:                                               $dir_root,$port_path,$disk_quota,
                   11865:                                               $current_disk_usage,$uname,$udom);
                   11866:             if ($state eq 'will_exceed_quota'
1.984     raeburn  11867:                 || $state eq 'file_locked') {
1.661     raeburn  11868:                 $output .= $msg;
                   11869:                 next;
                   11870:             }
                   11871:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   11872:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   11873:             if ($state eq 'exists') {
                   11874:                 $output .= $msg;
                   11875:                 next;
                   11876:             }
                   11877:         }
                   11878:         # Check if extension is valid
                   11879:         if (($fname =~ /\.(\w+)$/) &&
                   11880:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1075.2.53  raeburn  11881:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   11882:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  11883:             next;
                   11884:         } elsif (($fname =~ /\.(\w+)$/) &&
                   11885:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  11886:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  11887:             next;
                   11888:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34  raeburn  11889:             $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  11890:             next;
                   11891:         }
                   11892:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35  raeburn  11893:         my $subdir = $path;
                   11894:         $subdir =~ s{/+$}{};
1.661     raeburn  11895:         if ($context eq 'portfolio') {
1.984     raeburn  11896:             my $result;
                   11897:             if ($state eq 'existingfile') {
                   11898:                 $result=
                   11899:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35  raeburn  11900:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  11901:             } else {
1.984     raeburn  11902:                 $result=
                   11903:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  11904:                                                     $dirpath.
1.1075.2.35  raeburn  11905:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  11906:                 if ($result !~ m|^/uploaded/|) {
                   11907:                     $output .= '<span class="LC_error">'
                   11908:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11909:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11910:                                .'</span><br />';
                   11911:                     next;
                   11912:                 } else {
1.987     raeburn  11913:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11914:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  11915:                 }
1.661     raeburn  11916:             }
1.1075.2.35  raeburn  11917:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
                   11918:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   11919:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  11920:             my $result =
1.1075.2.35  raeburn  11921:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  11922:             if ($result !~ m|^/uploaded/|) {
                   11923:                 $output .= '<span class="LC_error">'
                   11924:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11925:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11926:                            .'</span><br />';
                   11927:                     next;
                   11928:             } else {
                   11929:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11930:                            $path.$fname.'</span>').'<br />';
1.1075.2.35  raeburn  11931:                 if ($context eq 'syllabus') {
                   11932:                     &Apache::lonnet::make_public_indefinitely($result);
                   11933:                 }
1.987     raeburn  11934:             }
1.661     raeburn  11935:         } else {
                   11936: # Save the file
                   11937:             my $target = $env{'form.embedded_item_'.$i};
                   11938:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   11939:             my $dest = $fullpath.$fname;
                   11940:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  11941:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  11942:             my $count;
                   11943:             my $filepath = $dir_root;
1.1027    raeburn  11944:             foreach my $subdir (@parts) {
                   11945:                 $filepath .= "/$subdir";
                   11946:                 if (!-e $filepath) {
1.661     raeburn  11947:                     mkdir($filepath,0770);
                   11948:                 }
                   11949:             }
                   11950:             my $fh;
                   11951:             if (!open($fh,'>'.$dest)) {
                   11952:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   11953:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  11954:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   11955:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11956:                            '</span><br />';
                   11957:             } else {
                   11958:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   11959:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   11960:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  11961:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   11962:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11963:                               '</span><br />';
                   11964:                 } else {
1.987     raeburn  11965:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11966:                                $url.'</span>').'<br />';
                   11967:                     unless ($context eq 'testbank') {
                   11968:                         $footer .= &mt('View embedded file: [_1]',
                   11969:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   11970:                     }
                   11971:                 }
                   11972:                 close($fh);
                   11973:             }
                   11974:         }
                   11975:         if ($env{'form.embedded_ref_'.$i}) {
                   11976:             $pathchange{$i} = 1;
                   11977:         }
                   11978:     }
                   11979:     if ($output) {
                   11980:         $output = '<p>'.$output.'</p>';
                   11981:     }
                   11982:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   11983:     $returnflag = 'ok';
1.1071    raeburn  11984:     my $numpathchgs = scalar(keys(%pathchange));
                   11985:     if ($numpathchgs > 0) {
1.987     raeburn  11986:         if ($context eq 'portfolio') {
                   11987:             $output .= '<p>'.&mt('or').'</p>';
                   11988:         } elsif ($context eq 'testbank') {
1.1071    raeburn  11989:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   11990:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  11991:             $returnflag = 'modify_orightml';
                   11992:         }
                   11993:     }
1.1071    raeburn  11994:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  11995: }
                   11996: 
                   11997: sub modify_html_form {
                   11998:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   11999:     my $end = 0;
                   12000:     my $modifyform;
                   12001:     if ($context eq 'upload_embedded') {
                   12002:         return unless (ref($pathchange) eq 'HASH');
                   12003:         if ($env{'form.number_embedded_items'}) {
                   12004:             $end += $env{'form.number_embedded_items'};
                   12005:         }
                   12006:         if ($env{'form.number_pathchange_items'}) {
                   12007:             $end += $env{'form.number_pathchange_items'};
                   12008:         }
                   12009:         if ($end) {
                   12010:             for (my $i=0; $i<$end; $i++) {
                   12011:                 if ($i < $env{'form.number_embedded_items'}) {
                   12012:                     next unless($pathchange->{$i});
                   12013:                 }
                   12014:                 $modifyform .=
                   12015:                     &start_data_table_row().
                   12016:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   12017:                     'checked="checked" /></td>'.
                   12018:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   12019:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   12020:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   12021:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   12022:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   12023:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   12024:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   12025:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   12026:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   12027:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   12028:                     &end_data_table_row();
1.1071    raeburn  12029:             }
1.987     raeburn  12030:         }
                   12031:     } else {
                   12032:         $modifyform = $pathchgtable;
                   12033:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   12034:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   12035:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   12036:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   12037:         }
                   12038:     }
                   12039:     if ($modifyform) {
1.1071    raeburn  12040:         if ($actionurl eq '/adm/dependencies') {
                   12041:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   12042:         }
1.987     raeburn  12043:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   12044:                '<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".
                   12045:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   12046:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   12047:                '</ol></p>'."\n".'<p>'.
                   12048:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   12049:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   12050:                &start_data_table()."\n".
                   12051:                &start_data_table_header_row().
                   12052:                '<th>'.&mt('Change?').'</th>'.
                   12053:                '<th>'.&mt('Current reference').'</th>'.
                   12054:                '<th>'.&mt('Required reference').'</th>'.
                   12055:                &end_data_table_header_row()."\n".
                   12056:                $modifyform.
                   12057:                &end_data_table().'<br />'."\n".$hiddenstate.
                   12058:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   12059:                '</form>'."\n";
                   12060:     }
                   12061:     return;
                   12062: }
                   12063: 
                   12064: sub modify_html_refs {
1.1075.2.35  raeburn  12065:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  12066:     my $container;
                   12067:     if ($context eq 'portfolio') {
                   12068:         $container = $env{'form.container'};
                   12069:     } elsif ($context eq 'coursedoc') {
                   12070:         $container = $env{'form.primaryurl'};
1.1071    raeburn  12071:     } elsif ($context eq 'manage_dependencies') {
                   12072:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   12073:         $container = "/$container";
1.1075.2.35  raeburn  12074:     } elsif ($context eq 'syllabus') {
                   12075:         $container = $url;
1.987     raeburn  12076:     } else {
1.1027    raeburn  12077:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  12078:     }
                   12079:     my (%allfiles,%codebase,$output,$content);
                   12080:     my @changes = &get_env_multiple('form.namechange');
1.1075.2.35  raeburn  12081:     unless ((@changes > 0)  || ($context eq 'syllabus')) {
1.1071    raeburn  12082:         if (wantarray) {
                   12083:             return ('',0,0); 
                   12084:         } else {
                   12085:             return;
                   12086:         }
                   12087:     }
                   12088:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  12089:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  12090:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   12091:             if (wantarray) {
                   12092:                 return ('',0,0);
                   12093:             } else {
                   12094:                 return;
                   12095:             }
                   12096:         } 
1.987     raeburn  12097:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  12098:         if ($content eq '-1') {
                   12099:             if (wantarray) {
                   12100:                 return ('',0,0);
                   12101:             } else {
                   12102:                 return;
                   12103:             }
                   12104:         }
1.987     raeburn  12105:     } else {
1.1071    raeburn  12106:         unless ($container =~ /^\Q$dir_root\E/) {
                   12107:             if (wantarray) {
                   12108:                 return ('',0,0);
                   12109:             } else {
                   12110:                 return;
                   12111:             }
                   12112:         } 
1.1075.2.128  raeburn  12113:         if (open(my $fh,'<',$container)) {
1.987     raeburn  12114:             $content = join('', <$fh>);
                   12115:             close($fh);
                   12116:         } else {
1.1071    raeburn  12117:             if (wantarray) {
                   12118:                 return ('',0,0);
                   12119:             } else {
                   12120:                 return;
                   12121:             }
1.987     raeburn  12122:         }
                   12123:     }
                   12124:     my ($count,$codebasecount) = (0,0);
                   12125:     my $mm = new File::MMagic;
                   12126:     my $mime_type = $mm->checktype_contents($content);
                   12127:     if ($mime_type eq 'text/html') {
                   12128:         my $parse_result = 
                   12129:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   12130:                                                     \%codebase,\$content);
                   12131:         if ($parse_result eq 'ok') {
                   12132:             foreach my $i (@changes) {
                   12133:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   12134:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   12135:                 if ($allfiles{$ref}) {
                   12136:                     my $newname =  $orig;
                   12137:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  12138:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  12139:                     if ($attrib_regexp =~ /:/) {
                   12140:                         $attrib_regexp =~ s/\:/|/g;
                   12141:                     }
                   12142:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   12143:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   12144:                         $count += $numchg;
1.1075.2.35  raeburn  12145:                         $allfiles{$newname} = $allfiles{$ref};
1.1075.2.48  raeburn  12146:                         delete($allfiles{$ref});
1.987     raeburn  12147:                     }
                   12148:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  12149:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  12150:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   12151:                         $codebasecount ++;
                   12152:                     }
                   12153:                 }
                   12154:             }
1.1075.2.35  raeburn  12155:             my $skiprewrites;
1.987     raeburn  12156:             if ($count || $codebasecount) {
                   12157:                 my $saveresult;
1.1071    raeburn  12158:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  12159:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  12160:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   12161:                     if ($url eq $container) {
                   12162:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   12163:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   12164:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  12165:                                             $fname.'</span>').'</p>';
1.987     raeburn  12166:                     } else {
                   12167:                          $output = '<p class="LC_error">'.
                   12168:                                    &mt('Error: update failed for: [_1].',
                   12169:                                    '<span class="LC_filename">'.
                   12170:                                    $container.'</span>').'</p>';
                   12171:                     }
1.1075.2.35  raeburn  12172:                     if ($context eq 'syllabus') {
                   12173:                         unless ($saveresult eq 'ok') {
                   12174:                             $skiprewrites = 1;
                   12175:                         }
                   12176:                     }
1.987     raeburn  12177:                 } else {
1.1075.2.128  raeburn  12178:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  12179:                         print $fh $content;
                   12180:                         close($fh);
                   12181:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   12182:                                   $count,'<span class="LC_filename">'.
                   12183:                                   $container.'</span>').'</p>';
1.661     raeburn  12184:                     } else {
1.987     raeburn  12185:                          $output = '<p class="LC_error">'.
                   12186:                                    &mt('Error: could not update [_1].',
                   12187:                                    '<span class="LC_filename">'.
                   12188:                                    $container.'</span>').'</p>';
1.661     raeburn  12189:                     }
                   12190:                 }
                   12191:             }
1.1075.2.35  raeburn  12192:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   12193:                 my ($actionurl,$state);
                   12194:                 $actionurl = "/public/$udom/$uname/syllabus";
                   12195:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   12196:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   12197:                                               \%codebase,
                   12198:                                               {'context' => 'rewrites',
                   12199:                                                'ignore_remote_references' => 1,});
                   12200:                 if (ref($mapping) eq 'HASH') {
                   12201:                     my $rewrites = 0;
                   12202:                     foreach my $key (keys(%{$mapping})) {
                   12203:                         next if ($key =~ m{^https?://});
                   12204:                         my $ref = $mapping->{$key};
                   12205:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   12206:                         my $attrib;
                   12207:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   12208:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   12209:                         }
                   12210:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   12211:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   12212:                             $rewrites += $numchg;
                   12213:                         }
                   12214:                     }
                   12215:                     if ($rewrites) {
                   12216:                         my $saveresult;
                   12217:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   12218:                         if ($url eq $container) {
                   12219:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   12220:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   12221:                                             $count,'<span class="LC_filename">'.
                   12222:                                             $fname.'</span>').'</p>';
                   12223:                         } else {
                   12224:                             $output .= '<p class="LC_error">'.
                   12225:                                        &mt('Error: could not update links in [_1].',
                   12226:                                        '<span class="LC_filename">'.
                   12227:                                        $container.'</span>').'</p>';
                   12228: 
                   12229:                         }
                   12230:                     }
                   12231:                 }
                   12232:             }
1.987     raeburn  12233:         } else {
                   12234:             &logthis('Failed to parse '.$container.
                   12235:                      ' to modify references: '.$parse_result);
1.661     raeburn  12236:         }
                   12237:     }
1.1071    raeburn  12238:     if (wantarray) {
                   12239:         return ($output,$count,$codebasecount);
                   12240:     } else {
                   12241:         return $output;
                   12242:     }
1.661     raeburn  12243: }
                   12244: 
                   12245: sub check_for_existing {
                   12246:     my ($path,$fname,$element) = @_;
                   12247:     my ($state,$msg);
                   12248:     if (-d $path.'/'.$fname) {
                   12249:         $state = 'exists';
                   12250:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   12251:     } elsif (-e $path.'/'.$fname) {
                   12252:         $state = 'exists';
                   12253:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   12254:     }
                   12255:     if ($state eq 'exists') {
                   12256:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   12257:     }
                   12258:     return ($state,$msg);
                   12259: }
                   12260: 
                   12261: sub check_for_upload {
                   12262:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   12263:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  12264:     my $filesize = length($env{'form.'.$element});
                   12265:     if (!$filesize) {
                   12266:         my $msg = '<span class="LC_error">'.
                   12267:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   12268:                       '<span class="LC_filename">'.$fname.'</span>',
                   12269:                       $filesize).'<br />'.
1.1007    raeburn  12270:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  12271:                   '</span>';
                   12272:         return ('zero_bytes',$msg);
                   12273:     }
                   12274:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  12275:     my $getpropath = 1;
1.1021    raeburn  12276:     my ($dirlistref,$listerror) =
                   12277:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  12278:     my $found_file = 0;
                   12279:     my $locked_file = 0;
1.991     raeburn  12280:     my @lockers;
                   12281:     my $navmap;
                   12282:     if ($env{'request.course.id'}) {
                   12283:         $navmap = Apache::lonnavmaps::navmap->new();
                   12284:     }
1.1021    raeburn  12285:     if (ref($dirlistref) eq 'ARRAY') {
                   12286:         foreach my $line (@{$dirlistref}) {
                   12287:             my ($file_name,$rest)=split(/\&/,$line,2);
                   12288:             if ($file_name eq $fname){
                   12289:                 $file_name = $path.$file_name;
                   12290:                 if ($group ne '') {
                   12291:                     $file_name = $group.$file_name;
                   12292:                 }
                   12293:                 $found_file = 1;
                   12294:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   12295:                     foreach my $lock (@lockers) {
                   12296:                         if (ref($lock) eq 'ARRAY') {
                   12297:                             my ($symb,$crsid) = @{$lock};
                   12298:                             if ($crsid eq $env{'request.course.id'}) {
                   12299:                                 if (ref($navmap)) {
                   12300:                                     my $res = $navmap->getBySymb($symb);
                   12301:                                     foreach my $part (@{$res->parts()}) { 
                   12302:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   12303:                                         unless (($slot_status == $res->RESERVED) ||
                   12304:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   12305:                                             $locked_file = 1;
                   12306:                                         }
1.991     raeburn  12307:                                     }
1.1021    raeburn  12308:                                 } else {
                   12309:                                     $locked_file = 1;
1.991     raeburn  12310:                                 }
                   12311:                             } else {
                   12312:                                 $locked_file = 1;
                   12313:                             }
                   12314:                         }
1.1021    raeburn  12315:                    }
                   12316:                 } else {
                   12317:                     my @info = split(/\&/,$rest);
                   12318:                     my $currsize = $info[6]/1000;
                   12319:                     if ($currsize < $filesize) {
                   12320:                         my $extra = $filesize - $currsize;
                   12321:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1075.2.69  raeburn  12322:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  12323:                                       &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  12324:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   12325:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   12326:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  12327:                             return ('will_exceed_quota',$msg);
                   12328:                         }
1.984     raeburn  12329:                     }
                   12330:                 }
1.661     raeburn  12331:             }
                   12332:         }
                   12333:     }
                   12334:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1075.2.69  raeburn  12335:         my $msg = '<p class="LC_warning">'.
                   12336:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
                   12337:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  12338:         return ('will_exceed_quota',$msg);
                   12339:     } elsif ($found_file) {
                   12340:         if ($locked_file) {
1.1075.2.69  raeburn  12341:             my $msg = '<p class="LC_warning">';
1.661     raeburn  12342:             $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  12343:             $msg .= '</p>';
1.661     raeburn  12344:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   12345:             return ('file_locked',$msg);
                   12346:         } else {
1.1075.2.69  raeburn  12347:             my $msg = '<p class="LC_error">';
1.984     raeburn  12348:             $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  12349:             $msg .= '</p>';
1.984     raeburn  12350:             return ('existingfile',$msg);
1.661     raeburn  12351:         }
                   12352:     }
                   12353: }
                   12354: 
1.987     raeburn  12355: sub check_for_traversal {
                   12356:     my ($path,$url,$toplevel) = @_;
                   12357:     my @parts=split(/\//,$path);
                   12358:     my $cleanpath;
                   12359:     my $fullpath = $url;
                   12360:     for (my $i=0;$i<@parts;$i++) {
                   12361:         next if ($parts[$i] eq '.');
                   12362:         if ($parts[$i] eq '..') {
                   12363:             $fullpath =~ s{([^/]+/)$}{};
                   12364:         } else {
                   12365:             $fullpath .= $parts[$i].'/';
                   12366:         }
                   12367:     }
                   12368:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   12369:         $cleanpath = $1;
                   12370:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   12371:         my $curr_toprel = $1;
                   12372:         my @parts = split(/\//,$curr_toprel);
                   12373:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   12374:         my @urlparts = split(/\//,$url_toprel);
                   12375:         my $doubledots;
                   12376:         my $startdiff = -1;
                   12377:         for (my $i=0; $i<@urlparts; $i++) {
                   12378:             if ($startdiff == -1) {
                   12379:                 unless ($urlparts[$i] eq $parts[$i]) {
                   12380:                     $startdiff = $i;
                   12381:                     $doubledots .= '../';
                   12382:                 }
                   12383:             } else {
                   12384:                 $doubledots .= '../';
                   12385:             }
                   12386:         }
                   12387:         if ($startdiff > -1) {
                   12388:             $cleanpath = $doubledots;
                   12389:             for (my $i=$startdiff; $i<@parts; $i++) {
                   12390:                 $cleanpath .= $parts[$i].'/';
                   12391:             }
                   12392:         }
                   12393:     }
                   12394:     $cleanpath =~ s{(/)$}{};
                   12395:     return $cleanpath;
                   12396: }
1.31      albertel 12397: 
1.1053    raeburn  12398: sub is_archive_file {
                   12399:     my ($mimetype) = @_;
                   12400:     if (($mimetype eq 'application/octet-stream') ||
                   12401:         ($mimetype eq 'application/x-stuffit') ||
                   12402:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   12403:         return 1;
                   12404:     }
                   12405:     return;
                   12406: }
                   12407: 
                   12408: sub decompress_form {
1.1065    raeburn  12409:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  12410:     my %lt = &Apache::lonlocal::texthash (
                   12411:         this => 'This file is an archive file.',
1.1067    raeburn  12412:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  12413:         itsc => 'Its contents are as follows:',
1.1053    raeburn  12414:         youm => 'You may wish to extract its contents.',
                   12415:         extr => 'Extract contents',
1.1067    raeburn  12416:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   12417:         proa => 'Process automatically?',
1.1053    raeburn  12418:         yes  => 'Yes',
                   12419:         no   => 'No',
1.1067    raeburn  12420:         fold => 'Title for folder containing movie',
                   12421:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  12422:     );
1.1065    raeburn  12423:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  12424:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  12425:     my $info = &list_archive_contents($fileloc,\@paths);
                   12426:     if (@paths) {
                   12427:         foreach my $path (@paths) {
                   12428:             $path =~ s{^/}{};
1.1067    raeburn  12429:             if ($path =~ m{^([^/]+)/$}) {
                   12430:                 $topdir = $1;
                   12431:             }
1.1065    raeburn  12432:             if ($path =~ m{^([^/]+)/}) {
                   12433:                 $toplevel{$1} = $path;
                   12434:             } else {
                   12435:                 $toplevel{$path} = $path;
                   12436:             }
                   12437:         }
                   12438:     }
1.1067    raeburn  12439:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1075.2.59  raeburn  12440:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  12441:                         "$topdir/media/",
                   12442:                         "$topdir/media/$topdir.mp4",
                   12443:                         "$topdir/media/FirstFrame.png",
                   12444:                         "$topdir/media/player.swf",
                   12445:                         "$topdir/media/swfobject.js",
                   12446:                         "$topdir/media/expressInstall.swf");
1.1075.2.81  raeburn  12447:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1075.2.59  raeburn  12448:                          "$topdir/$topdir.mp4",
                   12449:                          "$topdir/$topdir\_config.xml",
                   12450:                          "$topdir/$topdir\_controller.swf",
                   12451:                          "$topdir/$topdir\_embed.css",
                   12452:                          "$topdir/$topdir\_First_Frame.png",
                   12453:                          "$topdir/$topdir\_player.html",
                   12454:                          "$topdir/$topdir\_Thumbnails.png",
                   12455:                          "$topdir/playerProductInstall.swf",
                   12456:                          "$topdir/scripts/",
                   12457:                          "$topdir/scripts/config_xml.js",
                   12458:                          "$topdir/scripts/handlebars.js",
                   12459:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   12460:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   12461:                          "$topdir/scripts/modernizr.js",
                   12462:                          "$topdir/scripts/player-min.js",
                   12463:                          "$topdir/scripts/swfobject.js",
                   12464:                          "$topdir/skins/",
                   12465:                          "$topdir/skins/configuration_express.xml",
                   12466:                          "$topdir/skins/express_show/",
                   12467:                          "$topdir/skins/express_show/player-min.css",
                   12468:                          "$topdir/skins/express_show/spritesheet.png");
1.1075.2.81  raeburn  12469:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   12470:                          "$topdir/$topdir.mp4",
                   12471:                          "$topdir/$topdir\_config.xml",
                   12472:                          "$topdir/$topdir\_controller.swf",
                   12473:                          "$topdir/$topdir\_embed.css",
                   12474:                          "$topdir/$topdir\_First_Frame.png",
                   12475:                          "$topdir/$topdir\_player.html",
                   12476:                          "$topdir/$topdir\_Thumbnails.png",
                   12477:                          "$topdir/playerProductInstall.swf",
                   12478:                          "$topdir/scripts/",
                   12479:                          "$topdir/scripts/config_xml.js",
                   12480:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   12481:                          "$topdir/skins/",
                   12482:                          "$topdir/skins/configuration_express.xml",
                   12483:                          "$topdir/skins/express_show/",
                   12484:                          "$topdir/skins/express_show/spritesheet.min.css",
                   12485:                          "$topdir/skins/express_show/spritesheet.png",
                   12486:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1075.2.59  raeburn  12487:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  12488:         if (@diffs == 0) {
1.1075.2.59  raeburn  12489:             $is_camtasia = 6;
                   12490:         } else {
1.1075.2.81  raeburn  12491:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1075.2.59  raeburn  12492:             if (@diffs == 0) {
                   12493:                 $is_camtasia = 8;
1.1075.2.81  raeburn  12494:             } else {
                   12495:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   12496:                 if (@diffs == 0) {
                   12497:                     $is_camtasia = 8;
                   12498:                 }
1.1075.2.59  raeburn  12499:             }
1.1067    raeburn  12500:         }
                   12501:     }
                   12502:     my $output;
                   12503:     if ($is_camtasia) {
                   12504:         $output = <<"ENDCAM";
                   12505: <script type="text/javascript" language="Javascript">
                   12506: // <![CDATA[
                   12507: 
                   12508: function camtasiaToggle() {
                   12509:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   12510:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1075.2.59  raeburn  12511:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  12512:                 document.getElementById('camtasia_titles').style.display='block';
                   12513:             } else {
                   12514:                 document.getElementById('camtasia_titles').style.display='none';
                   12515:             }
                   12516:         }
                   12517:     }
                   12518:     return;
                   12519: }
                   12520: 
                   12521: // ]]>
                   12522: </script>
                   12523: <p>$lt{'camt'}</p>
                   12524: ENDCAM
1.1065    raeburn  12525:     } else {
1.1067    raeburn  12526:         $output = '<p>'.$lt{'this'};
                   12527:         if ($info eq '') {
                   12528:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   12529:         } else {
                   12530:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   12531:                        '<div><pre>'.$info.'</pre></div>';
                   12532:         }
1.1065    raeburn  12533:     }
1.1067    raeburn  12534:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  12535:     my $duplicates;
                   12536:     my $num = 0;
                   12537:     if (ref($dirlist) eq 'ARRAY') {
                   12538:         foreach my $item (@{$dirlist}) {
                   12539:             if (ref($item) eq 'ARRAY') {
                   12540:                 if (exists($toplevel{$item->[0]})) {
                   12541:                     $duplicates .= 
                   12542:                         &start_data_table_row().
                   12543:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12544:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   12545:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12546:                         'value="1" />'.&mt('Yes').'</label>'.
                   12547:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   12548:                         '<td>'.$item->[0].'</td>';
                   12549:                     if ($item->[2]) {
                   12550:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   12551:                     } else {
                   12552:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   12553:                     }
                   12554:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   12555:                                    '<td>'.
                   12556:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   12557:                                    '</td>'.
                   12558:                                    &end_data_table_row();
                   12559:                     $num ++;
                   12560:                 }
                   12561:             }
                   12562:         }
                   12563:     }
                   12564:     my $itemcount;
                   12565:     if (@paths > 0) {
                   12566:         $itemcount = scalar(@paths);
                   12567:     } else {
                   12568:         $itemcount = 1;
                   12569:     }
1.1067    raeburn  12570:     if ($is_camtasia) {
                   12571:         $output .= $lt{'auto'}.'<br />'.
                   12572:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1075.2.59  raeburn  12573:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  12574:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   12575:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   12576:                    $lt{'no'}.'</label></span><br />'.
                   12577:                    '<div id="camtasia_titles" style="display:block">'.
                   12578:                    &Apache::lonhtmlcommon::start_pick_box().
                   12579:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   12580:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   12581:                    &Apache::lonhtmlcommon::row_closure().
                   12582:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   12583:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   12584:                    &Apache::lonhtmlcommon::row_closure(1).
                   12585:                    &Apache::lonhtmlcommon::end_pick_box().
                   12586:                    '</div>';
                   12587:     }
1.1065    raeburn  12588:     $output .= 
                   12589:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  12590:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   12591:         "\n";
1.1065    raeburn  12592:     if ($duplicates ne '') {
                   12593:         $output .= '<p><span class="LC_warning">'.
                   12594:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   12595:                    &start_data_table().
                   12596:                    &start_data_table_header_row().
                   12597:                    '<th>'.&mt('Overwrite?').'</th>'.
                   12598:                    '<th>'.&mt('Name').'</th>'.
                   12599:                    '<th>'.&mt('Type').'</th>'.
                   12600:                    '<th>'.&mt('Size').'</th>'.
                   12601:                    '<th>'.&mt('Last modified').'</th>'.
                   12602:                    &end_data_table_header_row().
                   12603:                    $duplicates.
                   12604:                    &end_data_table().
                   12605:                    '</p>';
                   12606:     }
1.1067    raeburn  12607:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  12608:     if (ref($hiddenelements) eq 'HASH') {
                   12609:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   12610:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   12611:         }
                   12612:     }
                   12613:     $output .= <<"END";
1.1067    raeburn  12614: <br />
1.1053    raeburn  12615: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   12616: </form>
                   12617: $noextract
                   12618: END
                   12619:     return $output;
                   12620: }
                   12621: 
1.1065    raeburn  12622: sub decompression_utility {
                   12623:     my ($program) = @_;
                   12624:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   12625:     my $location;
                   12626:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   12627:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   12628:                          '/usr/sbin/') {
                   12629:             if (-x $dir.$program) {
                   12630:                 $location = $dir.$program;
                   12631:                 last;
                   12632:             }
                   12633:         }
                   12634:     }
                   12635:     return $location;
                   12636: }
                   12637: 
                   12638: sub list_archive_contents {
                   12639:     my ($file,$pathsref) = @_;
                   12640:     my (@cmd,$output);
                   12641:     my $needsregexp;
                   12642:     if ($file =~ /\.zip$/) {
                   12643:         @cmd = (&decompression_utility('unzip'),"-l");
                   12644:         $needsregexp = 1;
                   12645:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   12646:              ($file =~ /\.tgz$/)) {
                   12647:         @cmd = (&decompression_utility('tar'),"-ztf");
                   12648:     } elsif ($file =~ /\.tar\.bz2$/) {
                   12649:         @cmd = (&decompression_utility('tar'),"-jtf");
                   12650:     } elsif ($file =~ m|\.tar$|) {
                   12651:         @cmd = (&decompression_utility('tar'),"-tf");
                   12652:     }
                   12653:     if (@cmd) {
                   12654:         undef($!);
                   12655:         undef($@);
                   12656:         if (open(my $fh,"-|", @cmd, $file)) {
                   12657:             while (my $line = <$fh>) {
                   12658:                 $output .= $line;
                   12659:                 chomp($line);
                   12660:                 my $item;
                   12661:                 if ($needsregexp) {
                   12662:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   12663:                 } else {
                   12664:                     $item = $line;
                   12665:                 }
                   12666:                 if ($item ne '') {
                   12667:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   12668:                         push(@{$pathsref},$item);
                   12669:                     } 
                   12670:                 }
                   12671:             }
                   12672:             close($fh);
                   12673:         }
                   12674:     }
                   12675:     return $output;
                   12676: }
                   12677: 
1.1053    raeburn  12678: sub decompress_uploaded_file {
                   12679:     my ($file,$dir) = @_;
                   12680:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   12681:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   12682:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   12683:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   12684:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   12685:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   12686:     my $decompressed = $env{'cgi.decompressed'};
                   12687:     &Apache::lonnet::delenv('cgi.file');
                   12688:     &Apache::lonnet::delenv('cgi.dir');
                   12689:     &Apache::lonnet::delenv('cgi.decompressed');
                   12690:     return ($decompressed,$result);
                   12691: }
                   12692: 
1.1055    raeburn  12693: sub process_decompression {
                   12694:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1075.2.128  raeburn  12695:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   12696:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12697:                &mt('Unexpected file path.').'</p>'."\n";
                   12698:     }
                   12699:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   12700:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12701:                &mt('Unexpected course context.').'</p>'."\n";
                   12702:     }
                   12703:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
                   12704:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12705:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   12706:     }
1.1055    raeburn  12707:     my ($dir,$error,$warning,$output);
1.1075.2.69  raeburn  12708:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1075.2.34  raeburn  12709:         $error = &mt('Filename not a supported archive file type.').
                   12710:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  12711:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   12712:     } else {
                   12713:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12714:         if ($docuhome eq 'no_host') {
                   12715:             $error = &mt('Could not determine home server for course.');
                   12716:         } else {
                   12717:             my @ids=&Apache::lonnet::current_machine_ids();
                   12718:             my $currdir = "$dir_root/$destination";
                   12719:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12720:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   12721:                        "$dir_root/$destination";
                   12722:             } else {
                   12723:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   12724:                        "$dir_root/$docudom/$docuname/$destination";
                   12725:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   12726:                     $error = &mt('Archive file not found.');
                   12727:                 }
                   12728:             }
1.1065    raeburn  12729:             my (@to_overwrite,@to_skip);
                   12730:             if ($env{'form.archive_overwrite_total'} > 0) {
                   12731:                 my $total = $env{'form.archive_overwrite_total'};
                   12732:                 for (my $i=0; $i<$total; $i++) {
                   12733:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   12734:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   12735:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   12736:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   12737:                     }
                   12738:                 }
                   12739:             }
                   12740:             my $numskip = scalar(@to_skip);
1.1075.2.128  raeburn  12741:             my $numoverwrite = scalar(@to_overwrite);
                   12742:             if (($numskip) && (!$numoverwrite)) {
1.1065    raeburn  12743:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   12744:             } elsif ($dir eq '') {
1.1055    raeburn  12745:                 $error = &mt('Directory containing archive file unavailable.');
                   12746:             } elsif (!$error) {
1.1065    raeburn  12747:                 my ($decompressed,$display);
1.1075.2.128  raeburn  12748:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  12749:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   12750:                     mkdir("$dir/$tempdir",0755);
1.1075.2.128  raeburn  12751:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   12752:                         ($decompressed,$display) =
                   12753:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   12754:                         foreach my $item (@to_skip) {
                   12755:                             if (($item ne '') && ($item !~ /\.\./)) {
                   12756:                                 if (-f "$dir/$tempdir/$item") {
                   12757:                                     unlink("$dir/$tempdir/$item");
                   12758:                                 } elsif (-d "$dir/$tempdir/$item") {
                   12759:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
                   12760:                                 }
                   12761:                             }
                   12762:                         }
                   12763:                         foreach my $item (@to_overwrite) {
                   12764:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   12765:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   12766:                                     if (-f "$dir/$item") {
                   12767:                                         unlink("$dir/$item");
                   12768:                                     } elsif (-d "$dir/$item") {
                   12769:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
                   12770:                                     }
                   12771:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   12772:                                 }
1.1065    raeburn  12773:                             }
                   12774:                         }
1.1075.2.128  raeburn  12775:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
                   12776:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
                   12777:                         }
1.1065    raeburn  12778:                     }
                   12779:                 } else {
                   12780:                     ($decompressed,$display) = 
                   12781:                         &decompress_uploaded_file($file,$dir);
                   12782:                 }
1.1055    raeburn  12783:                 if ($decompressed eq 'ok') {
1.1065    raeburn  12784:                     $output = '<p class="LC_info">'.
                   12785:                               &mt('Files extracted successfully from archive.').
                   12786:                               '</p>'."\n";
1.1055    raeburn  12787:                     my ($warning,$result,@contents);
                   12788:                     my ($newdirlistref,$newlisterror) =
                   12789:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   12790:                                                  $docuname,1);
                   12791:                     my (%is_dir,%changes,@newitems);
                   12792:                     my $dirptr = 16384;
1.1065    raeburn  12793:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  12794:                         foreach my $dir_line (@{$newdirlistref}) {
                   12795:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1075.2.128  raeburn  12796:                             unless (($item =~ /^\.+$/) || ($item eq $file)) { 
1.1055    raeburn  12797:                                 push(@newitems,$item);
                   12798:                                 if ($dirptr&$testdir) {
                   12799:                                     $is_dir{$item} = 1;
                   12800:                                 }
                   12801:                                 $changes{$item} = 1;
                   12802:                             }
                   12803:                         }
                   12804:                     }
                   12805:                     if (keys(%changes) > 0) {
                   12806:                         foreach my $item (sort(@newitems)) {
                   12807:                             if ($changes{$item}) {
                   12808:                                 push(@contents,$item);
                   12809:                             }
                   12810:                         }
                   12811:                     }
                   12812:                     if (@contents > 0) {
1.1067    raeburn  12813:                         my $wantform;
                   12814:                         unless ($env{'form.autoextract_camtasia'}) {
                   12815:                             $wantform = 1;
                   12816:                         }
1.1056    raeburn  12817:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  12818:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   12819:                                                                 $currdir,\%is_dir,
                   12820:                                                                 \%children,\%parent,
1.1056    raeburn  12821:                                                                 \@contents,\%dirorder,
                   12822:                                                                 \%titles,$wantform);
1.1055    raeburn  12823:                         if ($datatable ne '') {
                   12824:                             $output .= &archive_options_form('decompressed',$datatable,
                   12825:                                                              $count,$hiddenelem);
1.1065    raeburn  12826:                             my $startcount = 6;
1.1055    raeburn  12827:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  12828:                                                            \%titles,\%children);
1.1055    raeburn  12829:                         }
1.1067    raeburn  12830:                         if ($env{'form.autoextract_camtasia'}) {
1.1075.2.59  raeburn  12831:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  12832:                             my %displayed;
                   12833:                             my $total = 1;
                   12834:                             $env{'form.archive_directory'} = [];
                   12835:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   12836:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   12837:                                 $path =~ s{/$}{};
                   12838:                                 my $item;
                   12839:                                 if ($path ne '') {
                   12840:                                     $item = "$path/$titles{$i}";
                   12841:                                 } else {
                   12842:                                     $item = $titles{$i};
                   12843:                                 }
                   12844:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   12845:                                 if ($item eq $contents[0]) {
                   12846:                                     push(@{$env{'form.archive_directory'}},$i);
                   12847:                                     $env{'form.archive_'.$i} = 'display';
                   12848:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   12849:                                     $displayed{'folder'} = $i;
1.1075.2.59  raeburn  12850:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   12851:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067    raeburn  12852:                                     $env{'form.archive_'.$i} = 'display';
                   12853:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   12854:                                     $displayed{'web'} = $i;
                   12855:                                 } else {
1.1075.2.59  raeburn  12856:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   12857:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   12858:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  12859:                                         push(@{$env{'form.archive_directory'}},$i);
                   12860:                                     }
                   12861:                                     $env{'form.archive_'.$i} = 'dependency';
                   12862:                                 }
                   12863:                                 $total ++;
                   12864:                             }
                   12865:                             for (my $i=1; $i<$total; $i++) {
                   12866:                                 next if ($i == $displayed{'web'});
                   12867:                                 next if ($i == $displayed{'folder'});
                   12868:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   12869:                             }
                   12870:                             $env{'form.phase'} = 'decompress_cleanup';
                   12871:                             $env{'form.archivedelete'} = 1;
                   12872:                             $env{'form.archive_count'} = $total-1;
                   12873:                             $output .=
                   12874:                                 &process_extracted_files('coursedocs',$docudom,
                   12875:                                                          $docuname,$destination,
                   12876:                                                          $dir_root,$hiddenelem);
                   12877:                         }
1.1055    raeburn  12878:                     } else {
                   12879:                         $warning = &mt('No new items extracted from archive file.');
                   12880:                     }
                   12881:                 } else {
                   12882:                     $output = $display;
                   12883:                     $error = &mt('An error occurred during extraction from the archive file.');
                   12884:                 }
                   12885:             }
                   12886:         }
                   12887:     }
                   12888:     if ($error) {
                   12889:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12890:                    $error.'</p>'."\n";
                   12891:     }
                   12892:     if ($warning) {
                   12893:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   12894:     }
                   12895:     return $output;
                   12896: }
                   12897: 
                   12898: sub get_extracted {
1.1056    raeburn  12899:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   12900:         $titles,$wantform) = @_;
1.1055    raeburn  12901:     my $count = 0;
                   12902:     my $depth = 0;
                   12903:     my $datatable;
1.1056    raeburn  12904:     my @hierarchy;
1.1055    raeburn  12905:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  12906:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   12907:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  12908:     foreach my $item (@{$contents}) {
                   12909:         $count ++;
1.1056    raeburn  12910:         @{$dirorder->{$count}} = @hierarchy;
                   12911:         $titles->{$count} = $item;
1.1055    raeburn  12912:         &archive_hierarchy($depth,$count,$parent,$children);
                   12913:         if ($wantform) {
                   12914:             $datatable .= &archive_row($is_dir->{$item},$item,
                   12915:                                        $currdir,$depth,$count);
                   12916:         }
                   12917:         if ($is_dir->{$item}) {
                   12918:             $depth ++;
1.1056    raeburn  12919:             push(@hierarchy,$count);
                   12920:             $parent->{$depth} = $count;
1.1055    raeburn  12921:             $datatable .=
                   12922:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  12923:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   12924:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  12925:             $depth --;
1.1056    raeburn  12926:             pop(@hierarchy);
1.1055    raeburn  12927:         }
                   12928:     }
                   12929:     return ($count,$datatable);
                   12930: }
                   12931: 
                   12932: sub recurse_extracted_archive {
1.1056    raeburn  12933:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   12934:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  12935:     my $result='';
1.1056    raeburn  12936:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   12937:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   12938:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  12939:         return $result;
                   12940:     }
                   12941:     my $dirptr = 16384;
                   12942:     my ($newdirlistref,$newlisterror) =
                   12943:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   12944:     if (ref($newdirlistref) eq 'ARRAY') {
                   12945:         foreach my $dir_line (@{$newdirlistref}) {
                   12946:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   12947:             unless ($item =~ /^\.+$/) {
                   12948:                 $$count ++;
1.1056    raeburn  12949:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   12950:                 $titles->{$$count} = $item;
1.1055    raeburn  12951:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  12952: 
1.1055    raeburn  12953:                 my $is_dir;
                   12954:                 if ($dirptr&$testdir) {
                   12955:                     $is_dir = 1;
                   12956:                 }
                   12957:                 if ($wantform) {
                   12958:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   12959:                 }
                   12960:                 if ($is_dir) {
                   12961:                     $$depth ++;
1.1056    raeburn  12962:                     push(@{$hierarchy},$$count);
                   12963:                     $parent->{$$depth} = $$count;
1.1055    raeburn  12964:                     $result .=
                   12965:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   12966:                                                    $docuname,$depth,$count,
1.1056    raeburn  12967:                                                    $hierarchy,$dirorder,$children,
                   12968:                                                    $parent,$titles,$wantform);
1.1055    raeburn  12969:                     $$depth --;
1.1056    raeburn  12970:                     pop(@{$hierarchy});
1.1055    raeburn  12971:                 }
                   12972:             }
                   12973:         }
                   12974:     }
                   12975:     return $result;
                   12976: }
                   12977: 
                   12978: sub archive_hierarchy {
                   12979:     my ($depth,$count,$parent,$children) =@_;
                   12980:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   12981:         if (exists($parent->{$depth})) {
                   12982:              $children->{$parent->{$depth}} .= $count.':';
                   12983:         }
                   12984:     }
                   12985:     return;
                   12986: }
                   12987: 
                   12988: sub archive_row {
                   12989:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   12990:     my ($name) = ($item =~ m{([^/]+)$});
                   12991:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  12992:                                        'display'    => 'Add as file',
1.1055    raeburn  12993:                                        'dependency' => 'Include as dependency',
                   12994:                                        'discard'    => 'Discard',
                   12995:                                       );
                   12996:     if ($is_dir) {
1.1059    raeburn  12997:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  12998:     }
1.1056    raeburn  12999:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   13000:     my $offset = 0;
1.1055    raeburn  13001:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  13002:         $offset ++;
1.1065    raeburn  13003:         if ($action ne 'display') {
                   13004:             $offset ++;
                   13005:         }  
1.1055    raeburn  13006:         $output .= '<td><span class="LC_nobreak">'.
                   13007:                    '<label><input type="radio" name="archive_'.$count.
                   13008:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   13009:         my $text = $choices{$action};
                   13010:         if ($is_dir) {
                   13011:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   13012:             if ($action eq 'display') {
1.1059    raeburn  13013:                 $text = &mt('Add as folder');
1.1055    raeburn  13014:             }
1.1056    raeburn  13015:         } else {
                   13016:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   13017: 
                   13018:         }
                   13019:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   13020:         if ($action eq 'dependency') {
                   13021:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   13022:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   13023:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   13024:                        '<option value=""></option>'."\n".
                   13025:                        '</select>'."\n".
                   13026:                        '</div>';
1.1059    raeburn  13027:         } elsif ($action eq 'display') {
                   13028:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   13029:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   13030:                        '</div>';
1.1055    raeburn  13031:         }
1.1056    raeburn  13032:         $output .= '</td>';
1.1055    raeburn  13033:     }
                   13034:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   13035:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   13036:     for (my $i=0; $i<$depth; $i++) {
                   13037:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   13038:     }
                   13039:     if ($is_dir) {
                   13040:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   13041:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   13042:     } else {
                   13043:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   13044:     }
                   13045:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   13046:                &end_data_table_row();
                   13047:     return $output;
                   13048: }
                   13049: 
                   13050: sub archive_options_form {
1.1065    raeburn  13051:     my ($form,$display,$count,$hiddenelem) = @_;
                   13052:     my %lt = &Apache::lonlocal::texthash(
                   13053:                perm => 'Permanently remove archive file?',
                   13054:                hows => 'How should each extracted item be incorporated in the course?',
                   13055:                cont => 'Content actions for all',
                   13056:                addf => 'Add as folder/file',
                   13057:                incd => 'Include as dependency for a displayed file',
                   13058:                disc => 'Discard',
                   13059:                no   => 'No',
                   13060:                yes  => 'Yes',
                   13061:                save => 'Save',
                   13062:     );
                   13063:     my $output = <<"END";
                   13064: <form name="$form" method="post" action="">
                   13065: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   13066: <label>
                   13067:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   13068: </label>
                   13069: &nbsp;
                   13070: <label>
                   13071:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   13072: </span>
                   13073: </p>
                   13074: <input type="hidden" name="phase" value="decompress_cleanup" />
                   13075: <br />$lt{'hows'}
                   13076: <div class="LC_columnSection">
                   13077:   <fieldset>
                   13078:     <legend>$lt{'cont'}</legend>
                   13079:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   13080:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   13081:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   13082:   </fieldset>
                   13083: </div>
                   13084: END
                   13085:     return $output.
1.1055    raeburn  13086:            &start_data_table()."\n".
1.1065    raeburn  13087:            $display."\n".
1.1055    raeburn  13088:            &end_data_table()."\n".
                   13089:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   13090:            $hiddenelem.
1.1065    raeburn  13091:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  13092:            '</form>';
                   13093: }
                   13094: 
                   13095: sub archive_javascript {
1.1056    raeburn  13096:     my ($startcount,$numitems,$titles,$children) = @_;
                   13097:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  13098:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  13099:     my $scripttag = <<START;
                   13100: <script type="text/javascript">
                   13101: // <![CDATA[
                   13102: 
                   13103: function checkAll(form,prefix) {
                   13104:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   13105:     for (var i=0; i < form.elements.length; i++) {
                   13106:         var id = form.elements[i].id;
                   13107:         if ((id != '') && (id != undefined)) {
                   13108:             if (idstr.test(id)) {
                   13109:                 if (form.elements[i].type == 'radio') {
                   13110:                     form.elements[i].checked = true;
1.1056    raeburn  13111:                     var nostart = i-$startcount;
1.1059    raeburn  13112:                     var offset = nostart%7;
                   13113:                     var count = (nostart-offset)/7;    
1.1056    raeburn  13114:                     dependencyCheck(form,count,offset);
1.1055    raeburn  13115:                 }
                   13116:             }
                   13117:         }
                   13118:     }
                   13119: }
                   13120: 
                   13121: function propagateCheck(form,count) {
                   13122:     if (count > 0) {
1.1059    raeburn  13123:         var startelement = $startcount + ((count-1) * 7);
                   13124:         for (var j=1; j<6; j++) {
                   13125:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  13126:                 var item = startelement + j; 
                   13127:                 if (form.elements[item].type == 'radio') {
                   13128:                     if (form.elements[item].checked) {
                   13129:                         containerCheck(form,count,j);
                   13130:                         break;
                   13131:                     }
1.1055    raeburn  13132:                 }
                   13133:             }
                   13134:         }
                   13135:     }
                   13136: }
                   13137: 
                   13138: numitems = $numitems
1.1056    raeburn  13139: var titles = new Array(numitems);
                   13140: var parents = new Array(numitems);
1.1055    raeburn  13141: for (var i=0; i<numitems; i++) {
1.1056    raeburn  13142:     parents[i] = new Array;
1.1055    raeburn  13143: }
1.1059    raeburn  13144: var maintitle = '$maintitle';
1.1055    raeburn  13145: 
                   13146: START
                   13147: 
1.1056    raeburn  13148:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   13149:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  13150:         for (my $i=0; $i<@contents; $i ++) {
                   13151:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   13152:         }
                   13153:     }
                   13154: 
1.1056    raeburn  13155:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   13156:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   13157:     }
                   13158: 
1.1055    raeburn  13159:     $scripttag .= <<END;
                   13160: 
                   13161: function containerCheck(form,count,offset) {
                   13162:     if (count > 0) {
1.1056    raeburn  13163:         dependencyCheck(form,count,offset);
1.1059    raeburn  13164:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  13165:         form.elements[item].checked = true;
                   13166:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   13167:             if (parents[count].length > 0) {
                   13168:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  13169:                     containerCheck(form,parents[count][j],offset);
                   13170:                 }
                   13171:             }
                   13172:         }
                   13173:     }
                   13174: }
                   13175: 
                   13176: function dependencyCheck(form,count,offset) {
                   13177:     if (count > 0) {
1.1059    raeburn  13178:         var chosen = (offset+$startcount)+7*(count-1);
                   13179:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  13180:         var currtype = form.elements[depitem].type;
                   13181:         if (form.elements[chosen].value == 'dependency') {
                   13182:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   13183:             form.elements[depitem].options.length = 0;
                   13184:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11  raeburn  13185:             for (var i=1; i<=numitems; i++) {
                   13186:                 if (i == count) {
                   13187:                     continue;
                   13188:                 }
1.1059    raeburn  13189:                 var startelement = $startcount + (i-1) * 7;
                   13190:                 for (var j=1; j<6; j++) {
                   13191:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  13192:                         var item = startelement + j;
                   13193:                         if (form.elements[item].type == 'radio') {
                   13194:                             if (form.elements[item].checked) {
                   13195:                                 if (form.elements[item].value == 'display') {
                   13196:                                     var n = form.elements[depitem].options.length;
                   13197:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   13198:                                 }
                   13199:                             }
                   13200:                         }
                   13201:                     }
                   13202:                 }
                   13203:             }
                   13204:         } else {
                   13205:             document.getElementById('arc_depon_'+count).style.display='none';
                   13206:             form.elements[depitem].options.length = 0;
                   13207:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   13208:         }
1.1059    raeburn  13209:         titleCheck(form,count,offset);
1.1056    raeburn  13210:     }
                   13211: }
                   13212: 
                   13213: function propagateSelect(form,count,offset) {
                   13214:     if (count > 0) {
1.1065    raeburn  13215:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  13216:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   13217:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   13218:             if (parents[count].length > 0) {
                   13219:                 for (var j=0; j<parents[count].length; j++) {
                   13220:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  13221:                 }
                   13222:             }
                   13223:         }
                   13224:     }
                   13225: }
1.1056    raeburn  13226: 
                   13227: function containerSelect(form,count,offset,picked) {
                   13228:     if (count > 0) {
1.1065    raeburn  13229:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  13230:         if (form.elements[item].type == 'radio') {
                   13231:             if (form.elements[item].value == 'dependency') {
                   13232:                 if (form.elements[item+1].type == 'select-one') {
                   13233:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   13234:                         if (form.elements[item+1].options[i].value == picked) {
                   13235:                             form.elements[item+1].selectedIndex = i;
                   13236:                             break;
                   13237:                         }
                   13238:                     }
                   13239:                 }
                   13240:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   13241:                     if (parents[count].length > 0) {
                   13242:                         for (var j=0; j<parents[count].length; j++) {
                   13243:                             containerSelect(form,parents[count][j],offset,picked);
                   13244:                         }
                   13245:                     }
                   13246:                 }
                   13247:             }
                   13248:         }
                   13249:     }
                   13250: }
                   13251: 
1.1059    raeburn  13252: function titleCheck(form,count,offset) {
                   13253:     if (count > 0) {
                   13254:         var chosen = (offset+$startcount)+7*(count-1);
                   13255:         var depitem = $startcount + ((count-1) * 7) + 2;
                   13256:         var currtype = form.elements[depitem].type;
                   13257:         if (form.elements[chosen].value == 'display') {
                   13258:             document.getElementById('arc_title_'+count).style.display='block';
                   13259:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   13260:                 document.getElementById('archive_title_'+count).value=maintitle;
                   13261:             }
                   13262:         } else {
                   13263:             document.getElementById('arc_title_'+count).style.display='none';
                   13264:             if (currtype == 'text') { 
                   13265:                 document.getElementById('archive_title_'+count).value='';
                   13266:             }
                   13267:         }
                   13268:     }
                   13269:     return;
                   13270: }
                   13271: 
1.1055    raeburn  13272: // ]]>
                   13273: </script>
                   13274: END
                   13275:     return $scripttag;
                   13276: }
                   13277: 
                   13278: sub process_extracted_files {
1.1067    raeburn  13279:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  13280:     my $numitems = $env{'form.archive_count'};
1.1075.2.128  raeburn  13281:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  13282:     my @ids=&Apache::lonnet::current_machine_ids();
                   13283:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  13284:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  13285:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   13286:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   13287:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   13288:         $pathtocheck = "$dir_root/$destination";
                   13289:         $dir = $dir_root;
                   13290:         $ishome = 1;
                   13291:     } else {
                   13292:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   13293:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1075.2.128  raeburn  13294:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  13295:     }
                   13296:     my $currdir = "$dir_root/$destination";
                   13297:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   13298:     if ($env{'form.folderpath'}) {
                   13299:         my @items = split('&',$env{'form.folderpath'});
                   13300:         $folders{'0'} = $items[-2];
1.1075.2.17  raeburn  13301:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   13302:             $containers{'0'}='page';
                   13303:         } else {
                   13304:             $containers{'0'}='sequence';
                   13305:         }
1.1055    raeburn  13306:     }
                   13307:     my @archdirs = &get_env_multiple('form.archive_directory');
                   13308:     if ($numitems) {
                   13309:         for (my $i=1; $i<=$numitems; $i++) {
                   13310:             my $path = $env{'form.archive_content_'.$i};
                   13311:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   13312:                 my $item = $1;
                   13313:                 $toplevelitems{$item} = $i;
                   13314:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   13315:                     $is_dir{$item} = 1;
                   13316:                 }
                   13317:             }
                   13318:         }
                   13319:     }
1.1067    raeburn  13320:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  13321:     if (keys(%toplevelitems) > 0) {
                   13322:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  13323:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   13324:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  13325:     }
1.1066    raeburn  13326:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  13327:     if ($numitems) {
                   13328:         for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11  raeburn  13329:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  13330:             my $path = $env{'form.archive_content_'.$i};
                   13331:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13332:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   13333:                     if ($prefix ne '' && $path ne '') {
                   13334:                         if (-e $prefix.$path) {
1.1066    raeburn  13335:                             if ((@archdirs > 0) && 
                   13336:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   13337:                                 $todeletedir{$prefix.$path} = 1;
                   13338:                             } else {
                   13339:                                 $todelete{$prefix.$path} = 1;
                   13340:                             }
1.1055    raeburn  13341:                         }
                   13342:                     }
                   13343:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  13344:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  13345:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  13346:                     $docstitle = $env{'form.archive_title_'.$i};
                   13347:                     if ($docstitle eq '') {
                   13348:                         $docstitle = $title;
                   13349:                     }
1.1055    raeburn  13350:                     $outer = 0;
1.1056    raeburn  13351:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13352:                         if (@{$dirorder{$i}} > 0) {
                   13353:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  13354:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   13355:                                     $outer = $item;
                   13356:                                     last;
                   13357:                                 }
                   13358:                             }
                   13359:                         }
                   13360:                     }
                   13361:                     my ($errtext,$fatal) = 
                   13362:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   13363:                                                '/'.$folders{$outer}.'.'.
                   13364:                                                $containers{$outer});
                   13365:                     next if ($fatal);
                   13366:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   13367:                         if ($context eq 'coursedocs') {
1.1056    raeburn  13368:                             $mapinner{$i} = time;
1.1055    raeburn  13369:                             $folders{$i} = 'default_'.$mapinner{$i};
                   13370:                             $containers{$i} = 'sequence';
                   13371:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   13372:                                       $folders{$i}.'.'.$containers{$i};
                   13373:                             my $newidx = &LONCAPA::map::getresidx();
                   13374:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  13375:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  13376:                             push(@LONCAPA::map::order,$newidx);
                   13377:                             my ($outtext,$errtext) =
                   13378:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13379:                                                         $docuname.'/'.$folders{$outer}.
1.1075.2.11  raeburn  13380:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  13381:                             $newseqid{$i} = $newidx;
1.1067    raeburn  13382:                             unless ($errtext) {
1.1075.2.128  raeburn  13383:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   13384:                                                        &HTML::Entities::encode($docstitle,'<>&"'))..
                   13385:                                             '</li>'."\n";
1.1067    raeburn  13386:                             }
1.1055    raeburn  13387:                         }
                   13388:                     } else {
                   13389:                         if ($context eq 'coursedocs') {
                   13390:                             my $newidx=&LONCAPA::map::getresidx();
                   13391:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   13392:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   13393:                                       $title;
1.1075.2.128  raeburn  13394:                             if (($outer !~ /\D/) && ($mapinner{$outer} !~ /\D/) && ($newidx !~ /\D/)) {
                   13395:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   13396:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
1.1067    raeburn  13397:                                 }
1.1075.2.128  raeburn  13398:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13399:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   13400:                                 }
                   13401:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13402:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   13403:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   13404:                                         unless ($ishome) {
                   13405:                                             my $fetch = "$newdest{$i}/$title";
                   13406:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   13407:                                             $prompttofetch{$fetch} = 1;
                   13408:                                         }
                   13409:                                    }
                   13410:                                 }
                   13411:                                 $LONCAPA::map::resources[$newidx]=
                   13412:                                     $docstitle.':'.$url.':false:normal:res';
                   13413:                                 push(@LONCAPA::map::order, $newidx);
                   13414:                                 my ($outtext,$errtext)=
                   13415:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13416:                                                             $docuname.'/'.$folders{$outer}.
                   13417:                                                             '.'.$containers{$outer},1,1);
                   13418:                                 unless ($errtext) {
                   13419:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   13420:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   13421:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   13422:                                                    '</li>'."\n";
                   13423:                                     }
1.1067    raeburn  13424:                                 }
1.1075.2.128  raeburn  13425:                             } else {
                   13426:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13427:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1067    raeburn  13428:                             }
1.1055    raeburn  13429:                         }
                   13430:                     }
1.1075.2.11  raeburn  13431:                 }
                   13432:             } else {
1.1075.2.128  raeburn  13433:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13434:                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1075.2.11  raeburn  13435:             }
                   13436:         }
                   13437:         for (my $i=1; $i<=$numitems; $i++) {
                   13438:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   13439:             my $path = $env{'form.archive_content_'.$i};
                   13440:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13441:                 my ($title) = ($path =~ m{/([^/]+)$});
                   13442:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   13443:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   13444:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13445:                         my ($itemidx,$fullpath,$relpath);
                   13446:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   13447:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  13448:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11  raeburn  13449:                                 if ($dirorder{$i}->[$j] eq $container) {
                   13450:                                     $itemidx = $j;
1.1056    raeburn  13451:                                 }
                   13452:                             }
1.1075.2.11  raeburn  13453:                         }
                   13454:                         if ($itemidx eq '') {
                   13455:                             $itemidx =  0;
                   13456:                         }
                   13457:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   13458:                             if ($mapinner{$referrer{$i}}) {
                   13459:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   13460:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13461:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13462:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13463:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13464:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13465:                                             if (!-e $fullpath) {
                   13466:                                                 mkdir($fullpath,0755);
1.1056    raeburn  13467:                                             }
                   13468:                                         }
1.1075.2.11  raeburn  13469:                                     } else {
                   13470:                                         last;
1.1056    raeburn  13471:                                     }
1.1075.2.11  raeburn  13472:                                 }
                   13473:                             }
                   13474:                         } elsif ($newdest{$referrer{$i}}) {
                   13475:                             $fullpath = $newdest{$referrer{$i}};
                   13476:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13477:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   13478:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   13479:                                     last;
                   13480:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13481:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13482:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13483:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13484:                                         if (!-e $fullpath) {
                   13485:                                             mkdir($fullpath,0755);
1.1056    raeburn  13486:                                         }
                   13487:                                     }
1.1075.2.11  raeburn  13488:                                 } else {
                   13489:                                     last;
1.1056    raeburn  13490:                                 }
1.1075.2.11  raeburn  13491:                             }
                   13492:                         }
                   13493:                         if ($fullpath ne '') {
                   13494:                             if (-e "$prefix$path") {
1.1075.2.128  raeburn  13495:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   13496:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   13497:                                 }
1.1075.2.11  raeburn  13498:                             }
                   13499:                             if (-e "$fullpath/$title") {
                   13500:                                 my $showpath;
                   13501:                                 if ($relpath ne '') {
                   13502:                                     $showpath = "$relpath/$title";
                   13503:                                 } else {
                   13504:                                     $showpath = "/$title";
1.1056    raeburn  13505:                                 }
1.1075.2.128  raeburn  13506:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   13507:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   13508:                                            '</li>'."\n";
                   13509:                                 unless ($ishome) {
                   13510:                                     my $fetch = "$fullpath/$title";
                   13511:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   13512:                                     $prompttofetch{$fetch} = 1;
                   13513:                                 }
1.1055    raeburn  13514:                             }
                   13515:                         }
                   13516:                     }
1.1075.2.11  raeburn  13517:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   13518:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1075.2.128  raeburn  13519:                                     &HTML::Entities::encode($path,'<>&"'),
                   13520:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   13521:                                 '<br />';
1.1055    raeburn  13522:                 }
                   13523:             } else {
1.1075.2.128  raeburn  13524:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13525:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  13526:             }
                   13527:         }
                   13528:         if (keys(%todelete)) {
                   13529:             foreach my $key (keys(%todelete)) {
                   13530:                 unlink($key);
1.1066    raeburn  13531:             }
                   13532:         }
                   13533:         if (keys(%todeletedir)) {
                   13534:             foreach my $key (keys(%todeletedir)) {
                   13535:                 rmdir($key);
                   13536:             }
                   13537:         }
                   13538:         foreach my $dir (sort(keys(%is_dir))) {
                   13539:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   13540:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  13541:             }
                   13542:         }
1.1067    raeburn  13543:         if ($result ne '') {
                   13544:             $output .= '<ul>'."\n".
                   13545:                        $result."\n".
                   13546:                        '</ul>';
                   13547:         }
                   13548:         unless ($ishome) {
                   13549:             my $replicationfail;
                   13550:             foreach my $item (keys(%prompttofetch)) {
                   13551:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   13552:                 unless ($fetchresult eq 'ok') {
                   13553:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   13554:                 }
                   13555:             }
                   13556:             if ($replicationfail) {
                   13557:                 $output .= '<p class="LC_error">'.
                   13558:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   13559:                            $replicationfail.
                   13560:                            '</ul></p>';
                   13561:             }
                   13562:         }
1.1055    raeburn  13563:     } else {
                   13564:         $warning = &mt('No items found in archive.');
                   13565:     }
                   13566:     if ($error) {
                   13567:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   13568:                    $error.'</p>'."\n";
                   13569:     }
                   13570:     if ($warning) {
                   13571:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   13572:     }
                   13573:     return $output;
                   13574: }
                   13575: 
1.1066    raeburn  13576: sub cleanup_empty_dirs {
                   13577:     my ($path) = @_;
                   13578:     if (($path ne '') && (-d $path)) {
                   13579:         if (opendir(my $dirh,$path)) {
                   13580:             my @dircontents = grep(!/^\./,readdir($dirh));
                   13581:             my $numitems = 0;
                   13582:             foreach my $item (@dircontents) {
                   13583:                 if (-d "$path/$item") {
1.1075.2.28  raeburn  13584:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  13585:                     if (-e "$path/$item") {
                   13586:                         $numitems ++;
                   13587:                     }
                   13588:                 } else {
                   13589:                     $numitems ++;
                   13590:                 }
                   13591:             }
                   13592:             if ($numitems == 0) {
                   13593:                 rmdir($path);
                   13594:             }
                   13595:             closedir($dirh);
                   13596:         }
                   13597:     }
                   13598:     return;
                   13599: }
                   13600: 
1.41      ng       13601: =pod
1.45      matthew  13602: 
1.1075.2.56  raeburn  13603: =item * &get_folder_hierarchy()
1.1068    raeburn  13604: 
                   13605: Provides hierarchy of names of folders/sub-folders containing the current
                   13606: item,
                   13607: 
                   13608: Inputs: 3
                   13609:      - $navmap - navmaps object
                   13610: 
                   13611:      - $map - url for map (either the trigger itself, or map containing
                   13612:                            the resource, which is the trigger).
                   13613: 
                   13614:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   13615: 
                   13616: Outputs: 1 @pathitems - array of folder/subfolder names.
                   13617: 
                   13618: =cut
                   13619: 
                   13620: sub get_folder_hierarchy {
                   13621:     my ($navmap,$map,$showitem) = @_;
                   13622:     my @pathitems;
                   13623:     if (ref($navmap)) {
                   13624:         my $mapres = $navmap->getResourceByUrl($map);
                   13625:         if (ref($mapres)) {
                   13626:             my $pcslist = $mapres->map_hierarchy();
                   13627:             if ($pcslist ne '') {
                   13628:                 my @pcs = split(/,/,$pcslist);
                   13629:                 foreach my $pc (@pcs) {
                   13630:                     if ($pc == 1) {
1.1075.2.38  raeburn  13631:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  13632:                     } else {
                   13633:                         my $res = $navmap->getByMapPc($pc);
                   13634:                         if (ref($res)) {
                   13635:                             my $title = $res->compTitle();
                   13636:                             $title =~ s/\W+/_/g;
                   13637:                             if ($title ne '') {
                   13638:                                 push(@pathitems,$title);
                   13639:                             }
                   13640:                         }
                   13641:                     }
                   13642:                 }
                   13643:             }
1.1071    raeburn  13644:             if ($showitem) {
                   13645:                 if ($mapres->{ID} eq '0.0') {
1.1075.2.38  raeburn  13646:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  13647:                 } else {
                   13648:                     my $maptitle = $mapres->compTitle();
                   13649:                     $maptitle =~ s/\W+/_/g;
                   13650:                     if ($maptitle ne '') {
                   13651:                         push(@pathitems,$maptitle);
                   13652:                     }
1.1068    raeburn  13653:                 }
                   13654:             }
                   13655:         }
                   13656:     }
                   13657:     return @pathitems;
                   13658: }
                   13659: 
                   13660: =pod
                   13661: 
1.1015    raeburn  13662: =item * &get_turnedin_filepath()
                   13663: 
                   13664: Determines path in a user's portfolio file for storage of files uploaded
                   13665: to a specific essayresponse or dropbox item.
                   13666: 
                   13667: Inputs: 3 required + 1 optional.
                   13668: $symb is symb for resource, $uname and $udom are for current user (required).
                   13669: $caller is optional (can be "submission", if routine is called when storing
                   13670: an upoaded file when "Submit Answer" button was pressed).
                   13671: 
                   13672: Returns array containing $path and $multiresp. 
                   13673: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   13674: than one file upload item.  Callers of routine should append partid as a 
                   13675: subdirectory to $path in cases where $multiresp is 1.
                   13676: 
                   13677: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   13678: 
                   13679: =cut
                   13680: 
                   13681: sub get_turnedin_filepath {
                   13682:     my ($symb,$uname,$udom,$caller) = @_;
                   13683:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   13684:     my $turnindir;
                   13685:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   13686:     $turnindir = $userhash{'turnindir'};
                   13687:     my ($path,$multiresp);
                   13688:     if ($turnindir eq '') {
                   13689:         if ($caller eq 'submission') {
                   13690:             $turnindir = &mt('turned in');
                   13691:             $turnindir =~ s/\W+/_/g;
                   13692:             my %newhash = (
                   13693:                             'turnindir' => $turnindir,
                   13694:                           );
                   13695:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   13696:         }
                   13697:     }
                   13698:     if ($turnindir ne '') {
                   13699:         $path = '/'.$turnindir.'/';
                   13700:         my ($multipart,$turnin,@pathitems);
                   13701:         my $navmap = Apache::lonnavmaps::navmap->new();
                   13702:         if (defined($navmap)) {
                   13703:             my $mapres = $navmap->getResourceByUrl($map);
                   13704:             if (ref($mapres)) {
                   13705:                 my $pcslist = $mapres->map_hierarchy();
                   13706:                 if ($pcslist ne '') {
                   13707:                     foreach my $pc (split(/,/,$pcslist)) {
                   13708:                         my $res = $navmap->getByMapPc($pc);
                   13709:                         if (ref($res)) {
                   13710:                             my $title = $res->compTitle();
                   13711:                             $title =~ s/\W+/_/g;
                   13712:                             if ($title ne '') {
1.1075.2.48  raeburn  13713:                                 if (($pc > 1) && (length($title) > 12)) {
                   13714:                                     $title = substr($title,0,12);
                   13715:                                 }
1.1015    raeburn  13716:                                 push(@pathitems,$title);
                   13717:                             }
                   13718:                         }
                   13719:                     }
                   13720:                 }
                   13721:                 my $maptitle = $mapres->compTitle();
                   13722:                 $maptitle =~ s/\W+/_/g;
                   13723:                 if ($maptitle ne '') {
1.1075.2.48  raeburn  13724:                     if (length($maptitle) > 12) {
                   13725:                         $maptitle = substr($maptitle,0,12);
                   13726:                     }
1.1015    raeburn  13727:                     push(@pathitems,$maptitle);
                   13728:                 }
                   13729:                 unless ($env{'request.state'} eq 'construct') {
                   13730:                     my $res = $navmap->getBySymb($symb);
                   13731:                     if (ref($res)) {
                   13732:                         my $partlist = $res->parts();
                   13733:                         my $totaluploads = 0;
                   13734:                         if (ref($partlist) eq 'ARRAY') {
                   13735:                             foreach my $part (@{$partlist}) {
                   13736:                                 my @types = $res->responseType($part);
                   13737:                                 my @ids = $res->responseIds($part);
                   13738:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   13739:                                     if ($types[$i] eq 'essay') {
                   13740:                                         my $partid = $part.'_'.$ids[$i];
                   13741:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   13742:                                             $totaluploads ++;
                   13743:                                         }
                   13744:                                     }
                   13745:                                 }
                   13746:                             }
                   13747:                             if ($totaluploads > 1) {
                   13748:                                 $multiresp = 1;
                   13749:                             }
                   13750:                         }
                   13751:                     }
                   13752:                 }
                   13753:             } else {
                   13754:                 return;
                   13755:             }
                   13756:         } else {
                   13757:             return;
                   13758:         }
                   13759:         my $restitle=&Apache::lonnet::gettitle($symb);
                   13760:         $restitle =~ s/\W+/_/g;
                   13761:         if ($restitle eq '') {
                   13762:             $restitle = ($resurl =~ m{/[^/]+$});
                   13763:             if ($restitle eq '') {
                   13764:                 $restitle = time;
                   13765:             }
                   13766:         }
1.1075.2.48  raeburn  13767:         if (length($restitle) > 12) {
                   13768:             $restitle = substr($restitle,0,12);
                   13769:         }
1.1015    raeburn  13770:         push(@pathitems,$restitle);
                   13771:         $path .= join('/',@pathitems);
                   13772:     }
                   13773:     return ($path,$multiresp);
                   13774: }
                   13775: 
                   13776: =pod
                   13777: 
1.464     albertel 13778: =back
1.41      ng       13779: 
1.112     bowersj2 13780: =head1 CSV Upload/Handling functions
1.38      albertel 13781: 
1.41      ng       13782: =over 4
                   13783: 
1.648     raeburn  13784: =item * &upfile_store($r)
1.41      ng       13785: 
                   13786: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 13787: needs $env{'form.upfile'}
1.41      ng       13788: returns $datatoken to be put into hidden field
                   13789: 
                   13790: =cut
1.31      albertel 13791: 
                   13792: sub upfile_store {
                   13793:     my $r=shift;
1.258     albertel 13794:     $env{'form.upfile'}=~s/\r/\n/gs;
                   13795:     $env{'form.upfile'}=~s/\f/\n/gs;
                   13796:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   13797:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 13798: 
1.1075.2.128  raeburn  13799:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   13800:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   13801:                                      time.'_'.$$);
                   13802:     return if ($datatoken eq '');
                   13803: 
1.31      albertel 13804:     {
1.158     raeburn  13805:         my $datafile = $r->dir_config('lonDaemons').
                   13806:                            '/tmp/'.$datatoken.'.tmp';
1.1075.2.128  raeburn  13807:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 13808:             print $fh $env{'form.upfile'};
1.158     raeburn  13809:             close($fh);
                   13810:         }
1.31      albertel 13811:     }
                   13812:     return $datatoken;
                   13813: }
                   13814: 
1.56      matthew  13815: =pod
                   13816: 
1.1075.2.128  raeburn  13817: =item * &load_tmp_file($r,$datatoken)
1.41      ng       13818: 
                   13819: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1075.2.128  raeburn  13820: $datatoken is the name to assign to the temporary file.
1.258     albertel 13821: sets $env{'form.upfile'} to the contents of the file
1.41      ng       13822: 
                   13823: =cut
1.31      albertel 13824: 
                   13825: sub load_tmp_file {
1.1075.2.128  raeburn  13826:     my ($r,$datatoken) = @_;
                   13827:     return if ($datatoken eq '');
1.31      albertel 13828:     my @studentdata=();
                   13829:     {
1.158     raeburn  13830:         my $studentfile = $r->dir_config('lonDaemons').
1.1075.2.128  raeburn  13831:                               '/tmp/'.$datatoken.'.tmp';
                   13832:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  13833:             @studentdata=<$fh>;
                   13834:             close($fh);
                   13835:         }
1.31      albertel 13836:     }
1.258     albertel 13837:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 13838: }
                   13839: 
1.1075.2.128  raeburn  13840: sub valid_datatoken {
                   13841:     my ($datatoken) = @_;
1.1075.2.131  raeburn  13842:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1075.2.128  raeburn  13843:         return $datatoken;
                   13844:     }
                   13845:     return;
                   13846: }
                   13847: 
1.56      matthew  13848: =pod
                   13849: 
1.648     raeburn  13850: =item * &upfile_record_sep()
1.41      ng       13851: 
                   13852: Separate uploaded file into records
                   13853: returns array of records,
1.258     albertel 13854: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       13855: 
                   13856: =cut
1.31      albertel 13857: 
                   13858: sub upfile_record_sep {
1.258     albertel 13859:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 13860:     } else {
1.248     albertel 13861: 	my @records;
1.258     albertel 13862: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 13863: 	    if ($line=~/^\s*$/) { next; }
                   13864: 	    push(@records,$line);
                   13865: 	}
                   13866: 	return @records;
1.31      albertel 13867:     }
                   13868: }
                   13869: 
1.56      matthew  13870: =pod
                   13871: 
1.648     raeburn  13872: =item * &record_sep($record)
1.41      ng       13873: 
1.258     albertel 13874: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       13875: 
                   13876: =cut
                   13877: 
1.263     www      13878: sub takeleft {
                   13879:     my $index=shift;
                   13880:     return substr('0000'.$index,-4,4);
                   13881: }
                   13882: 
1.31      albertel 13883: sub record_sep {
                   13884:     my $record=shift;
                   13885:     my %components=();
1.258     albertel 13886:     if ($env{'form.upfiletype'} eq 'xml') {
                   13887:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 13888:         my $i=0;
1.356     albertel 13889:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 13890:             $field=~s/^(\"|\')//;
                   13891:             $field=~s/(\"|\')$//;
1.263     www      13892:             $components{&takeleft($i)}=$field;
1.31      albertel 13893:             $i++;
                   13894:         }
1.258     albertel 13895:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 13896:         my $i=0;
1.356     albertel 13897:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 13898:             $field=~s/^(\"|\')//;
                   13899:             $field=~s/(\"|\')$//;
1.263     www      13900:             $components{&takeleft($i)}=$field;
1.31      albertel 13901:             $i++;
                   13902:         }
                   13903:     } else {
1.561     www      13904:         my $separator=',';
1.480     banghart 13905:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      13906:             $separator=';';
1.480     banghart 13907:         }
1.31      albertel 13908:         my $i=0;
1.561     www      13909: # the character we are looking for to indicate the end of a quote or a record 
                   13910:         my $looking_for=$separator;
                   13911: # do not add the characters to the fields
                   13912:         my $ignore=0;
                   13913: # we just encountered a separator (or the beginning of the record)
                   13914:         my $just_found_separator=1;
                   13915: # store the field we are working on here
                   13916:         my $field='';
                   13917: # work our way through all characters in record
                   13918:         foreach my $character ($record=~/(.)/g) {
                   13919:             if ($character eq $looking_for) {
                   13920:                if ($character ne $separator) {
                   13921: # Found the end of a quote, again looking for separator
                   13922:                   $looking_for=$separator;
                   13923:                   $ignore=1;
                   13924:                } else {
                   13925: # Found a separator, store away what we got
                   13926:                   $components{&takeleft($i)}=$field;
                   13927: 	          $i++;
                   13928:                   $just_found_separator=1;
                   13929:                   $ignore=0;
                   13930:                   $field='';
                   13931:                }
                   13932:                next;
                   13933:             }
                   13934: # single or double quotation marks after a separator indicate beginning of a quote
                   13935: # we are now looking for the end of the quote and need to ignore separators
                   13936:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   13937:                $looking_for=$character;
                   13938:                next;
                   13939:             }
                   13940: # ignore would be true after we reached the end of a quote
                   13941:             if ($ignore) { next; }
                   13942:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   13943:             $field.=$character;
                   13944:             $just_found_separator=0; 
1.31      albertel 13945:         }
1.561     www      13946: # catch the very last entry, since we never encountered the separator
                   13947:         $components{&takeleft($i)}=$field;
1.31      albertel 13948:     }
                   13949:     return %components;
                   13950: }
                   13951: 
1.144     matthew  13952: ######################################################
                   13953: ######################################################
                   13954: 
1.56      matthew  13955: =pod
                   13956: 
1.648     raeburn  13957: =item * &upfile_select_html()
1.41      ng       13958: 
1.144     matthew  13959: Return HTML code to select a file from the users machine and specify 
                   13960: the file type.
1.41      ng       13961: 
                   13962: =cut
                   13963: 
1.144     matthew  13964: ######################################################
                   13965: ######################################################
1.31      albertel 13966: sub upfile_select_html {
1.144     matthew  13967:     my %Types = (
                   13968:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 13969:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  13970:                  space => &mt('Space separated'),
                   13971:                  tab   => &mt('Tabulator separated'),
                   13972: #                 xml   => &mt('HTML/XML'),
                   13973:                  );
                   13974:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  13975:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  13976:     foreach my $type (sort(keys(%Types))) {
                   13977:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   13978:     }
                   13979:     $Str .= "</select>\n";
                   13980:     return $Str;
1.31      albertel 13981: }
                   13982: 
1.301     albertel 13983: sub get_samples {
                   13984:     my ($records,$toget) = @_;
                   13985:     my @samples=({});
                   13986:     my $got=0;
                   13987:     foreach my $rec (@$records) {
                   13988: 	my %temp = &record_sep($rec);
                   13989: 	if (! grep(/\S/, values(%temp))) { next; }
                   13990: 	if (%temp) {
                   13991: 	    $samples[$got]=\%temp;
                   13992: 	    $got++;
                   13993: 	    if ($got == $toget) { last; }
                   13994: 	}
                   13995:     }
                   13996:     return \@samples;
                   13997: }
                   13998: 
1.144     matthew  13999: ######################################################
                   14000: ######################################################
                   14001: 
1.56      matthew  14002: =pod
                   14003: 
1.648     raeburn  14004: =item * &csv_print_samples($r,$records)
1.41      ng       14005: 
                   14006: Prints a table of sample values from each column uploaded $r is an
                   14007: Apache Request ref, $records is an arrayref from
                   14008: &Apache::loncommon::upfile_record_sep
                   14009: 
                   14010: =cut
                   14011: 
1.144     matthew  14012: ######################################################
                   14013: ######################################################
1.31      albertel 14014: sub csv_print_samples {
                   14015:     my ($r,$records) = @_;
1.662     bisitz   14016:     my $samples = &get_samples($records,5);
1.301     albertel 14017: 
1.594     raeburn  14018:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   14019:               &start_data_table_header_row());
1.356     albertel 14020:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   14021:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  14022:     $r->print(&end_data_table_header_row());
1.301     albertel 14023:     foreach my $hash (@$samples) {
1.594     raeburn  14024: 	$r->print(&start_data_table_row());
1.356     albertel 14025: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 14026: 	    $r->print('<td>');
1.356     albertel 14027: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 14028: 	    $r->print('</td>');
                   14029: 	}
1.594     raeburn  14030: 	$r->print(&end_data_table_row());
1.31      albertel 14031:     }
1.594     raeburn  14032:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 14033: }
                   14034: 
1.144     matthew  14035: ######################################################
                   14036: ######################################################
                   14037: 
1.56      matthew  14038: =pod
                   14039: 
1.648     raeburn  14040: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       14041: 
                   14042: Prints a table to create associations between values and table columns.
1.144     matthew  14043: 
1.41      ng       14044: $r is an Apache Request ref,
                   14045: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  14046: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       14047: 
                   14048: =cut
                   14049: 
1.144     matthew  14050: ######################################################
                   14051: ######################################################
1.31      albertel 14052: sub csv_print_select_table {
                   14053:     my ($r,$records,$d) = @_;
1.301     albertel 14054:     my $i=0;
                   14055:     my $samples = &get_samples($records,1);
1.144     matthew  14056:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  14057: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  14058:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  14059:               '<th>'.&mt('Column').'</th>'.
                   14060:               &end_data_table_header_row()."\n");
1.356     albertel 14061:     foreach my $array_ref (@$d) {
                   14062: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  14063: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 14064: 
1.875     bisitz   14065: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  14066: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 14067: 	$r->print('<option value="none"></option>');
1.356     albertel 14068: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   14069: 	    $r->print('<option value="'.$sample.'"'.
                   14070:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   14071:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 14072: 	}
1.594     raeburn  14073: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 14074: 	$i++;
                   14075:     }
1.594     raeburn  14076:     $r->print(&end_data_table());
1.31      albertel 14077:     $i--;
                   14078:     return $i;
                   14079: }
1.56      matthew  14080: 
1.144     matthew  14081: ######################################################
                   14082: ######################################################
                   14083: 
1.56      matthew  14084: =pod
1.31      albertel 14085: 
1.648     raeburn  14086: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       14087: 
                   14088: Prints a table of sample values from the upload and can make associate samples to internal names.
                   14089: 
                   14090: $r is an Apache Request ref,
                   14091: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   14092: $d is an array of 2 element arrays (internal name, displayed name)
                   14093: 
                   14094: =cut
                   14095: 
1.144     matthew  14096: ######################################################
                   14097: ######################################################
1.31      albertel 14098: sub csv_samples_select_table {
                   14099:     my ($r,$records,$d) = @_;
                   14100:     my $i=0;
1.144     matthew  14101:     #
1.662     bisitz   14102:     my $max_samples = 5;
                   14103:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  14104:     $r->print(&start_data_table().
                   14105:               &start_data_table_header_row().'<th>'.
                   14106:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   14107:               &end_data_table_header_row());
1.301     albertel 14108: 
                   14109:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  14110: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  14111: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 14112: 	foreach my $option (@$d) {
                   14113: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  14114: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 14115:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  14116:                       $display.'</option>');
1.31      albertel 14117: 	}
                   14118: 	$r->print('</select></td><td>');
1.662     bisitz   14119: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 14120: 	    if (defined($samples->[$line]{$key})) { 
                   14121: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   14122: 	    }
                   14123: 	}
1.594     raeburn  14124: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 14125: 	$i++;
                   14126:     }
1.594     raeburn  14127:     $r->print(&end_data_table());
1.31      albertel 14128:     $i--;
                   14129:     return($i);
1.115     matthew  14130: }
                   14131: 
1.144     matthew  14132: ######################################################
                   14133: ######################################################
                   14134: 
1.115     matthew  14135: =pod
                   14136: 
1.648     raeburn  14137: =item * &clean_excel_name($name)
1.115     matthew  14138: 
                   14139: Returns a replacement for $name which does not contain any illegal characters.
                   14140: 
                   14141: =cut
                   14142: 
1.144     matthew  14143: ######################################################
                   14144: ######################################################
1.115     matthew  14145: sub clean_excel_name {
                   14146:     my ($name) = @_;
                   14147:     $name =~ s/[:\*\?\/\\]//g;
                   14148:     if (length($name) > 31) {
                   14149:         $name = substr($name,0,31);
                   14150:     }
                   14151:     return $name;
1.25      albertel 14152: }
1.84      albertel 14153: 
1.85      albertel 14154: =pod
                   14155: 
1.648     raeburn  14156: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 14157: 
                   14158: Returns either 1 or undef
                   14159: 
                   14160: 1 if the part is to be hidden, undef if it is to be shown
                   14161: 
                   14162: Arguments are:
                   14163: 
                   14164: $id the id of the part to be checked
                   14165: $symb, optional the symb of the resource to check
                   14166: $udom, optional the domain of the user to check for
                   14167: $uname, optional the username of the user to check for
                   14168: 
                   14169: =cut
1.84      albertel 14170: 
                   14171: sub check_if_partid_hidden {
                   14172:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 14173:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 14174: 					 $symb,$udom,$uname);
1.141     albertel 14175:     my $truth=1;
                   14176:     #if the string starts with !, then the list is the list to show not hide
                   14177:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 14178:     my @hiddenlist=split(/,/,$hiddenparts);
                   14179:     foreach my $checkid (@hiddenlist) {
1.141     albertel 14180: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 14181:     }
1.141     albertel 14182:     return !$truth;
1.84      albertel 14183: }
1.127     matthew  14184: 
1.138     matthew  14185: 
                   14186: ############################################################
                   14187: ############################################################
                   14188: 
                   14189: =pod
                   14190: 
1.157     matthew  14191: =back 
                   14192: 
1.138     matthew  14193: =head1 cgi-bin script and graphing routines
                   14194: 
1.157     matthew  14195: =over 4
                   14196: 
1.648     raeburn  14197: =item * &get_cgi_id()
1.138     matthew  14198: 
                   14199: Inputs: none
                   14200: 
                   14201: Returns an id which can be used to pass environment variables
                   14202: to various cgi-bin scripts.  These environment variables will
                   14203: be removed from the users environment after a given time by
                   14204: the routine &Apache::lonnet::transfer_profile_to_env.
                   14205: 
                   14206: =cut
                   14207: 
                   14208: ############################################################
                   14209: ############################################################
1.152     albertel 14210: my $uniq=0;
1.136     matthew  14211: sub get_cgi_id {
1.154     albertel 14212:     $uniq=($uniq+1)%100000;
1.280     albertel 14213:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  14214: }
                   14215: 
1.127     matthew  14216: ############################################################
                   14217: ############################################################
                   14218: 
                   14219: =pod
                   14220: 
1.648     raeburn  14221: =item * &DrawBarGraph()
1.127     matthew  14222: 
1.138     matthew  14223: Facilitates the plotting of data in a (stacked) bar graph.
                   14224: Puts plot definition data into the users environment in order for 
                   14225: graph.png to plot it.  Returns an <img> tag for the plot.
                   14226: The bars on the plot are labeled '1','2',...,'n'.
                   14227: 
                   14228: Inputs:
                   14229: 
                   14230: =over 4
                   14231: 
                   14232: =item $Title: string, the title of the plot
                   14233: 
                   14234: =item $xlabel: string, text describing the X-axis of the plot
                   14235: 
                   14236: =item $ylabel: string, text describing the Y-axis of the plot
                   14237: 
                   14238: =item $Max: scalar, the maximum Y value to use in the plot
                   14239: If $Max is < any data point, the graph will not be rendered.
                   14240: 
1.140     matthew  14241: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  14242: they are plotted.  If undefined, default values will be used.
                   14243: 
1.178     matthew  14244: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   14245: 
1.138     matthew  14246: =item @Values: An array of array references.  Each array reference holds data
                   14247: to be plotted in a stacked bar chart.
                   14248: 
1.239     matthew  14249: =item If the final element of @Values is a hash reference the key/value
                   14250: pairs will be added to the graph definition.
                   14251: 
1.138     matthew  14252: =back
                   14253: 
                   14254: Returns:
                   14255: 
                   14256: An <img> tag which references graph.png and the appropriate identifying
                   14257: information for the plot.
                   14258: 
1.127     matthew  14259: =cut
                   14260: 
                   14261: ############################################################
                   14262: ############################################################
1.134     matthew  14263: sub DrawBarGraph {
1.178     matthew  14264:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  14265:     #
                   14266:     if (! defined($colors)) {
                   14267:         $colors = ['#33ff00', 
                   14268:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   14269:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   14270:                   ]; 
                   14271:     }
1.228     matthew  14272:     my $extra_settings = {};
                   14273:     if (ref($Values[-1]) eq 'HASH') {
                   14274:         $extra_settings = pop(@Values);
                   14275:     }
1.127     matthew  14276:     #
1.136     matthew  14277:     my $identifier = &get_cgi_id();
                   14278:     my $id = 'cgi.'.$identifier;        
1.129     matthew  14279:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  14280:         return '';
                   14281:     }
1.225     matthew  14282:     #
                   14283:     my @Labels;
                   14284:     if (defined($labels)) {
                   14285:         @Labels = @$labels;
                   14286:     } else {
                   14287:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1075.2.119  raeburn  14288:             push(@Labels,$i+1);
1.225     matthew  14289:         }
                   14290:     }
                   14291:     #
1.129     matthew  14292:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  14293:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  14294:     my %ValuesHash;
                   14295:     my $NumSets=1;
                   14296:     foreach my $array (@Values) {
                   14297:         next if (! ref($array));
1.136     matthew  14298:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  14299:             join(',',@$array);
1.129     matthew  14300:     }
1.127     matthew  14301:     #
1.136     matthew  14302:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  14303:     if ($NumBars < 3) {
                   14304:         $width = 120+$NumBars*32;
1.220     matthew  14305:         $xskip = 1;
1.225     matthew  14306:         $bar_width = 30;
                   14307:     } elsif ($NumBars < 5) {
                   14308:         $width = 120+$NumBars*20;
                   14309:         $xskip = 1;
                   14310:         $bar_width = 20;
1.220     matthew  14311:     } elsif ($NumBars < 10) {
1.136     matthew  14312:         $width = 120+$NumBars*15;
                   14313:         $xskip = 1;
                   14314:         $bar_width = 15;
                   14315:     } elsif ($NumBars <= 25) {
                   14316:         $width = 120+$NumBars*11;
                   14317:         $xskip = 5;
                   14318:         $bar_width = 8;
                   14319:     } elsif ($NumBars <= 50) {
                   14320:         $width = 120+$NumBars*8;
                   14321:         $xskip = 5;
                   14322:         $bar_width = 4;
                   14323:     } else {
                   14324:         $width = 120+$NumBars*8;
                   14325:         $xskip = 5;
                   14326:         $bar_width = 4;
                   14327:     }
                   14328:     #
1.137     matthew  14329:     $Max = 1 if ($Max < 1);
                   14330:     if ( int($Max) < $Max ) {
                   14331:         $Max++;
                   14332:         $Max = int($Max);
                   14333:     }
1.127     matthew  14334:     $Title  = '' if (! defined($Title));
                   14335:     $xlabel = '' if (! defined($xlabel));
                   14336:     $ylabel = '' if (! defined($ylabel));
1.369     www      14337:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   14338:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   14339:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  14340:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  14341:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   14342:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   14343:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   14344:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14345:     $ValuesHash{$id.'.height'}   = $height;
                   14346:     $ValuesHash{$id.'.width'}    = $width;
                   14347:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   14348:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   14349:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  14350:     #
1.228     matthew  14351:     # Deal with other parameters
                   14352:     while (my ($key,$value) = each(%$extra_settings)) {
                   14353:         $ValuesHash{$id.'.'.$key} = $value;
                   14354:     }
                   14355:     #
1.646     raeburn  14356:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  14357:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14358: }
                   14359: 
                   14360: ############################################################
                   14361: ############################################################
                   14362: 
                   14363: =pod
                   14364: 
1.648     raeburn  14365: =item * &DrawXYGraph()
1.137     matthew  14366: 
1.138     matthew  14367: Facilitates the plotting of data in an XY graph.
                   14368: Puts plot definition data into the users environment in order for 
                   14369: graph.png to plot it.  Returns an <img> tag for the plot.
                   14370: 
                   14371: Inputs:
                   14372: 
                   14373: =over 4
                   14374: 
                   14375: =item $Title: string, the title of the plot
                   14376: 
                   14377: =item $xlabel: string, text describing the X-axis of the plot
                   14378: 
                   14379: =item $ylabel: string, text describing the Y-axis of the plot
                   14380: 
                   14381: =item $Max: scalar, the maximum Y value to use in the plot
                   14382: If $Max is < any data point, the graph will not be rendered.
                   14383: 
                   14384: =item $colors: Array ref containing the hex color codes for the data to be 
                   14385: plotted in.  If undefined, default values will be used.
                   14386: 
                   14387: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14388: 
                   14389: =item $Ydata: Array ref containing Array refs.  
1.185     www      14390: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  14391: 
                   14392: =item %Values: hash indicating or overriding any default values which are 
                   14393: passed to graph.png.  
                   14394: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14395: 
                   14396: =back
                   14397: 
                   14398: Returns:
                   14399: 
                   14400: An <img> tag which references graph.png and the appropriate identifying
                   14401: information for the plot.
                   14402: 
1.137     matthew  14403: =cut
                   14404: 
                   14405: ############################################################
                   14406: ############################################################
                   14407: sub DrawXYGraph {
                   14408:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   14409:     #
                   14410:     # Create the identifier for the graph
                   14411:     my $identifier = &get_cgi_id();
                   14412:     my $id = 'cgi.'.$identifier;
                   14413:     #
                   14414:     $Title  = '' if (! defined($Title));
                   14415:     $xlabel = '' if (! defined($xlabel));
                   14416:     $ylabel = '' if (! defined($ylabel));
                   14417:     my %ValuesHash = 
                   14418:         (
1.369     www      14419:          $id.'.title'  => &escape($Title),
                   14420:          $id.'.xlabel' => &escape($xlabel),
                   14421:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  14422:          $id.'.y_max_value'=> $Max,
                   14423:          $id.'.labels'     => join(',',@$Xlabels),
                   14424:          $id.'.PlotType'   => 'XY',
                   14425:          );
                   14426:     #
                   14427:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14428:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14429:     }
                   14430:     #
                   14431:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   14432:         return '';
                   14433:     }
                   14434:     my $NumSets=1;
1.138     matthew  14435:     foreach my $array (@{$Ydata}){
1.137     matthew  14436:         next if (! ref($array));
                   14437:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   14438:     }
1.138     matthew  14439:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  14440:     #
                   14441:     # Deal with other parameters
                   14442:     while (my ($key,$value) = each(%Values)) {
                   14443:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  14444:     }
                   14445:     #
1.646     raeburn  14446:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  14447:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14448: }
                   14449: 
                   14450: ############################################################
                   14451: ############################################################
                   14452: 
                   14453: =pod
                   14454: 
1.648     raeburn  14455: =item * &DrawXYYGraph()
1.138     matthew  14456: 
                   14457: Facilitates the plotting of data in an XY graph with two Y axes.
                   14458: Puts plot definition data into the users environment in order for 
                   14459: graph.png to plot it.  Returns an <img> tag for the plot.
                   14460: 
                   14461: Inputs:
                   14462: 
                   14463: =over 4
                   14464: 
                   14465: =item $Title: string, the title of the plot
                   14466: 
                   14467: =item $xlabel: string, text describing the X-axis of the plot
                   14468: 
                   14469: =item $ylabel: string, text describing the Y-axis of the plot
                   14470: 
                   14471: =item $colors: Array ref containing the hex color codes for the data to be 
                   14472: plotted in.  If undefined, default values will be used.
                   14473: 
                   14474: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14475: 
                   14476: =item $Ydata1: The first data set
                   14477: 
                   14478: =item $Min1: The minimum value of the left Y-axis
                   14479: 
                   14480: =item $Max1: The maximum value of the left Y-axis
                   14481: 
                   14482: =item $Ydata2: The second data set
                   14483: 
                   14484: =item $Min2: The minimum value of the right Y-axis
                   14485: 
                   14486: =item $Max2: The maximum value of the left Y-axis
                   14487: 
                   14488: =item %Values: hash indicating or overriding any default values which are 
                   14489: passed to graph.png.  
                   14490: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14491: 
                   14492: =back
                   14493: 
                   14494: Returns:
                   14495: 
                   14496: An <img> tag which references graph.png and the appropriate identifying
                   14497: information for the plot.
1.136     matthew  14498: 
                   14499: =cut
                   14500: 
                   14501: ############################################################
                   14502: ############################################################
1.137     matthew  14503: sub DrawXYYGraph {
                   14504:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   14505:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  14506:     #
                   14507:     # Create the identifier for the graph
                   14508:     my $identifier = &get_cgi_id();
                   14509:     my $id = 'cgi.'.$identifier;
                   14510:     #
                   14511:     $Title  = '' if (! defined($Title));
                   14512:     $xlabel = '' if (! defined($xlabel));
                   14513:     $ylabel = '' if (! defined($ylabel));
                   14514:     my %ValuesHash = 
                   14515:         (
1.369     www      14516:          $id.'.title'  => &escape($Title),
                   14517:          $id.'.xlabel' => &escape($xlabel),
                   14518:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  14519:          $id.'.labels' => join(',',@$Xlabels),
                   14520:          $id.'.PlotType' => 'XY',
                   14521:          $id.'.NumSets' => 2,
1.137     matthew  14522:          $id.'.two_axes' => 1,
                   14523:          $id.'.y1_max_value' => $Max1,
                   14524:          $id.'.y1_min_value' => $Min1,
                   14525:          $id.'.y2_max_value' => $Max2,
                   14526:          $id.'.y2_min_value' => $Min2,
1.136     matthew  14527:          );
                   14528:     #
1.137     matthew  14529:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14530:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14531:     }
                   14532:     #
                   14533:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   14534:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  14535:         return '';
                   14536:     }
                   14537:     my $NumSets=1;
1.137     matthew  14538:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  14539:         next if (! ref($array));
                   14540:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  14541:     }
                   14542:     #
                   14543:     # Deal with other parameters
                   14544:     while (my ($key,$value) = each(%Values)) {
                   14545:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  14546:     }
                   14547:     #
1.646     raeburn  14548:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 14549:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  14550: }
                   14551: 
                   14552: ############################################################
                   14553: ############################################################
                   14554: 
                   14555: =pod
                   14556: 
1.157     matthew  14557: =back 
                   14558: 
1.139     matthew  14559: =head1 Statistics helper routines?  
                   14560: 
                   14561: Bad place for them but what the hell.
                   14562: 
1.157     matthew  14563: =over 4
                   14564: 
1.648     raeburn  14565: =item * &chartlink()
1.139     matthew  14566: 
                   14567: Returns a link to the chart for a specific student.  
                   14568: 
                   14569: Inputs:
                   14570: 
                   14571: =over 4
                   14572: 
                   14573: =item $linktext: The text of the link
                   14574: 
                   14575: =item $sname: The students username
                   14576: 
                   14577: =item $sdomain: The students domain
                   14578: 
                   14579: =back
                   14580: 
1.157     matthew  14581: =back
                   14582: 
1.139     matthew  14583: =cut
                   14584: 
                   14585: ############################################################
                   14586: ############################################################
                   14587: sub chartlink {
                   14588:     my ($linktext, $sname, $sdomain) = @_;
                   14589:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      14590:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 14591:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  14592:        '">'.$linktext.'</a>';
1.153     matthew  14593: }
                   14594: 
                   14595: #######################################################
                   14596: #######################################################
                   14597: 
                   14598: =pod
                   14599: 
                   14600: =head1 Course Environment Routines
1.157     matthew  14601: 
                   14602: =over 4
1.153     matthew  14603: 
1.648     raeburn  14604: =item * &restore_course_settings()
1.153     matthew  14605: 
1.648     raeburn  14606: =item * &store_course_settings()
1.153     matthew  14607: 
                   14608: Restores/Store indicated form parameters from the course environment.
                   14609: Will not overwrite existing values of the form parameters.
                   14610: 
                   14611: Inputs: 
                   14612: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   14613: 
                   14614: a hash ref describing the data to be stored.  For example:
                   14615:    
                   14616: %Save_Parameters = ('Status' => 'scalar',
                   14617:     'chartoutputmode' => 'scalar',
                   14618:     'chartoutputdata' => 'scalar',
                   14619:     'Section' => 'array',
1.373     raeburn  14620:     'Group' => 'array',
1.153     matthew  14621:     'StudentData' => 'array',
                   14622:     'Maps' => 'array');
                   14623: 
                   14624: Returns: both routines return nothing
                   14625: 
1.631     raeburn  14626: =back
                   14627: 
1.153     matthew  14628: =cut
                   14629: 
                   14630: #######################################################
                   14631: #######################################################
                   14632: sub store_course_settings {
1.496     albertel 14633:     return &store_settings($env{'request.course.id'},@_);
                   14634: }
                   14635: 
                   14636: sub store_settings {
1.153     matthew  14637:     # save to the environment
                   14638:     # appenv the same items, just to be safe
1.300     albertel 14639:     my $udom  = $env{'user.domain'};
                   14640:     my $uname = $env{'user.name'};
1.496     albertel 14641:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14642:     my %SaveHash;
                   14643:     my %AppHash;
                   14644:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 14645:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 14646:         my $envname = 'environment.'.$basename;
1.258     albertel 14647:         if (exists($env{'form.'.$setting})) {
1.153     matthew  14648:             # Save this value away
                   14649:             if ($type eq 'scalar' &&
1.258     albertel 14650:                 (! exists($env{$envname}) || 
                   14651:                  $env{$envname} ne $env{'form.'.$setting})) {
                   14652:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   14653:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  14654:             } elsif ($type eq 'array') {
                   14655:                 my $stored_form;
1.258     albertel 14656:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  14657:                     $stored_form = join(',',
                   14658:                                         map {
1.369     www      14659:                                             &escape($_);
1.258     albertel 14660:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  14661:                 } else {
                   14662:                     $stored_form = 
1.369     www      14663:                         &escape($env{'form.'.$setting});
1.153     matthew  14664:                 }
                   14665:                 # Determine if the array contents are the same.
1.258     albertel 14666:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  14667:                     $SaveHash{$basename} = $stored_form;
                   14668:                     $AppHash{$envname}   = $stored_form;
                   14669:                 }
                   14670:             }
                   14671:         }
                   14672:     }
                   14673:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 14674:                                           $udom,$uname);
1.153     matthew  14675:     if ($put_result !~ /^(ok|delayed)/) {
                   14676:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   14677:                                  'got error:'.$put_result);
                   14678:     }
                   14679:     # Make sure these settings stick around in this session, too
1.646     raeburn  14680:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  14681:     return;
                   14682: }
                   14683: 
                   14684: sub restore_course_settings {
1.499     albertel 14685:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 14686: }
                   14687: 
                   14688: sub restore_settings {
                   14689:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14690:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 14691:         next if (exists($env{'form.'.$setting}));
1.496     albertel 14692:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  14693:             '.'.$setting;
1.258     albertel 14694:         if (exists($env{$envname})) {
1.153     matthew  14695:             if ($type eq 'scalar') {
1.258     albertel 14696:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  14697:             } elsif ($type eq 'array') {
1.258     albertel 14698:                 $env{'form.'.$setting} = [ 
1.153     matthew  14699:                                            map { 
1.369     www      14700:                                                &unescape($_); 
1.258     albertel 14701:                                            } split(',',$env{$envname})
1.153     matthew  14702:                                            ];
                   14703:             }
                   14704:         }
                   14705:     }
1.127     matthew  14706: }
                   14707: 
1.618     raeburn  14708: #######################################################
                   14709: #######################################################
                   14710: 
                   14711: =pod
                   14712: 
                   14713: =head1 Domain E-mail Routines  
                   14714: 
                   14715: =over 4
                   14716: 
1.648     raeburn  14717: =item * &build_recipient_list()
1.618     raeburn  14718: 
1.1075.2.44  raeburn  14719: Build recipient lists for following types of e-mail:
1.766     raeburn  14720: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1075.2.44  raeburn  14721: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   14722: module change checking, student/employee ID conflict checks, as
                   14723: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   14724: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  14725: 
                   14726: Inputs:
1.1075.2.44  raeburn  14727: defmail (scalar - email address of default recipient),
                   14728: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   14729: requestsmail, updatesmail, or idconflictsmail).
                   14730: 
1.619     raeburn  14731: defdom (domain for which to retrieve configuration settings),
1.1075.2.44  raeburn  14732: 
                   14733: origmail (scalar - email address of recipient from loncapa.conf,
                   14734: i.e., predates configuration by DC via domainprefs.pm
1.618     raeburn  14735: 
1.1075.2.139  raeburn  14736: $requname username of requester (if mailing type is helpdeskmail)
                   14737: 
                   14738: $requdom domain of requester (if mailing type is helpdeskmail)
                   14739: 
                   14740: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
                   14741: 
1.655     raeburn  14742: Returns: comma separated list of addresses to which to send e-mail.
                   14743: 
                   14744: =back
1.618     raeburn  14745: 
                   14746: =cut
                   14747: 
                   14748: ############################################################
                   14749: ############################################################
                   14750: sub build_recipient_list {
1.1075.2.139  raeburn  14751:     my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618     raeburn  14752:     my @recipients;
1.1075.2.122  raeburn  14753:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  14754:     my %domconfig =
1.1075.2.122  raeburn  14755:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  14756:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  14757:         if (exists($domconfig{'contacts'}{$mailing})) {
                   14758:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   14759:                 my @contacts = ('adminemail','supportemail');
                   14760:                 foreach my $item (@contacts) {
                   14761:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   14762:                         my $addr = $domconfig{'contacts'}{$item}; 
                   14763:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14764:                             push(@recipients,$addr);
                   14765:                         }
1.619     raeburn  14766:                     }
1.1075.2.122  raeburn  14767:                 }
                   14768:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   14769:                 if ($mailing eq 'helpdeskmail') {
                   14770:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   14771:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   14772:                         my @ok_bccs;
                   14773:                         foreach my $bcc (@bccs) {
                   14774:                             $bcc =~ s/^\s+//g;
                   14775:                             $bcc =~ s/\s+$//g;
                   14776:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14777:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14778:                                     push(@ok_bccs,$bcc);
                   14779:                                 }
                   14780:                             }
                   14781:                         }
                   14782:                         if (@ok_bccs > 0) {
                   14783:                             $allbcc = join(', ',@ok_bccs);
                   14784:                         }
                   14785:                     }
                   14786:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  14787:                 }
                   14788:             }
1.766     raeburn  14789:         } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14790:             $lastresort = $origmail;
1.618     raeburn  14791:         }
1.1075.2.139  raeburn  14792:         if ($mailing eq 'helpdeskmail') {
                   14793:             if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
                   14794:                 (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
                   14795:                 my ($inststatus,$inststatus_checked);
                   14796:                 if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
                   14797:                     ($env{'user.domain'} ne 'public')) {
                   14798:                     $inststatus_checked = 1;
                   14799:                     $inststatus = $env{'environment.inststatus'};
                   14800:                 }
                   14801:                 unless ($inststatus_checked) {
                   14802:                     if (($requname ne '') && ($requdom ne '')) {
                   14803:                         if (($requname =~ /^$match_username$/) &&
                   14804:                             ($requdom =~ /^$match_domain$/) &&
                   14805:                             (&Apache::lonnet::domain($requdom))) {
                   14806:                             my $requhome = &Apache::lonnet::homeserver($requname,
                   14807:                                                                       $requdom);
                   14808:                             unless ($requhome eq 'no_host') {
                   14809:                                 my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
                   14810:                                 $inststatus = $userenv{'inststatus'};
                   14811:                                 $inststatus_checked = 1;
                   14812:                             }
                   14813:                         }
                   14814:                     }
                   14815:                 }
                   14816:                 unless ($inststatus_checked) {
                   14817:                     if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
                   14818:                         my %srch = (srchby     => 'email',
                   14819:                                     srchdomain => $defdom,
                   14820:                                     srchterm   => $reqemail,
                   14821:                                     srchtype   => 'exact');
                   14822:                         my %srch_results = &Apache::lonnet::usersearch(\%srch);
                   14823:                         foreach my $uname (keys(%srch_results)) {
                   14824:                             if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14825:                                 $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14826:                                 $inststatus_checked = 1;
                   14827:                                 last;
                   14828:                             }
                   14829:                         }
                   14830:                         unless ($inststatus_checked) {
                   14831:                             my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
                   14832:                             if ($dirsrchres eq 'ok') {
                   14833:                                 foreach my $uname (keys(%srch_results)) {
                   14834:                                     if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14835:                                         $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14836:                                         $inststatus_checked = 1;
                   14837:                                         last;
                   14838:                                     }
                   14839:                                 }
                   14840:                             }
                   14841:                         }
                   14842:                     }
                   14843:                 }
                   14844:                 if ($inststatus ne '') {
                   14845:                     foreach my $status (split(/\:/,$inststatus)) {
                   14846:                         if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
                   14847:                             my @contacts = ('adminemail','supportemail');
                   14848:                             foreach my $item (@contacts) {
                   14849:                                 if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
                   14850:                                     my $addr = $domconfig{'contacts'}{'overrides'}{$status};
                   14851:                                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14852:                                         push(@recipients,$addr);
                   14853:                                     }
                   14854:                                 }
                   14855:                             }
                   14856:                             $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
                   14857:                             if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
                   14858:                                 my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
                   14859:                                 my @ok_bccs;
                   14860:                                 foreach my $bcc (@bccs) {
                   14861:                                     $bcc =~ s/^\s+//g;
                   14862:                                     $bcc =~ s/\s+$//g;
                   14863:                                     if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14864:                                         if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14865:                                             push(@ok_bccs,$bcc);
                   14866:                                         }
                   14867:                                     }
                   14868:                                 }
                   14869:                                 if (@ok_bccs > 0) {
                   14870:                                     $allbcc = join(', ',@ok_bccs);
                   14871:                                 }
                   14872:                             }
                   14873:                             $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
                   14874:                             last;
                   14875:                         }
                   14876:                     }
                   14877:                 }
                   14878:             }
                   14879:         }
1.619     raeburn  14880:     } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14881:         $lastresort = $origmail;
                   14882:     }
1.1075.2.128  raeburn  14883:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1075.2.122  raeburn  14884:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   14885:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   14886:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   14887:             my %what = (
                   14888:                           perlvar => 1,
                   14889:                        );
                   14890:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   14891:             if ($primary) {
                   14892:                 my $gotaddr;
                   14893:                 my ($result,$returnhash) =
                   14894:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   14895:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   14896:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   14897:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   14898:                         $gotaddr = 1;
                   14899:                     }
                   14900:                 }
                   14901:                 unless ($gotaddr) {
                   14902:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   14903:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   14904:                     unless ($uintdom eq $intdom) {
                   14905:                         my %domconfig =
                   14906:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   14907:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   14908:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   14909:                                 my @contacts = ('adminemail','supportemail');
                   14910:                                 foreach my $item (@contacts) {
                   14911:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   14912:                                         my $addr = $domconfig{'contacts'}{$item};
                   14913:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14914:                                             push(@recipients,$addr);
                   14915:                                         }
                   14916:                                     }
                   14917:                                 }
                   14918:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   14919:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   14920:                                 }
                   14921:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   14922:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   14923:                                     my @ok_bccs;
                   14924:                                     foreach my $bcc (@bccs) {
                   14925:                                         $bcc =~ s/^\s+//g;
                   14926:                                         $bcc =~ s/\s+$//g;
                   14927:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14928:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14929:                                                 push(@ok_bccs,$bcc);
                   14930:                                             }
                   14931:                                         }
                   14932:                                     }
                   14933:                                     if (@ok_bccs > 0) {
                   14934:                                         $allbcc = join(', ',@ok_bccs);
                   14935:                                     }
                   14936:                                 }
                   14937:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   14938:                             }
                   14939:                         }
                   14940:                     }
                   14941:                 }
                   14942:             }
                   14943:         }
1.618     raeburn  14944:     }
1.688     raeburn  14945:     if (defined($defmail)) {
                   14946:         if ($defmail ne '') {
                   14947:             push(@recipients,$defmail);
                   14948:         }
1.618     raeburn  14949:     }
                   14950:     if ($otheremails) {
1.619     raeburn  14951:         my @others;
                   14952:         if ($otheremails =~ /,/) {
                   14953:             @others = split(/,/,$otheremails);
1.618     raeburn  14954:         } else {
1.619     raeburn  14955:             push(@others,$otheremails);
                   14956:         }
                   14957:         foreach my $addr (@others) {
                   14958:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14959:                 push(@recipients,$addr);
                   14960:             }
1.618     raeburn  14961:         }
                   14962:     }
1.1075.2.128  raeburn  14963:     if ($mailing eq 'helpdeskmail') {
1.1075.2.122  raeburn  14964:         if ((!@recipients) && ($lastresort ne '')) {
                   14965:             push(@recipients,$lastresort);
                   14966:         }
                   14967:     } elsif ($lastresort ne '') {
                   14968:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   14969:             push(@recipients,$lastresort);
                   14970:         }
                   14971:     }
                   14972:     my $recipientlist = join(',',@recipients);
                   14973:     if (wantarray) {
                   14974:         return ($recipientlist,$allbcc,$addtext);
                   14975:     } else {
                   14976:         return $recipientlist;
                   14977:     }
1.618     raeburn  14978: }
                   14979: 
1.127     matthew  14980: ############################################################
                   14981: ############################################################
1.154     albertel 14982: 
1.655     raeburn  14983: =pod
                   14984: 
                   14985: =head1 Course Catalog Routines
                   14986: 
                   14987: =over 4
                   14988: 
                   14989: =item * &gather_categories()
                   14990: 
                   14991: Converts category definitions - keys of categories hash stored in  
                   14992: coursecategories in configuration.db on the primary library server in a 
                   14993: domain - to an array.  Also generates javascript and idx hash used to 
                   14994: generate Domain Coordinator interface for editing Course Categories.
                   14995: 
                   14996: Inputs:
1.663     raeburn  14997: 
1.655     raeburn  14998: categories (reference to hash of category definitions).
1.663     raeburn  14999: 
1.655     raeburn  15000: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   15001:       categories and subcategories).
1.663     raeburn  15002: 
1.655     raeburn  15003: idx (reference to hash of counters used in Domain Coordinator interface for 
                   15004:       editing Course Categories).
1.663     raeburn  15005: 
1.655     raeburn  15006: jsarray (reference to array of categories used to create Javascript arrays for
                   15007:          Domain Coordinator interface for editing Course Categories).
                   15008: 
                   15009: Returns: nothing
                   15010: 
                   15011: Side effects: populates cats, idx and jsarray. 
                   15012: 
                   15013: =cut
                   15014: 
                   15015: sub gather_categories {
                   15016:     my ($categories,$cats,$idx,$jsarray) = @_;
                   15017:     my %counters;
                   15018:     my $num = 0;
                   15019:     foreach my $item (keys(%{$categories})) {
                   15020:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   15021:         if ($container eq '' && $depth == 0) {
                   15022:             $cats->[$depth][$categories->{$item}] = $cat;
                   15023:         } else {
                   15024:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   15025:         }
                   15026:         my ($escitem,$tail) = split(/:/,$item,2);
                   15027:         if ($counters{$tail} eq '') {
                   15028:             $counters{$tail} = $num;
                   15029:             $num ++;
                   15030:         }
                   15031:         if (ref($idx) eq 'HASH') {
                   15032:             $idx->{$item} = $counters{$tail};
                   15033:         }
                   15034:         if (ref($jsarray) eq 'ARRAY') {
                   15035:             push(@{$jsarray->[$counters{$tail}]},$item);
                   15036:         }
                   15037:     }
                   15038:     return;
                   15039: }
                   15040: 
                   15041: =pod
                   15042: 
                   15043: =item * &extract_categories()
                   15044: 
                   15045: Used to generate breadcrumb trails for course categories.
                   15046: 
                   15047: Inputs:
1.663     raeburn  15048: 
1.655     raeburn  15049: categories (reference to hash of category definitions).
1.663     raeburn  15050: 
1.655     raeburn  15051: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   15052:       categories and subcategories).
1.663     raeburn  15053: 
1.655     raeburn  15054: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  15055: 
1.655     raeburn  15056: allitems (reference to hash - key is category key 
                   15057:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  15058: 
1.655     raeburn  15059: idx (reference to hash of counters used in Domain Coordinator interface for
                   15060:       editing Course Categories).
1.663     raeburn  15061: 
1.655     raeburn  15062: jsarray (reference to array of categories used to create Javascript arrays for
                   15063:          Domain Coordinator interface for editing Course Categories).
                   15064: 
1.665     raeburn  15065: subcats (reference to hash of arrays containing all subcategories within each 
                   15066:          category, -recursive)
                   15067: 
1.1075.2.132  raeburn  15068: maxd (reference to hash used to hold max depth for all top-level categories).
                   15069: 
1.655     raeburn  15070: Returns: nothing
                   15071: 
                   15072: Side effects: populates trails and allitems hash references.
                   15073: 
                   15074: =cut
                   15075: 
                   15076: sub extract_categories {
1.1075.2.132  raeburn  15077:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655     raeburn  15078:     if (ref($categories) eq 'HASH') {
                   15079:         &gather_categories($categories,$cats,$idx,$jsarray);
                   15080:         if (ref($cats->[0]) eq 'ARRAY') {
                   15081:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   15082:                 my $name = $cats->[0][$i];
                   15083:                 my $item = &escape($name).'::0';
                   15084:                 my $trailstr;
                   15085:                 if ($name eq 'instcode') {
                   15086:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  15087:                 } elsif ($name eq 'communities') {
                   15088:                     $trailstr = &mt('Communities');
1.655     raeburn  15089:                 } else {
                   15090:                     $trailstr = $name;
                   15091:                 }
                   15092:                 if ($allitems->{$item} eq '') {
                   15093:                     push(@{$trails},$trailstr);
                   15094:                     $allitems->{$item} = scalar(@{$trails})-1;
                   15095:                 }
                   15096:                 my @parents = ($name);
                   15097:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   15098:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   15099:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  15100:                         if (ref($subcats) eq 'HASH') {
                   15101:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   15102:                         }
1.1075.2.132  raeburn  15103:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665     raeburn  15104:                     }
                   15105:                 } else {
                   15106:                     if (ref($subcats) eq 'HASH') {
                   15107:                         $subcats->{$item} = [];
1.655     raeburn  15108:                     }
1.1075.2.132  raeburn  15109:                     if (ref($maxd) eq 'HASH') {
                   15110:                         $maxd->{$name} = 1;
                   15111:                     }
1.655     raeburn  15112:                 }
                   15113:             }
                   15114:         }
                   15115:     }
                   15116:     return;
                   15117: }
                   15118: 
                   15119: =pod
                   15120: 
1.1075.2.56  raeburn  15121: =item * &recurse_categories()
1.655     raeburn  15122: 
                   15123: Recursively used to generate breadcrumb trails for course categories.
                   15124: 
                   15125: Inputs:
1.663     raeburn  15126: 
1.655     raeburn  15127: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   15128:       categories and subcategories).
1.663     raeburn  15129: 
1.655     raeburn  15130: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  15131: 
                   15132: category (current course category, for which breadcrumb trail is being generated).
                   15133: 
                   15134: trails (reference to array of breadcrumb trails for each category).
                   15135: 
1.655     raeburn  15136: allitems (reference to hash - key is category key
                   15137:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  15138: 
1.655     raeburn  15139: parents (array containing containers directories for current category, 
                   15140:          back to top level). 
                   15141: 
                   15142: Returns: nothing
                   15143: 
                   15144: Side effects: populates trails and allitems hash references
                   15145: 
                   15146: =cut
                   15147: 
                   15148: sub recurse_categories {
1.1075.2.132  raeburn  15149:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655     raeburn  15150:     my $shallower = $depth - 1;
                   15151:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   15152:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   15153:             my $name = $cats->[$depth]{$category}[$k];
                   15154:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   15155:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   15156:             if ($allitems->{$item} eq '') {
                   15157:                 push(@{$trails},$trailstr);
                   15158:                 $allitems->{$item} = scalar(@{$trails})-1;
                   15159:             }
                   15160:             my $deeper = $depth+1;
                   15161:             push(@{$parents},$category);
1.665     raeburn  15162:             if (ref($subcats) eq 'HASH') {
                   15163:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   15164:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   15165:                     my $higher;
                   15166:                     if ($j > 0) {
                   15167:                         $higher = &escape($parents->[$j]).':'.
                   15168:                                   &escape($parents->[$j-1]).':'.$j;
                   15169:                     } else {
                   15170:                         $higher = &escape($parents->[$j]).'::'.$j;
                   15171:                     }
                   15172:                     push(@{$subcats->{$higher}},$subcat);
                   15173:                 }
                   15174:             }
                   15175:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1075.2.132  raeburn  15176:                                 $subcats,$maxd);
1.655     raeburn  15177:             pop(@{$parents});
                   15178:         }
                   15179:     } else {
                   15180:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.132  raeburn  15181:         my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  15182:         if ($allitems->{$item} eq '') {
                   15183:             push(@{$trails},$trailstr);
                   15184:             $allitems->{$item} = scalar(@{$trails})-1;
                   15185:         }
1.1075.2.132  raeburn  15186:         if (ref($maxd) eq 'HASH') {
                   15187:             if ($depth > $maxd->{$parents->[0]}) {
                   15188:                 $maxd->{$parents->[0]} = $depth;
                   15189:             }
                   15190:         }
1.655     raeburn  15191:     }
                   15192:     return;
                   15193: }
                   15194: 
1.663     raeburn  15195: =pod
                   15196: 
1.1075.2.56  raeburn  15197: =item * &assign_categories_table()
1.663     raeburn  15198: 
                   15199: Create a datatable for display of hierarchical categories in a domain,
                   15200: with checkboxes to allow a course to be categorized. 
                   15201: 
                   15202: Inputs:
                   15203: 
                   15204: cathash - reference to hash of categories defined for the domain (from
                   15205:           configuration.db)
                   15206: 
                   15207: currcat - scalar with an & separated list of categories assigned to a course. 
                   15208: 
1.919     raeburn  15209: type    - scalar contains course type (Course or Community).
                   15210: 
1.1075.2.117  raeburn  15211: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   15212:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   15213: 
1.663     raeburn  15214: Returns: $output (markup to be displayed) 
                   15215: 
                   15216: =cut
                   15217: 
                   15218: sub assign_categories_table {
1.1075.2.117  raeburn  15219:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  15220:     my $output;
                   15221:     if (ref($cathash) eq 'HASH') {
1.1075.2.132  raeburn  15222:         my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
                   15223:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663     raeburn  15224:         $maxdepth = scalar(@cats);
                   15225:         if (@cats > 0) {
                   15226:             my $itemcount = 0;
                   15227:             if (ref($cats[0]) eq 'ARRAY') {
                   15228:                 my @currcategories;
                   15229:                 if ($currcat ne '') {
                   15230:                     @currcategories = split('&',$currcat);
                   15231:                 }
1.919     raeburn  15232:                 my $table;
1.663     raeburn  15233:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   15234:                     my $parent = $cats[0][$i];
1.919     raeburn  15235:                     next if ($parent eq 'instcode');
                   15236:                     if ($type eq 'Community') {
                   15237:                         next unless ($parent eq 'communities');
                   15238:                     } else {
                   15239:                         next if ($parent eq 'communities');
                   15240:                     }
1.663     raeburn  15241:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   15242:                     my $item = &escape($parent).'::0';
                   15243:                     my $checked = '';
                   15244:                     if (@currcategories > 0) {
                   15245:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   15246:                             $checked = ' checked="checked"';
1.663     raeburn  15247:                         }
                   15248:                     }
1.919     raeburn  15249:                     my $parent_title = $parent;
                   15250:                     if ($parent eq 'communities') {
                   15251:                         $parent_title = &mt('Communities');
                   15252:                     }
                   15253:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   15254:                               '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  15255:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  15256:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  15257:                     my $depth = 1;
                   15258:                     push(@path,$parent);
1.1075.2.117  raeburn  15259:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  15260:                     pop(@path);
1.919     raeburn  15261:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  15262:                     $itemcount ++;
                   15263:                 }
1.919     raeburn  15264:                 if ($itemcount) {
                   15265:                     $output = &Apache::loncommon::start_data_table().
                   15266:                               $table.
                   15267:                               &Apache::loncommon::end_data_table();
                   15268:                 }
1.663     raeburn  15269:             }
                   15270:         }
                   15271:     }
                   15272:     return $output;
                   15273: }
                   15274: 
                   15275: =pod
                   15276: 
1.1075.2.56  raeburn  15277: =item * &assign_category_rows()
1.663     raeburn  15278: 
                   15279: Create a datatable row for display of nested categories in a domain,
                   15280: with checkboxes to allow a course to be categorized,called recursively.
                   15281: 
                   15282: Inputs:
                   15283: 
                   15284: itemcount - track row number for alternating colors
                   15285: 
                   15286: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   15287:       categories and subcategories.
                   15288: 
                   15289: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   15290: 
                   15291: parent - parent of current category item
                   15292: 
                   15293: path - Array containing all categories back up through the hierarchy from the
                   15294:        current category to the top level.
                   15295: 
                   15296: currcategories - reference to array of current categories assigned to the course
                   15297: 
1.1075.2.117  raeburn  15298: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   15299:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   15300: 
1.663     raeburn  15301: Returns: $output (markup to be displayed).
                   15302: 
                   15303: =cut
                   15304: 
                   15305: sub assign_category_rows {
1.1075.2.117  raeburn  15306:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  15307:     my ($text,$name,$item,$chgstr);
                   15308:     if (ref($cats) eq 'ARRAY') {
                   15309:         my $maxdepth = scalar(@{$cats});
                   15310:         if (ref($cats->[$depth]) eq 'HASH') {
                   15311:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   15312:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   15313:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1075.2.45  raeburn  15314:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  15315:                 for (my $j=0; $j<$numchildren; $j++) {
                   15316:                     $name = $cats->[$depth]{$parent}[$j];
                   15317:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   15318:                     my $deeper = $depth+1;
                   15319:                     my $checked = '';
                   15320:                     if (ref($currcategories) eq 'ARRAY') {
                   15321:                         if (@{$currcategories} > 0) {
                   15322:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   15323:                                 $checked = ' checked="checked"';
1.663     raeburn  15324:                             }
                   15325:                         }
                   15326:                     }
1.664     raeburn  15327:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   15328:                              '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  15329:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  15330:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   15331:                              '</td><td>';
1.663     raeburn  15332:                     if (ref($path) eq 'ARRAY') {
                   15333:                         push(@{$path},$name);
1.1075.2.117  raeburn  15334:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  15335:                         pop(@{$path});
                   15336:                     }
                   15337:                     $text .= '</td></tr>';
                   15338:                 }
                   15339:                 $text .= '</table></td>';
                   15340:             }
                   15341:         }
                   15342:     }
                   15343:     return $text;
                   15344: }
                   15345: 
1.1075.2.69  raeburn  15346: =pod
                   15347: 
                   15348: =back
                   15349: 
                   15350: =cut
                   15351: 
1.655     raeburn  15352: ############################################################
                   15353: ############################################################
                   15354: 
                   15355: 
1.443     albertel 15356: sub commit_customrole {
1.664     raeburn  15357:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  15358:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 15359:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   15360:                          ($end?', ending '.localtime($end):'').': <b>'.
                   15361:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  15362:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 15363:                  '</b><br />';
                   15364:     return $output;
                   15365: }
                   15366: 
                   15367: sub commit_standardrole {
1.1075.2.31  raeburn  15368:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541     raeburn  15369:     my ($output,$logmsg,$linefeed);
                   15370:     if ($context eq 'auto') {
                   15371:         $linefeed = "\n";
                   15372:     } else {
                   15373:         $linefeed = "<br />\n";
                   15374:     }  
1.443     albertel 15375:     if ($three eq 'st') {
1.541     raeburn  15376:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31  raeburn  15377:                                          $one,$two,$sec,$context,$credits);
1.541     raeburn  15378:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  15379:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   15380:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 15381:         } else {
1.541     raeburn  15382:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 15383:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  15384:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   15385:             if ($context eq 'auto') {
                   15386:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   15387:             } else {
                   15388:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   15389:                &mt('Add to classlist').': <b>ok</b>';
                   15390:             }
                   15391:             $output .= $linefeed;
1.443     albertel 15392:         }
                   15393:     } else {
                   15394:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   15395:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  15396:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  15397:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  15398:         if ($context eq 'auto') {
                   15399:             $output .= $result.$linefeed;
                   15400:         } else {
                   15401:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   15402:         }
1.443     albertel 15403:     }
                   15404:     return $output;
                   15405: }
                   15406: 
                   15407: sub commit_studentrole {
1.1075.2.31  raeburn  15408:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
                   15409:         $credits) = @_;
1.626     raeburn  15410:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  15411:     if ($context eq 'auto') {
                   15412:         $linefeed = "\n";
                   15413:     } else {
                   15414:         $linefeed = '<br />'."\n";
                   15415:     }
1.443     albertel 15416:     if (defined($one) && defined($two)) {
                   15417:         my $cid=$one.'_'.$two;
                   15418:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   15419:         my $secchange = 0;
                   15420:         my $expire_role_result;
                   15421:         my $modify_section_result;
1.628     raeburn  15422:         if ($oldsec ne '-1') { 
                   15423:             if ($oldsec ne $sec) {
1.443     albertel 15424:                 $secchange = 1;
1.628     raeburn  15425:                 my $now = time;
1.443     albertel 15426:                 my $uurl='/'.$cid;
                   15427:                 $uurl=~s/\_/\//g;
                   15428:                 if ($oldsec) {
                   15429:                     $uurl.='/'.$oldsec;
                   15430:                 }
1.626     raeburn  15431:                 $oldsecurl = $uurl;
1.628     raeburn  15432:                 $expire_role_result = 
1.652     raeburn  15433:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  15434:                 if ($env{'request.course.sec'} ne '') { 
                   15435:                     if ($expire_role_result eq 'refused') {
                   15436:                         my @roles = ('st');
                   15437:                         my @statuses = ('previous');
                   15438:                         my @roledoms = ($one);
                   15439:                         my $withsec = 1;
                   15440:                         my %roleshash = 
                   15441:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   15442:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   15443:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   15444:                             my ($oldstart,$oldend) = 
                   15445:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   15446:                             if ($oldend > 0 && $oldend <= $now) {
                   15447:                                 $expire_role_result = 'ok';
                   15448:                             }
                   15449:                         }
                   15450:                     }
                   15451:                 }
1.443     albertel 15452:                 $result = $expire_role_result;
                   15453:             }
                   15454:         }
                   15455:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31  raeburn  15456:             $modify_section_result = 
                   15457:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   15458:                                                            undef,undef,undef,$sec,
                   15459:                                                            $end,$start,'','',$cid,
                   15460:                                                            '',$context,$credits);
1.443     albertel 15461:             if ($modify_section_result =~ /^ok/) {
                   15462:                 if ($secchange == 1) {
1.628     raeburn  15463:                     if ($sec eq '') {
                   15464:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   15465:                     } else {
                   15466:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   15467:                     }
1.443     albertel 15468:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  15469:                     if ($sec eq '') {
                   15470:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   15471:                     } else {
                   15472:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15473:                     }
1.443     albertel 15474:                 } else {
1.628     raeburn  15475:                     if ($sec eq '') {
                   15476:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   15477:                     } else {
                   15478:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15479:                     }
1.443     albertel 15480:                 }
                   15481:             } else {
1.628     raeburn  15482:                 if ($secchange) {       
                   15483:                     $$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;
                   15484:                 } else {
                   15485:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   15486:                 }
1.443     albertel 15487:             }
                   15488:             $result = $modify_section_result;
                   15489:         } elsif ($secchange == 1) {
1.628     raeburn  15490:             if ($oldsec eq '') {
1.1075.2.20  raeburn  15491:                 $$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  15492:             } else {
                   15493:                 $$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;
                   15494:             }
1.626     raeburn  15495:             if ($expire_role_result eq 'refused') {
                   15496:                 my $newsecurl = '/'.$cid;
                   15497:                 $newsecurl =~ s/\_/\//g;
                   15498:                 if ($sec ne '') {
                   15499:                     $newsecurl.='/'.$sec;
                   15500:                 }
                   15501:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   15502:                     if ($sec eq '') {
                   15503:                         $$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;
                   15504:                     } else {
                   15505:                         $$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;
                   15506:                     }
                   15507:                 }
                   15508:             }
1.443     albertel 15509:         }
                   15510:     } else {
1.626     raeburn  15511:         $$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 15512:         $result = "error: incomplete course id\n";
                   15513:     }
                   15514:     return $result;
                   15515: }
                   15516: 
1.1075.2.25  raeburn  15517: sub show_role_extent {
                   15518:     my ($scope,$context,$role) = @_;
                   15519:     $scope =~ s{^/}{};
                   15520:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   15521:     push(@courseroles,'co');
                   15522:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   15523:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   15524:         $scope =~ s{/}{_};
                   15525:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   15526:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   15527:         my ($audom,$auname) = split(/\//,$scope);
                   15528:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   15529:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   15530:     } else {
                   15531:         $scope =~ s{/$}{};
                   15532:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   15533:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   15534:     }
                   15535: }
                   15536: 
1.443     albertel 15537: ############################################################
                   15538: ############################################################
                   15539: 
1.566     albertel 15540: sub check_clone {
1.578     raeburn  15541:     my ($args,$linefeed) = @_;
1.566     albertel 15542:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   15543:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   15544:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1075.2.161.  .1(raebu 15545:21):     my $clonetitle;
                   15546:21):     my @clonemsg;
1.566     albertel 15547:     my $can_clone = 0;
1.944     raeburn  15548:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  15549:     if ($lctype ne 'community') {
                   15550:         $lctype = 'course';
                   15551:     }
1.566     albertel 15552:     if ($clonehome eq 'no_host') {
1.944     raeburn  15553:         if ($args->{'crstype'} eq 'Community') {
1.1075.2.161.  .1(raebu 15554:21):             push(@clonemsg,({
                   15555:21):                               mt => 'No new community created.',
                   15556:21):                               args => [],
                   15557:21):                             },
                   15558:21):                             {
                   15559:21):                               mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
                   15560:21):                               args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
                   15561:21):                             }));
1.908     raeburn  15562:         } else {
1.1075.2.161.  .1(raebu 15563:21):             push(@clonemsg,({
                   15564:21):                               mt => 'No new course created.',
                   15565:21):                               args => [],
                   15566:21):                             },
                   15567:21):                             {
                   15568:21):                               mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
                   15569:21):                               args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   15570:21):                             }));
                   15571:21):         }
1.566     albertel 15572:     } else {
                   15573: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1075.2.161.  .1(raebu 15574:21):         $clonetitle = $clonedesc{'description'};
1.944     raeburn  15575:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15576:             if ($clonedesc{'type'} ne 'Community') {
1.1075.2.161.  .1(raebu 15577:21):                 push(@clonemsg,({
                   15578:21):                                   mt => 'No new community created.',
                   15579:21):                                   args => [],
                   15580:21):                                 },
                   15581:21):                                 {
                   15582:21):                                   mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
                   15583:21):                                   args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   15584:21):                                 }));
                   15585:21):                 return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908     raeburn  15586:             }
                   15587:         }
1.1075.2.119  raeburn  15588: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  15589:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 15590: 	    $can_clone = 1;
                   15591: 	} else {
1.1075.2.95  raeburn  15592: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 15593: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1075.2.95  raeburn  15594:             if ($clonehash{'cloners'} eq '') {
                   15595:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   15596:                 if ($domdefs{'canclone'}) {
                   15597:                     unless ($domdefs{'canclone'} eq 'none') {
                   15598:                         if ($domdefs{'canclone'} eq 'domain') {
                   15599:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   15600:                                 $can_clone = 1;
                   15601:                             }
                   15602:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15603:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   15604:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   15605:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   15606:                                 $can_clone = 1;
                   15607:                             }
                   15608:                         }
                   15609:                     }
1.908     raeburn  15610:                 }
1.1075.2.95  raeburn  15611:             } else {
                   15612: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   15613:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  15614:                     $can_clone = 1;
1.1075.2.95  raeburn  15615:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  15616:                     $can_clone = 1;
1.1075.2.96  raeburn  15617:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   15618:                     $can_clone = 1;
1.1075.2.95  raeburn  15619:                 }
                   15620:                 unless ($can_clone) {
1.1075.2.96  raeburn  15621:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15622:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1075.2.95  raeburn  15623:                         my (%gotdomdefaults,%gotcodedefaults);
                   15624:                         foreach my $cloner (@cloners) {
                   15625:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   15626:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   15627:                                 my (%codedefaults,@code_order);
                   15628:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   15629:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   15630:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   15631:                                     }
                   15632:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   15633:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   15634:                                     }
                   15635:                                 } else {
                   15636:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   15637:                                                                             \%codedefaults,
                   15638:                                                                             \@code_order);
                   15639:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   15640:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   15641:                                 }
                   15642:                                 if (@code_order > 0) {
                   15643:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   15644:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   15645:                                                                                 $args->{'crscode'})) {
                   15646:                                         $can_clone = 1;
                   15647:                                         last;
                   15648:                                     }
                   15649:                                 }
                   15650:                             }
                   15651:                         }
                   15652:                     }
1.1075.2.96  raeburn  15653:                 }
                   15654:             }
                   15655:             unless ($can_clone) {
                   15656:                 my $ccrole = 'cc';
                   15657:                 if ($args->{'crstype'} eq 'Community') {
                   15658:                     $ccrole = 'co';
                   15659:                 }
                   15660:                 my %roleshash =
                   15661:                     &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   15662:                                                   $args->{'ccdomain'},
                   15663:                                                   'userroles',['active'],[$ccrole],
                   15664:                                                   [$args->{'clonedomain'}]);
                   15665:                 if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   15666:                     $can_clone = 1;
                   15667:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   15668:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   15669:                     $can_clone = 1;
1.1075.2.95  raeburn  15670:                 }
                   15671:             }
                   15672:             unless ($can_clone) {
                   15673:                 if ($args->{'crstype'} eq 'Community') {
1.1075.2.161.  .1(raebu 15674:21):                     push(@clonemsg,({
                   15675:21):                                       mt => 'No new community created.',
                   15676:21):                                       args => [],
                   15677:21):                                     },
                   15678:21):                                     {
                   15679:21):                                       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]).',
                   15680:21):                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   15681:21):                                     }));
1.1075.2.95  raeburn  15682:                 } else {
1.1075.2.161.  .1(raebu 15683:21):                     push(@clonemsg,({
                   15684:21):                                       mt => 'No new course created.',
                   15685:21):                                       args => [],
                   15686:21):                                     },
                   15687:21):                                     {
                   15688:21):                                       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]).',
                   15689:21):                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   15690:21):                                     }));
1.578     raeburn  15691: 	        }
1.566     albertel 15692: 	    }
1.578     raeburn  15693:         }
1.566     albertel 15694:     }
1.1075.2.161.  .1(raebu 15695:21):     return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566     albertel 15696: }
                   15697: 
1.444     albertel 15698: sub construct_course {
1.1075.2.119  raeburn  15699:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1075.2.161.  .1(raebu 15700:21):         $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
                   15701:21):     my ($outcome,$msgref,$clonemsgref);
1.541     raeburn  15702:     my $linefeed =  '<br />'."\n";
                   15703:     if ($context eq 'auto') {
                   15704:         $linefeed = "\n";
                   15705:     }
1.566     albertel 15706: 
                   15707: #
                   15708: # Are we cloning?
                   15709: #
1.1075.2.161.  .1(raebu 15710:21):     my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566     albertel 15711:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1075.2.161.  .1(raebu 15712:21): 	($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566     albertel 15713:         if (!$can_clone) {
1.1075.2.161.  .1(raebu 15714:21): 	    return (0,$outcome,$clonemsgref);
1.566     albertel 15715: 	}
                   15716:     }
                   15717: 
1.444     albertel 15718: #
                   15719: # Open course
                   15720: #
                   15721:     my $crstype = lc($args->{'crstype'});
                   15722:     my %cenv=();
                   15723:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   15724:                                              $args->{'cdescr'},
                   15725:                                              $args->{'curl'},
                   15726:                                              $args->{'course_home'},
                   15727:                                              $args->{'nonstandard'},
                   15728:                                              $args->{'crscode'},
                   15729:                                              $args->{'ccuname'}.':'.
                   15730:                                              $args->{'ccdomain'},
1.882     raeburn  15731:                                              $args->{'crstype'},
1.1075.2.161.  .1(raebu 15732:21):                                              $cnum,$context,$category,
                   15733:21):                                              $callercontext);
1.444     albertel 15734: 
                   15735:     # Note: The testing routines depend on this being output; see 
                   15736:     # Utils::Course. This needs to at least be output as a comment
                   15737:     # if anyone ever decides to not show this, and Utils::Course::new
                   15738:     # will need to be suitably modified.
1.1075.2.161.  .1(raebu 15739:21):     if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   15740:21):         $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
                   15741:21):     } else {
                   15742:21):         $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
                   15743:21):     }
1.943     raeburn  15744:     if ($$courseid =~ /^error:/) {
1.1075.2.161.  .1(raebu 15745:21):         return (0,$outcome,$clonemsgref);
1.943     raeburn  15746:     }
                   15747: 
1.444     albertel 15748: #
                   15749: # Check if created correctly
                   15750: #
1.479     albertel 15751:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 15752:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  15753:     if ($crsuhome eq 'no_host') {
1.1075.2.161.  .1(raebu 15754:21):         if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   15755:21):             $outcome .= &mt_user($user_lh,
                   15756:21):                             'Course creation failed, unrecognized course home server.');
                   15757:21):         } else {
                   15758:21):             $outcome .= &mt('Course creation failed, unrecognized course home server.');
                   15759:21):         }
                   15760:21):         $outcome .= $linefeed;
                   15761:21):         return (0,$outcome,$clonemsgref);
1.943     raeburn  15762:     }
1.541     raeburn  15763:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 15764: 
1.444     albertel 15765: #
1.566     albertel 15766: # Do the cloning
1.1075.2.161.  .1(raebu 15767:21): #
                   15768:21):     my @clonemsg;
1.566     albertel 15769:     if ($can_clone && $cloneid) {
1.1075.2.161.  .1(raebu 15770:21):         push(@clonemsg,
                   15771:21):                       {
                   15772:21):                           mt => 'Created [_1] by cloning from [_2]',
                   15773:21):                           args => [$crstype,$clonetitle],
                   15774:21):                       });
1.566     albertel 15775: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 15776: # Copy all files
1.1075.2.161.  .1(raebu 15777:21):         my @info =
                   15778:21):             &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
                   15779:21):                                                      $args->{'dateshift'},$args->{'crscode'},
                   15780:21):                                                      $args->{'ccuname'}.':'.$args->{'ccdomain'},
                   15781:21):                                                      $args->{'tinyurls'});
                   15782:21):         if (@info) {
                   15783:21):             push(@clonemsg,@info);
                   15784:21):         }
1.444     albertel 15785: # Restore URL
1.566     albertel 15786: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 15787: # Restore title
1.566     albertel 15788: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  15789: # Restore creation date, creator and creation context.
                   15790:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   15791:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   15792:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 15793: # Mark as cloned
1.566     albertel 15794: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      15795: # Need to clone grading mode
                   15796:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   15797:         $cenv{'grading'}=$newenv{'grading'};
                   15798: # Do not clone these environment entries
                   15799:         &Apache::lonnet::del('environment',
                   15800:                   ['default_enrollment_start_date',
                   15801:                    'default_enrollment_end_date',
                   15802:                    'question.email',
                   15803:                    'policy.email',
                   15804:                    'comment.email',
                   15805:                    'pch.users.denied',
1.725     raeburn  15806:                    'plc.users.denied',
                   15807:                    'hidefromcat',
1.1075.2.36  raeburn  15808:                    'checkforpriv',
1.1075.2.158  raeburn  15809:                    'categories'],
1.638     www      15810:                    $$crsudom,$$crsunum);
1.1075.2.63  raeburn  15811:         if ($args->{'textbook'}) {
                   15812:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   15813:         }
1.444     albertel 15814:     }
1.566     albertel 15815: 
1.444     albertel 15816: #
                   15817: # Set environment (will override cloned, if existing)
                   15818: #
                   15819:     my @sections = ();
                   15820:     my @xlists = ();
                   15821:     if ($args->{'crstype'}) {
                   15822:         $cenv{'type'}=$args->{'crstype'};
                   15823:     }
                   15824:     if ($args->{'crsid'}) {
                   15825:         $cenv{'courseid'}=$args->{'crsid'};
                   15826:     }
                   15827:     if ($args->{'crscode'}) {
                   15828:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   15829:     }
                   15830:     if ($args->{'crsquota'} ne '') {
                   15831:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   15832:     } else {
                   15833:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   15834:     }
                   15835:     if ($args->{'ccuname'}) {
                   15836:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   15837:                                         ':'.$args->{'ccdomain'};
                   15838:     } else {
                   15839:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   15840:     }
1.1075.2.31  raeburn  15841:     if ($args->{'defaultcredits'}) {
                   15842:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   15843:     }
1.444     albertel 15844:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   15845:     if ($args->{'crssections'}) {
                   15846:         $cenv{'internal.sectionnums'} = '';
                   15847:         if ($args->{'crssections'} =~ m/,/) {
                   15848:             @sections = split/,/,$args->{'crssections'};
                   15849:         } else {
                   15850:             $sections[0] = $args->{'crssections'};
                   15851:         }
                   15852:         if (@sections > 0) {
                   15853:             foreach my $item (@sections) {
                   15854:                 my ($sec,$gp) = split/:/,$item;
                   15855:                 my $class = $args->{'crscode'}.$sec;
                   15856:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   15857:                 $cenv{'internal.sectionnums'} .= $item.',';
                   15858:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  15859:                     push(@badclasses,$class);
1.444     albertel 15860:                 }
                   15861:             }
                   15862:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   15863:         }
                   15864:     }
                   15865: # do not hide course coordinator from staff listing, 
                   15866: # even if privileged
                   15867:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36  raeburn  15868: # add course coordinator's domain to domains to check for privileged users
                   15869: # if different to course domain
                   15870:     if ($$crsudom ne $args->{'ccdomain'}) {
                   15871:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   15872:     }
1.444     albertel 15873: # add crosslistings
                   15874:     if ($args->{'crsxlist'}) {
                   15875:         $cenv{'internal.crosslistings'}='';
                   15876:         if ($args->{'crsxlist'} =~ m/,/) {
                   15877:             @xlists = split/,/,$args->{'crsxlist'};
                   15878:         } else {
                   15879:             $xlists[0] = $args->{'crsxlist'};
                   15880:         }
                   15881:         if (@xlists > 0) {
                   15882:             foreach my $item (@xlists) {
                   15883:                 my ($xl,$gp) = split/:/,$item;
                   15884:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   15885:                 $cenv{'internal.crosslistings'} .= $item.',';
                   15886:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  15887:                     push(@badclasses,$xl);
1.444     albertel 15888:                 }
                   15889:             }
                   15890:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   15891:         }
                   15892:     }
                   15893:     if ($args->{'autoadds'}) {
                   15894:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   15895:     }
                   15896:     if ($args->{'autodrops'}) {
                   15897:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   15898:     }
                   15899: # check for notification of enrollment changes
                   15900:     my @notified = ();
                   15901:     if ($args->{'notify_owner'}) {
                   15902:         if ($args->{'ccuname'} ne '') {
                   15903:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   15904:         }
                   15905:     }
                   15906:     if ($args->{'notify_dc'}) {
                   15907:         if ($uname ne '') { 
1.630     raeburn  15908:             push(@notified,$uname.':'.$udom);
1.444     albertel 15909:         }
                   15910:     }
                   15911:     if (@notified > 0) {
                   15912:         my $notifylist;
                   15913:         if (@notified > 1) {
                   15914:             $notifylist = join(',',@notified);
                   15915:         } else {
                   15916:             $notifylist = $notified[0];
                   15917:         }
                   15918:         $cenv{'internal.notifylist'} = $notifylist;
                   15919:     }
                   15920:     if (@badclasses > 0) {
                   15921:         my %lt=&Apache::lonlocal::texthash(
1.1075.2.119  raeburn  15922:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   15923:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   15924:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 15925:         );
1.1075.2.119  raeburn  15926:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   15927:                            &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  15928:         if ($context eq 'auto') {
                   15929:             $outcome .= $badclass_msg.$linefeed;
1.1075.2.119  raeburn  15930:         } else {
1.566     albertel 15931:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1075.2.119  raeburn  15932:         }
                   15933:         foreach my $item (@badclasses) {
1.541     raeburn  15934:             if ($context eq 'auto') {
1.1075.2.119  raeburn  15935:                 $outcome .= " - $item\n";
1.541     raeburn  15936:             } else {
1.1075.2.119  raeburn  15937:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  15938:             }
1.1075.2.119  raeburn  15939:         }
                   15940:         if ($context eq 'auto') {
                   15941:             $outcome .= $linefeed;
                   15942:         } else {
                   15943:             $outcome .= "</ul><br /><br /></div>\n";
                   15944:         }
1.444     albertel 15945:     }
                   15946:     if ($args->{'no_end_date'}) {
                   15947:         $args->{'endaccess'} = 0;
                   15948:     }
                   15949:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   15950:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   15951:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   15952:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   15953:     if ($args->{'showphotos'}) {
                   15954:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   15955:     }
                   15956:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   15957:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   15958:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   15959:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  15960:             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'); 
                   15961:             if ($context eq 'auto') {
                   15962:                 $outcome .= $krb_msg;
                   15963:             } else {
1.566     albertel 15964:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  15965:             }
                   15966:             $outcome .= $linefeed;
1.444     albertel 15967:         }
                   15968:     }
                   15969:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   15970:        if ($args->{'setpolicy'}) {
                   15971:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15972:        }
                   15973:        if ($args->{'setcontent'}) {
                   15974:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15975:        }
1.1075.2.110  raeburn  15976:        if ($args->{'setcomment'}) {
                   15977:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15978:        }
1.444     albertel 15979:     }
                   15980:     if ($args->{'reshome'}) {
                   15981: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   15982: 	$cenv{'reshome'}=~s/\/+$/\//;
                   15983:     }
                   15984: #
                   15985: # course has keyed access
                   15986: #
                   15987:     if ($args->{'setkeys'}) {
                   15988:        $cenv{'keyaccess'}='yes';
                   15989:     }
                   15990: # if specified, key authority is not course, but user
                   15991: # only active if keyaccess is yes
                   15992:     if ($args->{'keyauth'}) {
1.487     albertel 15993: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   15994: 	$user = &LONCAPA::clean_username($user);
                   15995: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     15996: 	if ($user ne '' && $domain ne '') {
1.487     albertel 15997: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 15998: 	}
                   15999:     }
                   16000: 
1.1075.2.59  raeburn  16001: #
                   16002: #  generate and store uniquecode (available to course requester), if course should have one.
                   16003: #
                   16004:     if ($args->{'uniquecode'}) {
                   16005:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   16006:         if ($code) {
                   16007:             $cenv{'internal.uniquecode'} = $code;
                   16008:             my %crsinfo =
                   16009:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   16010:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   16011:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   16012:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   16013:             }
                   16014:             if (ref($coderef)) {
                   16015:                 $$coderef = $code;
                   16016:             }
                   16017:         }
                   16018:     }
                   16019: 
1.444     albertel 16020:     if ($args->{'disresdis'}) {
                   16021:         $cenv{'pch.roles.denied'}='st';
                   16022:     }
                   16023:     if ($args->{'disablechat'}) {
                   16024:         $cenv{'plc.roles.denied'}='st';
                   16025:     }
                   16026: 
                   16027:     # Record we've not yet viewed the Course Initialization Helper for this 
                   16028:     # course
                   16029:     $cenv{'course.helper.not.run'} = 1;
                   16030:     #
                   16031:     # Use new Randomseed
                   16032:     #
                   16033:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   16034:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   16035:     #
                   16036:     # The encryption code and receipt prefix for this course
                   16037:     #
                   16038:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   16039:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   16040:     #
                   16041:     # By default, use standard grading
                   16042:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   16043: 
1.541     raeburn  16044:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   16045:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 16046: #
                   16047: # Open all assignments
                   16048: #
                   16049:     if ($args->{'openall'}) {
1.1075.2.146  raeburn  16050:        my $opendate = time;
                   16051:        if ($args->{'openallfrom'} =~ /^\d+$/) {
                   16052:            $opendate = $args->{'openallfrom'};
                   16053:        }
1.444     albertel 16054:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1075.2.146  raeburn  16055:        my %storecontent = ($storeunder         => $opendate,
1.444     albertel 16056:                            $storeunder.'.type' => 'date_start');
1.1075.2.146  raeburn  16057:        $outcome .= &mt('All assignments open starting [_1]',
                   16058:                        &Apache::lonlocal::locallocaltime($opendate)).': '.
                   16059:                    &Apache::lonnet::cput
                   16060:                        ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 16061:    }
                   16062: #
                   16063: # Set first page
                   16064: #
                   16065:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   16066: 	    || ($cloneid)) {
1.445     albertel 16067: 	use LONCAPA::map;
1.444     albertel 16068: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 16069: 
                   16070: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   16071:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   16072: 
1.444     albertel 16073:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   16074:         my $title; my $url;
                   16075:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   16076: 	    $title=&mt('Syllabus');
1.444     albertel 16077:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   16078:         } else {
1.963     raeburn  16079:             $title=&mt('Table of Contents');
1.444     albertel 16080:             $url='/adm/navmaps';
                   16081:         }
1.445     albertel 16082: 
                   16083:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   16084: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   16085: 
                   16086: 	if ($errtext) { $fatal=2; }
1.541     raeburn  16087:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 16088:     }
1.566     albertel 16089: 
1.1075.2.161.  .1(raebu 16090:21):     return (1,$outcome,\@clonemsg);
1.444     albertel 16091: }
                   16092: 
1.1075.2.59  raeburn  16093: sub make_unique_code {
                   16094:     my ($cdom,$cnum) = @_;
                   16095:     # get lock on uniquecodes db
                   16096:     my $lockhash = {
                   16097:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   16098:                                                   ':'.$env{'user.domain'},
                   16099:                    };
                   16100:     my $tries = 0;
                   16101:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   16102:     my ($code,$error);
                   16103: 
                   16104:     while (($gotlock ne 'ok') && ($tries<3)) {
                   16105:         $tries ++;
                   16106:         sleep 1;
                   16107:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   16108:     }
                   16109:     if ($gotlock eq 'ok') {
                   16110:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   16111:         my $gotcode;
                   16112:         my $attempts = 0;
                   16113:         while ((!$gotcode) && ($attempts < 100)) {
                   16114:             $code = &generate_code();
                   16115:             if (!exists($currcodes{$code})) {
                   16116:                 $gotcode = 1;
                   16117:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   16118:                     $error = 'nostore';
                   16119:                 }
                   16120:             }
                   16121:             $attempts ++;
                   16122:         }
                   16123:         my @del_lock = ($cnum."\0".'uniquecodes');
                   16124:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   16125:     } else {
                   16126:         $error = 'nolock';
                   16127:     }
                   16128:     return ($code,$error);
                   16129: }
                   16130: 
                   16131: sub generate_code {
                   16132:     my $code;
                   16133:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   16134:     for (my $i=0; $i<6; $i++) {
                   16135:         my $lettnum = int (rand 2);
                   16136:         my $item = '';
                   16137:         if ($lettnum) {
                   16138:             $item = $letts[int( rand(18) )];
                   16139:         } else {
                   16140:             $item = 1+int( rand(8) );
                   16141:         }
                   16142:         $code .= $item;
                   16143:     }
                   16144:     return $code;
                   16145: }
                   16146: 
1.444     albertel 16147: ############################################################
                   16148: ############################################################
                   16149: 
1.953     droeschl 16150: #SD
                   16151: # only Community and Course, or anything else?
1.378     raeburn  16152: sub course_type {
                   16153:     my ($cid) = @_;
                   16154:     if (!defined($cid)) {
                   16155:         $cid = $env{'request.course.id'};
                   16156:     }
1.404     albertel 16157:     if (defined($env{'course.'.$cid.'.type'})) {
                   16158:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  16159:     } else {
                   16160:         return 'Course';
1.377     raeburn  16161:     }
                   16162: }
1.156     albertel 16163: 
1.406     raeburn  16164: sub group_term {
                   16165:     my $crstype = &course_type();
                   16166:     my %names = (
                   16167:                   'Course' => 'group',
1.865     raeburn  16168:                   'Community' => 'group',
1.406     raeburn  16169:                 );
                   16170:     return $names{$crstype};
                   16171: }
                   16172: 
1.902     raeburn  16173: sub course_types {
1.1075.2.59  raeburn  16174:     my @types = ('official','unofficial','community','textbook');
1.902     raeburn  16175:     my %typename = (
                   16176:                          official   => 'Official course',
                   16177:                          unofficial => 'Unofficial course',
                   16178:                          community  => 'Community',
1.1075.2.59  raeburn  16179:                          textbook   => 'Textbook course',
1.902     raeburn  16180:                    );
                   16181:     return (\@types,\%typename);
                   16182: }
                   16183: 
1.156     albertel 16184: sub icon {
                   16185:     my ($file)=@_;
1.505     albertel 16186:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 16187:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 16188:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 16189:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   16190: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   16191: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   16192: 	            $curfext.".gif") {
                   16193: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   16194: 		$curfext.".gif";
                   16195: 	}
                   16196:     }
1.249     albertel 16197:     return &lonhttpdurl($iconname);
1.154     albertel 16198: } 
1.84      albertel 16199: 
1.575     albertel 16200: sub lonhttpdurl {
1.692     www      16201: #
                   16202: # Had been used for "small fry" static images on separate port 8080.
                   16203: # Modify here if lightweight http functionality desired again.
                   16204: # Currently eliminated due to increasing firewall issues.
                   16205: #
1.575     albertel 16206:     my ($url)=@_;
1.692     www      16207:     return $url;
1.215     albertel 16208: }
                   16209: 
1.213     albertel 16210: sub connection_aborted {
                   16211:     my ($r)=@_;
                   16212:     $r->print(" ");$r->rflush();
                   16213:     my $c = $r->connection;
                   16214:     return $c->aborted();
                   16215: }
                   16216: 
1.221     foxr     16217: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     16218: #    strings as 'strings'.
                   16219: sub escape_single {
1.221     foxr     16220:     my ($input) = @_;
1.223     albertel 16221:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     16222:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   16223:     return $input;
                   16224: }
1.223     albertel 16225: 
1.222     foxr     16226: #  Same as escape_single, but escape's "'s  This 
                   16227: #  can be used for  "strings"
                   16228: sub escape_double {
                   16229:     my ($input) = @_;
                   16230:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   16231:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   16232:     return $input;
                   16233: }
1.223     albertel 16234:  
1.222     foxr     16235: #   Escapes the last element of a full URL.
                   16236: sub escape_url {
                   16237:     my ($url)   = @_;
1.238     raeburn  16238:     my @urlslices = split(/\//, $url,-1);
1.369     www      16239:     my $lastitem = &escape(pop(@urlslices));
1.1075.2.83  raeburn  16240:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     16241: }
1.462     albertel 16242: 
1.820     raeburn  16243: sub compare_arrays {
                   16244:     my ($arrayref1,$arrayref2) = @_;
                   16245:     my (@difference,%count);
                   16246:     @difference = ();
                   16247:     %count = ();
                   16248:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   16249:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   16250:         foreach my $element (keys(%count)) {
                   16251:             if ($count{$element} == 1) {
                   16252:                 push(@difference,$element);
                   16253:             }
                   16254:         }
                   16255:     }
                   16256:     return @difference;
                   16257: }
                   16258: 
1.1075.2.152  raeburn  16259: sub lon_status_items {
                   16260:     my %defaults = (
                   16261:                      E         => 100,
                   16262:                      W         => 4,
                   16263:                      N         => 1,
                   16264:                      U         => 5,
                   16265:                      threshold => 200,
                   16266:                      sysmail   => 2500,
                   16267:                    );
                   16268:     my %names = (
                   16269:                    E => 'Errors',
                   16270:                    W => 'Warnings',
                   16271:                    N => 'Notices',
                   16272:                    U => 'Unsent',
                   16273:                 );
                   16274:     return (\%defaults,\%names);
                   16275: }
                   16276: 
1.817     bisitz   16277: # -------------------------------------------------------- Initialize user login
1.462     albertel 16278: sub init_user_environment {
1.463     albertel 16279:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 16280:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   16281: 
                   16282:     my $public=($username eq 'public' && $domain eq 'public');
                   16283: 
                   16284: # See if old ID present, if so, remove
                   16285: 
1.1062    raeburn  16286:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 16287:     my $now=time;
                   16288: 
                   16289:     if ($public) {
                   16290: 	my $max_public=100;
                   16291: 	my $oldest;
                   16292: 	my $oldest_time=0;
                   16293: 	for(my $next=1;$next<=$max_public;$next++) {
                   16294: 	    if (-e $lonids."/publicuser_$next.id") {
                   16295: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   16296: 		if ($mtime<$oldest_time || !$oldest_time) {
                   16297: 		    $oldest_time=$mtime;
                   16298: 		    $oldest=$next;
                   16299: 		}
                   16300: 	    } else {
                   16301: 		$cookie="publicuser_$next";
                   16302: 		last;
                   16303: 	    }
                   16304: 	}
                   16305: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   16306:     } else {
1.463     albertel 16307: 	# if this isn't a robot, kill any existing non-robot sessions
                   16308: 	if (!$args->{'robot'}) {
                   16309: 	    opendir(DIR,$lonids);
                   16310: 	    while ($filename=readdir(DIR)) {
                   16311: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1075.2.136  raeburn  16312:                     if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
                   16313:                             &GDBM_READER(),0640)) {
                   16314:                         my $linkedfile;
                   16315:                         if (exists($oldenv{'user.linkedenv'})) {
                   16316:                             $linkedfile = $oldenv{'user.linkedenv'};
                   16317:                         }
                   16318:                         untie(%oldenv);
                   16319:                         if (unlink("$lonids/$filename")) {
                   16320:                             if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                   16321:                                 if (-l "$lonids/$linkedfile.id") {
                   16322:                                     unlink("$lonids/$linkedfile.id");
                   16323:                                 }
                   16324:                             }
                   16325:                         }
                   16326:                     } else {
                   16327:                         unlink($lonids.'/'.$filename);
                   16328:                     }
1.463     albertel 16329: 		}
1.462     albertel 16330: 	    }
1.463     albertel 16331: 	    closedir(DIR);
1.1075.2.84  raeburn  16332: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   16333:             my $namespace = 'nohist_courseeditor';
                   16334:             my $lockingkey = 'paste'."\0".'locked_num';
                   16335:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   16336:                                                 $domain,$username);
                   16337:             if (exists($lockhash{$lockingkey})) {
                   16338:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   16339:                 unless ($delresult eq 'ok') {
                   16340:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   16341:                 }
                   16342:             }
1.462     albertel 16343: 	}
                   16344: # Give them a new cookie
1.463     albertel 16345: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      16346: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 16347: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 16348:     
                   16349: # Initialize roles
                   16350: 
1.1062    raeburn  16351: 	($userroles,$firstaccenv,$timerintenv) = 
                   16352:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 16353:     }
                   16354: # ------------------------------------ Check browser type and MathML capability
                   16355: 
1.1075.2.77  raeburn  16356:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   16357:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 16358: 
                   16359: # ------------------------------------------------------------- Get environment
                   16360: 
                   16361:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   16362:     my ($tmp) = keys(%userenv);
                   16363:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   16364:     } else {
                   16365: 	undef(%userenv);
                   16366:     }
                   16367:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   16368: 	$form->{'interface'}=$userenv{'interface'};
                   16369:     }
                   16370:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   16371: 
                   16372: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   16373:     foreach my $option ('interface','localpath','localres') {
                   16374:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 16375:     }
                   16376: # --------------------------------------------------------- Write first profile
                   16377: 
                   16378:     {
1.1075.2.150  raeburn  16379:         my $ip = &Apache::lonnet::get_requestor_ip();
1.462     albertel 16380: 	my %initial_env = 
                   16381: 	    ("user.name"          => $username,
                   16382: 	     "user.domain"        => $domain,
                   16383: 	     "user.home"          => $authhost,
                   16384: 	     "browser.type"       => $clientbrowser,
                   16385: 	     "browser.version"    => $clientversion,
                   16386: 	     "browser.mathml"     => $clientmathml,
                   16387: 	     "browser.unicode"    => $clientunicode,
                   16388: 	     "browser.os"         => $clientos,
1.1075.2.42  raeburn  16389:              "browser.mobile"     => $clientmobile,
                   16390:              "browser.info"       => $clientinfo,
1.1075.2.77  raeburn  16391:              "browser.osversion"  => $clientosversion,
1.462     albertel 16392: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   16393: 	     "request.course.fn"  => '',
                   16394: 	     "request.course.uri" => '',
                   16395: 	     "request.course.sec" => '',
                   16396: 	     "request.role"       => 'cm',
                   16397: 	     "request.role.adv"   => $env{'user.adv'},
1.1075.2.150  raeburn  16398: 	     "request.host"       => $ip,);
1.462     albertel 16399: 
                   16400:         if ($form->{'localpath'}) {
                   16401: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   16402: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   16403:         }
                   16404: 	
                   16405: 	if ($form->{'interface'}) {
                   16406: 	    $form->{'interface'}=~s/\W//gs;
                   16407: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   16408: 	    $env{'browser.interface'}=$form->{'interface'};
                   16409: 	}
                   16410: 
1.1075.2.54  raeburn  16411:         if ($form->{'iptoken'}) {
                   16412:             my $lonhost = $r->dir_config('lonHostID');
                   16413:             $initial_env{"user.noloadbalance"} = $lonhost;
                   16414:             $env{'user.noloadbalance'} = $lonhost;
                   16415:         }
                   16416: 
1.1075.2.120  raeburn  16417:         if ($form->{'noloadbalance'}) {
                   16418:             my @hosts = &Apache::lonnet::current_machine_ids();
                   16419:             my $hosthere = $form->{'noloadbalance'};
                   16420:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   16421:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   16422:                 $env{'user.noloadbalance'} = $hosthere;
                   16423:             }
                   16424:         }
                   16425: 
1.1016    raeburn  16426:         unless ($domain eq 'public') {
1.1075.2.125  raeburn  16427:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   16428:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
1.980     raeburn  16429: 
1.1075.2.125  raeburn  16430:             foreach my $tool ('aboutme','blog','webdav','portfolio') {
                   16431:                 $userenv{'availabletools.'.$tool} = 
                   16432:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   16433:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   16434:             }
1.724     raeburn  16435: 
1.1075.2.125  raeburn  16436:             foreach my $crstype ('official','unofficial','community','textbook') {
                   16437:                 $userenv{'canrequest.'.$crstype} =
                   16438:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   16439:                                                       'reload','requestcourses',
                   16440:                                                       \%userenv,\%domdef,\%is_adv);
                   16441:             }
1.765     raeburn  16442: 
1.1075.2.125  raeburn  16443:             $userenv{'canrequest.author'} =
                   16444:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   16445:                                                   'reload','requestauthor',
                   16446:                                                   \%userenv,\%domdef,\%is_adv);
                   16447:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   16448:                                                  $domain,$username);
                   16449:             my $reqstatus = $reqauthor{'author_status'};
                   16450:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
                   16451:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   16452:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   16453:                                                       $reqauthor{'author'}{'timestamp'};
                   16454:                 }
1.1075.2.14  raeburn  16455:             }
                   16456:         }
                   16457: 
1.462     albertel 16458: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  16459: 
1.462     albertel 16460: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   16461: 		 &GDBM_WRCREAT(),0640)) {
                   16462: 	    &_add_to_env(\%disk_env,\%initial_env);
                   16463: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   16464: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  16465:             if (ref($firstaccenv) eq 'HASH') {
                   16466:                 &_add_to_env(\%disk_env,$firstaccenv);
                   16467:             }
                   16468:             if (ref($timerintenv) eq 'HASH') {
                   16469:                 &_add_to_env(\%disk_env,$timerintenv);
                   16470:             }
1.463     albertel 16471: 	    if (ref($args->{'extra_env'})) {
                   16472: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   16473: 	    }
1.462     albertel 16474: 	    untie(%disk_env);
                   16475: 	} else {
1.705     tempelho 16476: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   16477: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 16478: 	    return 'error: '.$!;
                   16479: 	}
                   16480:     }
                   16481:     $env{'request.role'}='cm';
                   16482:     $env{'request.role.adv'}=$env{'user.adv'};
                   16483:     $env{'browser.type'}=$clientbrowser;
                   16484: 
                   16485:     return $cookie;
                   16486: 
                   16487: }
                   16488: 
                   16489: sub _add_to_env {
                   16490:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  16491:     if (ref($env_data) eq 'HASH') {
                   16492:         while (my ($key,$value) = each(%$env_data)) {
                   16493: 	    $idf->{$prefix.$key} = $value;
                   16494: 	    $env{$prefix.$key}   = $value;
                   16495:         }
1.462     albertel 16496:     }
                   16497: }
                   16498: 
1.685     tempelho 16499: # --- Get the symbolic name of a problem and the url
                   16500: sub get_symb {
                   16501:     my ($request,$silent) = @_;
1.726     raeburn  16502:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 16503:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   16504:     if ($symb eq '') {
                   16505:         if (!$silent) {
1.1071    raeburn  16506:             if (ref($request)) { 
                   16507:                 $request->print("Unable to handle ambiguous references:$url:.");
                   16508:             }
1.685     tempelho 16509:             return ();
                   16510:         }
                   16511:     }
                   16512:     &Apache::lonenc::check_decrypt(\$symb);
                   16513:     return ($symb);
                   16514: }
                   16515: 
                   16516: # --------------------------------------------------------------Get annotation
                   16517: 
                   16518: sub get_annotation {
                   16519:     my ($symb,$enc) = @_;
                   16520: 
                   16521:     my $key = $symb;
                   16522:     if (!$enc) {
                   16523:         $key =
                   16524:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   16525:     }
                   16526:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   16527:     return $annotation{$key};
                   16528: }
                   16529: 
                   16530: sub clean_symb {
1.731     raeburn  16531:     my ($symb,$delete_enc) = @_;
1.685     tempelho 16532: 
                   16533:     &Apache::lonenc::check_decrypt(\$symb);
                   16534:     my $enc = $env{'request.enc'};
1.731     raeburn  16535:     if ($delete_enc) {
1.730     raeburn  16536:         delete($env{'request.enc'});
                   16537:     }
1.685     tempelho 16538: 
                   16539:     return ($symb,$enc);
                   16540: }
1.462     albertel 16541: 
1.1075.2.69  raeburn  16542: ############################################################
                   16543: ############################################################
                   16544: 
                   16545: =pod
                   16546: 
                   16547: =head1 Routines for building display used to search for courses
                   16548: 
                   16549: 
                   16550: =over 4
                   16551: 
                   16552: =item * &build_filters()
                   16553: 
                   16554: Create markup for a table used to set filters to use when selecting
                   16555: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   16556: and quotacheck.pl
                   16557: 
                   16558: 
                   16559: Inputs:
                   16560: 
                   16561: filterlist - anonymous array of fields to include as potential filters
                   16562: 
                   16563: crstype - course type
                   16564: 
                   16565: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   16566:               to pop-open a course selector (will contain "extra element").
                   16567: 
                   16568: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   16569: 
                   16570: filter - anonymous hash of criteria and their values
                   16571: 
                   16572: action - form action
                   16573: 
                   16574: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   16575: 
                   16576: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
                   16577: 
                   16578: cloneruname - username of owner of new course who wants to clone
                   16579: 
                   16580: clonerudom - domain of owner of new course who wants to clone
                   16581: 
                   16582: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
                   16583: 
                   16584: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   16585: 
                   16586: codedom - domain
                   16587: 
                   16588: formname - value of form element named "form".
                   16589: 
                   16590: fixeddom - domain, if fixed.
                   16591: 
                   16592: prevphase - value to assign to form element named "phase" when going back to the previous screen
                   16593: 
                   16594: cnameelement - name of form element in form on opener page which will receive title of selected course
                   16595: 
                   16596: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   16597: 
                   16598: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   16599: 
                   16600: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   16601: 
                   16602: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   16603: 
                   16604: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   16605: 
                   16606: 
                   16607: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   16608: 
                   16609: 
                   16610: Side Effects: None
                   16611: 
                   16612: =cut
                   16613: 
                   16614: # ---------------------------------------------- search for courses based on last activity etc.
                   16615: 
                   16616: sub build_filters {
                   16617:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   16618:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   16619:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   16620:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   16621:         $clonetext,$clonewarning) = @_;
                   16622:     my ($list,$jscript);
                   16623:     my $onchange = 'javascript:updateFilters(this)';
                   16624:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   16625:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   16626:         $typeselectform,$instcodetitle);
                   16627:     if ($formname eq '') {
                   16628:         $formname = $caller;
                   16629:     }
                   16630:     foreach my $item (@{$filterlist}) {
                   16631:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   16632:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   16633:             if ($item eq 'domainfilter') {
                   16634:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   16635:             } elsif ($item eq 'coursefilter') {
                   16636:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   16637:             } elsif ($item eq 'ownerfilter') {
                   16638:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16639:             } elsif ($item eq 'ownerdomfilter') {
                   16640:                 $filter->{'ownerdomfilter'} =
                   16641:                     &LONCAPA::clean_domain($filter->{$item});
                   16642:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   16643:                                                        'ownerdomfilter',1);
                   16644:             } elsif ($item eq 'personfilter') {
                   16645:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16646:             } elsif ($item eq 'persondomfilter') {
                   16647:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   16648:                                                         'persondomfilter',1);
                   16649:             } else {
                   16650:                 $filter->{$item} =~ s/\W//g;
                   16651:             }
                   16652:             if (!$filter->{$item}) {
                   16653:                 $filter->{$item} = '';
                   16654:             }
                   16655:         }
                   16656:         if ($item eq 'domainfilter') {
                   16657:             my $allow_blank = 1;
                   16658:             if ($formname eq 'portform') {
                   16659:                 $allow_blank=0;
                   16660:             } elsif ($formname eq 'studentform') {
                   16661:                 $allow_blank=0;
                   16662:             }
                   16663:             if ($fixeddom) {
                   16664:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   16665:                                     ' value="'.$codedom.'" />'.
                   16666:                                     &Apache::lonnet::domain($codedom,'description');
                   16667:             } else {
                   16668:                 $domainselectform = &select_dom_form($filter->{$item},
                   16669:                                                      'domainfilter',
                   16670:                                                       $allow_blank,'',$onchange);
                   16671:             }
                   16672:         } else {
                   16673:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   16674:         }
                   16675:     }
                   16676: 
                   16677:     # last course activity filter and selection
                   16678:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   16679: 
                   16680:     # course created filter and selection
                   16681:     if (exists($filter->{'createdfilter'})) {
                   16682:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   16683:     }
                   16684: 
                   16685:     my %lt = &Apache::lonlocal::texthash(
                   16686:                 'cac' => "$crstype Activity",
                   16687:                 'ccr' => "$crstype Created",
                   16688:                 'cde' => "$crstype Title",
                   16689:                 'cdo' => "$crstype Domain",
                   16690:                 'ins' => 'Institutional Code',
                   16691:                 'inc' => 'Institutional Categorization',
                   16692:                 'cow' => "$crstype Owner/Co-owner",
                   16693:                 'cop' => "$crstype Personnel Includes",
                   16694:                 'cog' => 'Type',
                   16695:              );
                   16696: 
                   16697:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16698:         my $typeval = 'Course';
                   16699:         if ($crstype eq 'Community') {
                   16700:             $typeval = 'Community';
                   16701:         }
                   16702:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   16703:     } else {
                   16704:         $typeselectform =  '<select name="type" size="1"';
                   16705:         if ($onchange) {
                   16706:             $typeselectform .= ' onchange="'.$onchange.'"';
                   16707:         }
                   16708:         $typeselectform .= '>'."\n";
                   16709:         foreach my $posstype ('Course','Community') {
                   16710:             $typeselectform.='<option value="'.$posstype.'"'.
                   16711:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
                   16712:         }
                   16713:         $typeselectform.="</select>";
                   16714:     }
                   16715: 
                   16716:     my ($cloneableonlyform,$cloneabletitle);
                   16717:     if (exists($filter->{'cloneableonly'})) {
                   16718:         my $cloneableon = '';
                   16719:         my $cloneableoff = ' checked="checked"';
                   16720:         if ($filter->{'cloneableonly'}) {
                   16721:             $cloneableon = $cloneableoff;
                   16722:             $cloneableoff = '';
                   16723:         }
                   16724:         $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>';
                   16725:         if ($formname eq 'ccrs') {
1.1075.2.71  raeburn  16726:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1075.2.69  raeburn  16727:         } else {
                   16728:             $cloneabletitle = &mt('Cloneable by you');
                   16729:         }
                   16730:     }
                   16731:     my $officialjs;
                   16732:     if ($crstype eq 'Course') {
                   16733:         if (exists($filter->{'instcodefilter'})) {
                   16734: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   16735: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   16736:             if ($codedom) {
                   16737:                 $officialjs = 1;
                   16738:                 ($instcodeform,$jscript,$$numtitlesref) =
                   16739:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   16740:                                                                   $officialjs,$codetitlesref);
                   16741:                 if ($jscript) {
                   16742:                     $jscript = '<script type="text/javascript">'."\n".
                   16743:                                '// <![CDATA['."\n".
                   16744:                                $jscript."\n".
                   16745:                                '// ]]>'."\n".
                   16746:                                '</script>'."\n";
                   16747:                 }
                   16748:             }
                   16749:             if ($instcodeform eq '') {
                   16750:                 $instcodeform =
                   16751:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   16752:                     $list->{'instcodefilter'}.'" />';
                   16753:                 $instcodetitle = $lt{'ins'};
                   16754:             } else {
                   16755:                 $instcodetitle = $lt{'inc'};
                   16756:             }
                   16757:             if ($fixeddom) {
                   16758:                 $instcodetitle .= '<br />('.$codedom.')';
                   16759:             }
                   16760:         }
                   16761:     }
                   16762:     my $output = qq|
                   16763: <form method="post" name="filterpicker" action="$action">
                   16764: <input type="hidden" name="form" value="$formname" />
                   16765: |;
                   16766:     if ($formname eq 'modifycourse') {
                   16767:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   16768:                    '<input type="hidden" name="prevphase" value="'.
                   16769:                    $prevphase.'" />'."\n";
1.1075.2.82  raeburn  16770:     } elsif ($formname eq 'quotacheck') {
                   16771:         $output .= qq|
                   16772: <input type="hidden" name="sortby" value="" />
                   16773: <input type="hidden" name="sortorder" value="" />
                   16774: |;
                   16775:     } else {
1.1075.2.69  raeburn  16776:         my $name_input;
                   16777:         if ($cnameelement ne '') {
                   16778:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   16779:                           $cnameelement.'" />';
                   16780:         }
                   16781:         $output .= qq|
                   16782: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   16783: <input type="hidden" name="cdomelement" value="$cdomelement" />
                   16784: $name_input
                   16785: $roleelement
                   16786: $multelement
                   16787: $typeelement
                   16788: |;
                   16789:         if ($formname eq 'portform') {
                   16790:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   16791:         }
                   16792:     }
                   16793:     if ($fixeddom) {
                   16794:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   16795:     }
                   16796:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   16797:     if ($sincefilterform) {
                   16798:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   16799:                   .$sincefilterform
                   16800:                   .&Apache::lonhtmlcommon::row_closure();
                   16801:     }
                   16802:     if ($createdfilterform) {
                   16803:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   16804:                   .$createdfilterform
                   16805:                   .&Apache::lonhtmlcommon::row_closure();
                   16806:     }
                   16807:     if ($domainselectform) {
                   16808:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   16809:                   .$domainselectform
                   16810:                   .&Apache::lonhtmlcommon::row_closure();
                   16811:     }
                   16812:     if ($typeselectform) {
                   16813:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16814:             $output .= $typeselectform;
                   16815:         } else {
                   16816:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   16817:                       .$typeselectform
                   16818:                       .&Apache::lonhtmlcommon::row_closure();
                   16819:         }
                   16820:     }
                   16821:     if ($instcodeform) {
                   16822:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   16823:                   .$instcodeform
                   16824:                   .&Apache::lonhtmlcommon::row_closure();
                   16825:     }
                   16826:     if (exists($filter->{'ownerfilter'})) {
                   16827:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   16828:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16829:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   16830:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16831:                    $ownerdomselectform.'</td></tr></table>'.
                   16832:                    &Apache::lonhtmlcommon::row_closure();
                   16833:     }
                   16834:     if (exists($filter->{'personfilter'})) {
                   16835:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   16836:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16837:                    '<input type="text" name="personfilter" size="20" value="'.
                   16838:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16839:                    $persondomselectform.'</td></tr></table>'.
                   16840:                    &Apache::lonhtmlcommon::row_closure();
                   16841:     }
                   16842:     if (exists($filter->{'coursefilter'})) {
                   16843:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   16844:                   .'<input type="text" name="coursefilter" size="25" value="'
                   16845:                   .$list->{'coursefilter'}.'" />'
                   16846:                   .&Apache::lonhtmlcommon::row_closure();
                   16847:     }
                   16848:     if ($cloneableonlyform) {
                   16849:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   16850:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   16851:     }
                   16852:     if (exists($filter->{'descriptfilter'})) {
                   16853:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   16854:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   16855:                   .$list->{'descriptfilter'}.'" />'
                   16856:                   .&Apache::lonhtmlcommon::row_closure(1);
                   16857:     }
                   16858:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   16859:                '<input type="hidden" name="updater" value="" />'."\n".
                   16860:                '<input type="submit" name="gosearch" value="'.
                   16861:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   16862:     return $jscript.$clonewarning.$output;
                   16863: }
                   16864: 
                   16865: =pod
                   16866: 
                   16867: =item * &timebased_select_form()
                   16868: 
                   16869: Create markup for a dropdown list used to select a time-based
                   16870: filter e.g., Course Activity, Course Created, when searching for courses
                   16871: or communities
                   16872: 
                   16873: Inputs:
                   16874: 
                   16875: item - name of form element (sincefilter or createdfilter)
                   16876: 
                   16877: filter - anonymous hash of criteria and their values
                   16878: 
                   16879: Returns: HTML for a select box contained a blank, then six time selections,
                   16880:          with value set in incoming form variables currently selected.
                   16881: 
                   16882: Side Effects: None
                   16883: 
                   16884: =cut
                   16885: 
                   16886: sub timebased_select_form {
                   16887:     my ($item,$filter) = @_;
                   16888:     if (ref($filter) eq 'HASH') {
                   16889:         $filter->{$item} =~ s/[^\d-]//g;
                   16890:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   16891:         return &select_form(
                   16892:                             $filter->{$item},
                   16893:                             $item,
                   16894:                             {      '-1' => '',
                   16895:                                 '86400' => &mt('today'),
                   16896:                                '604800' => &mt('last week'),
                   16897:                               '2592000' => &mt('last month'),
                   16898:                               '7776000' => &mt('last three months'),
                   16899:                              '15552000' => &mt('last six months'),
                   16900:                              '31104000' => &mt('last year'),
                   16901:                     'select_form_order' =>
                   16902:                            ['-1','86400','604800','2592000','7776000',
                   16903:                             '15552000','31104000']});
                   16904:     }
                   16905: }
                   16906: 
                   16907: =pod
                   16908: 
                   16909: =item * &js_changer()
                   16910: 
                   16911: Create script tag containing Javascript used to submit course search form
                   16912: when course type or domain is changed, and also to hide 'Searching ...' on
                   16913: page load completion for page showing search result.
                   16914: 
                   16915: Inputs: None
                   16916: 
                   16917: Returns: markup containing updateFilters() and hideSearching() javascript functions.
                   16918: 
                   16919: Side Effects: None
                   16920: 
                   16921: =cut
                   16922: 
                   16923: sub js_changer {
                   16924:     return <<ENDJS;
                   16925: <script type="text/javascript">
                   16926: // <![CDATA[
                   16927: function updateFilters(caller) {
                   16928:     if (typeof(caller) != "undefined") {
                   16929:         document.filterpicker.updater.value = caller.name;
                   16930:     }
                   16931:     document.filterpicker.submit();
                   16932: }
                   16933: 
                   16934: function hideSearching() {
                   16935:     if (document.getElementById('searching')) {
                   16936:         document.getElementById('searching').style.display = 'none';
                   16937:     }
                   16938:     return;
                   16939: }
                   16940: 
                   16941: // ]]>
                   16942: </script>
                   16943: 
                   16944: ENDJS
                   16945: }
                   16946: 
                   16947: =pod
                   16948: 
                   16949: =item * &search_courses()
                   16950: 
                   16951: Process selected filters form course search form and pass to lonnet::courseiddump
                   16952: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   16953: 
                   16954: Inputs:
                   16955: 
                   16956: dom - domain being searched
                   16957: 
                   16958: type - course type ('Course' or 'Community' or '.' if any).
                   16959: 
                   16960: filter - anonymous hash of criteria and their values
                   16961: 
                   16962: numtitles - for institutional codes - number of categories
                   16963: 
                   16964: cloneruname - optional username of new course owner
                   16965: 
                   16966: clonerudom - optional domain of new course owner
                   16967: 
1.1075.2.95  raeburn  16968: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1075.2.69  raeburn  16969:             (used when DC is using course creation form)
                   16970: 
                   16971: codetitles - reference to array of titles of components in institutional codes (official courses).
                   16972: 
1.1075.2.95  raeburn  16973: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   16974:            (and so can clone automatically)
                   16975: 
                   16976: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   16977: 
                   16978: reqinstcode - institutional code of new course, where search_courses is used to identify potential
                   16979:               courses to clone
1.1075.2.69  raeburn  16980: 
                   16981: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   16982: 
                   16983: 
                   16984: Side Effects: None
                   16985: 
                   16986: =cut
                   16987: 
                   16988: 
                   16989: sub search_courses {
1.1075.2.95  raeburn  16990:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   16991:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1075.2.69  raeburn  16992:     my (%courses,%showcourses,$cloner);
                   16993:     if (($filter->{'ownerfilter'} ne '') ||
                   16994:         ($filter->{'ownerdomfilter'} ne '')) {
                   16995:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   16996:                                        $filter->{'ownerdomfilter'};
                   16997:     }
                   16998:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   16999:         if (!$filter->{$item}) {
                   17000:             $filter->{$item}='.';
                   17001:         }
                   17002:     }
                   17003:     my $now = time;
                   17004:     my $timefilter =
                   17005:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   17006:     my ($createdbefore,$createdafter);
                   17007:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   17008:         $createdbefore = $now;
                   17009:         $createdafter = $now-$filter->{'createdfilter'};
                   17010:     }
                   17011:     my ($instcodefilter,$regexpok);
                   17012:     if ($numtitles) {
                   17013:         if ($env{'form.official'} eq 'on') {
                   17014:             $instcodefilter =
                   17015:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   17016:             $regexpok = 1;
                   17017:         } elsif ($env{'form.official'} eq 'off') {
                   17018:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   17019:             unless ($instcodefilter eq '') {
                   17020:                 $regexpok = -1;
                   17021:             }
                   17022:         }
                   17023:     } else {
                   17024:         $instcodefilter = $filter->{'instcodefilter'};
                   17025:     }
                   17026:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   17027:     if ($type eq '') { $type = '.'; }
                   17028: 
                   17029:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   17030:         $cloner = $cloneruname.':'.$clonerudom;
                   17031:     }
                   17032:     %courses = &Apache::lonnet::courseiddump($dom,
                   17033:                                              $filter->{'descriptfilter'},
                   17034:                                              $timefilter,
                   17035:                                              $instcodefilter,
                   17036:                                              $filter->{'combownerfilter'},
                   17037:                                              $filter->{'coursefilter'},
                   17038:                                              undef,undef,$type,$regexpok,undef,undef,
1.1075.2.95  raeburn  17039:                                              undef,undef,$cloner,$cc_clone,
1.1075.2.69  raeburn  17040:                                              $filter->{'cloneableonly'},
                   17041:                                              $createdbefore,$createdafter,undef,
1.1075.2.95  raeburn  17042:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1075.2.69  raeburn  17043:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   17044:         my $ccrole;
                   17045:         if ($type eq 'Community') {
                   17046:             $ccrole = 'co';
                   17047:         } else {
                   17048:             $ccrole = 'cc';
                   17049:         }
                   17050:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   17051:                                                      $filter->{'persondomfilter'},
                   17052:                                                      'userroles',undef,
                   17053:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   17054:                                                      $dom);
                   17055:         foreach my $role (keys(%rolehash)) {
                   17056:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   17057:             my $cid = $cdom.'_'.$cnum;
                   17058:             if (exists($courses{$cid})) {
                   17059:                 if (ref($courses{$cid}) eq 'HASH') {
                   17060:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   17061:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1075.2.119  raeburn  17062:                             push(@{$courses{$cid}{roles}},$courserole);
1.1075.2.69  raeburn  17063:                         }
                   17064:                     } else {
                   17065:                         $courses{$cid}{roles} = [$courserole];
                   17066:                     }
                   17067:                     $showcourses{$cid} = $courses{$cid};
                   17068:                 }
                   17069:             }
                   17070:         }
                   17071:         %courses = %showcourses;
                   17072:     }
                   17073:     return %courses;
                   17074: }
                   17075: 
                   17076: =pod
                   17077: 
                   17078: =back
                   17079: 
1.1075.2.88  raeburn  17080: =head1 Routines for version requirements for current course.
                   17081: 
                   17082: =over 4
                   17083: 
                   17084: =item * &check_release_required()
                   17085: 
                   17086: Compares required LON-CAPA version with version on server, and
                   17087: if required version is newer looks for a server with the required version.
                   17088: 
                   17089: Looks first at servers in user's owen domain; if none suitable, looks at
                   17090: servers in course's domain are permitted to host sessions for user's domain.
                   17091: 
                   17092: Inputs:
                   17093: 
                   17094: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   17095: 
                   17096: $courseid - Course ID of current course
                   17097: 
                   17098: $rolecode - User's current role in course (for switchserver query string).
                   17099: 
                   17100: $required - LON-CAPA version needed by course (format: Major.Minor).
                   17101: 
                   17102: 
                   17103: Returns:
                   17104: 
                   17105: $switchserver - query string tp append to /adm/switchserver call (if
                   17106:                 current server's LON-CAPA version is too old.
                   17107: 
                   17108: $warning - Message is displayed if no suitable server could be found.
                   17109: 
                   17110: =cut
                   17111: 
                   17112: sub check_release_required {
                   17113:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   17114:     my ($switchserver,$warning);
                   17115:     if ($required ne '') {
                   17116:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   17117:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   17118:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   17119:             my $otherserver;
                   17120:             if (($major eq '' && $minor eq '') ||
                   17121:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   17122:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   17123:                 my $switchlcrev =
                   17124:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   17125:                                                            $userdomserver);
                   17126:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   17127:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   17128:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   17129:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   17130:                     if ($cdom ne $env{'user.domain'}) {
                   17131:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   17132:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   17133:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   17134:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   17135:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   17136:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   17137:                         my $canhost =
                   17138:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   17139:                                                               $coursedomserver,
                   17140:                                                               $remoterev,
                   17141:                                                               $udomdefaults{'remotesessions'},
                   17142:                                                               $defdomdefaults{'hostedsessions'});
                   17143: 
                   17144:                         if ($canhost) {
                   17145:                             $otherserver = $coursedomserver;
                   17146:                         } else {
                   17147:                             $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.");
                   17148:                         }
                   17149:                     } else {
                   17150:                         $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).");
                   17151:                     }
                   17152:                 } else {
                   17153:                     $otherserver = $userdomserver;
                   17154:                 }
                   17155:             }
                   17156:             if ($otherserver ne '') {
                   17157:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   17158:             }
                   17159:         }
                   17160:     }
                   17161:     return ($switchserver,$warning);
                   17162: }
                   17163: 
                   17164: =pod
                   17165: 
                   17166: =item * &check_release_result()
                   17167: 
                   17168: Inputs:
                   17169: 
                   17170: $switchwarning - Warning message if no suitable server found to host session.
                   17171: 
                   17172: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   17173:                 and current role.
                   17174: 
                   17175: Returns: HTML to display with information about requirement to switch server.
                   17176:          Either displaying warning with link to Roles/Courses screen or
                   17177:          display link to switchserver.
                   17178: 
1.1075.2.69  raeburn  17179: =cut
                   17180: 
1.1075.2.88  raeburn  17181: sub check_release_result {
                   17182:     my ($switchwarning,$switchserver) = @_;
                   17183:     my $output = &start_page('Selected course unavailable on this server').
                   17184:                  '<p class="LC_warning">';
                   17185:     if ($switchwarning) {
                   17186:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   17187:         if (&show_course()) {
                   17188:             $output .= &mt('Display courses');
                   17189:         } else {
                   17190:             $output .= &mt('Display roles');
                   17191:         }
                   17192:         $output .= '</a>';
                   17193:     } elsif ($switchserver) {
                   17194:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   17195:                    '<br />'.
                   17196:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   17197:                    &mt('Switch Server').
                   17198:                    '</a>';
                   17199:     }
                   17200:     $output .= '</p>'.&end_page();
                   17201:     return $output;
                   17202: }
                   17203: 
                   17204: =pod
                   17205: 
                   17206: =item * &needs_coursereinit()
                   17207: 
                   17208: Determine if course contents stored for user's session needs to be
                   17209: refreshed, because content has changed since "Big Hash" last tied.
                   17210: 
                   17211: Check for change is made if time last checked is more than 10 minutes ago
                   17212: (by default).
                   17213: 
                   17214: Inputs:
                   17215: 
                   17216: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   17217: 
                   17218: $interval (optional) - Time which may elapse (in s) between last check for content
                   17219:                        change in current course. (default: 600 s).
                   17220: 
                   17221: Returns: an array; first element is:
                   17222: 
                   17223: =over 4
                   17224: 
                   17225: 'switch' - if content updates mean user's session
                   17226:            needs to be switched to a server running a newer LON-CAPA version
                   17227: 
                   17228: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   17229:            on current server hosting user's session
                   17230: 
                   17231: ''       - if no action required.
                   17232: 
                   17233: =back
                   17234: 
                   17235: If first item element is 'switch':
                   17236: 
                   17237: second item is $switchwarning - Warning message if no suitable server found to host session.
                   17238: 
                   17239: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   17240:                               and current role.
                   17241: 
                   17242: otherwise: no other elements returned.
                   17243: 
                   17244: =back
                   17245: 
                   17246: =cut
                   17247: 
                   17248: sub needs_coursereinit {
                   17249:     my ($loncaparev,$interval) = @_;
                   17250:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   17251:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   17252:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   17253:     my $now = time;
                   17254:     if ($interval eq '') {
                   17255:         $interval = 600;
                   17256:     }
                   17257:     if (($now-$env{'request.course.timechecked'})>$interval) {
                   17258:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1075.2.161.  .1(raebu 17259:21):         my $blocked = &blocking_status('reinit',$cnum,$cdom,undef,1);
                   17260:21):         if ($blocked) {
                   17261:21):             return ();
                   17262:21):         }
                   17263:21):         my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
1.1075.2.88  raeburn  17264:         if ($lastchange > $env{'request.course.tied'}) {
                   17265:             my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   17266:             if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   17267:                 my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   17268:                 if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   17269:                     &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   17270:                                              $curr_reqd_hash{'internal.releaserequired'}});
                   17271:                     my ($switchserver,$switchwarning) =
                   17272:                         &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   17273:                                                 $curr_reqd_hash{'internal.releaserequired'});
                   17274:                     if ($switchwarning ne '' || $switchserver ne '') {
                   17275:                         return ('switch',$switchwarning,$switchserver);
                   17276:                     }
                   17277:                 }
                   17278:             }
                   17279:             return ('update');
                   17280:         }
                   17281:     }
                   17282:     return ();
                   17283: }
1.1075.2.69  raeburn  17284: 
1.1075.2.11  raeburn  17285: sub update_content_constraints {
                   17286:     my ($cdom,$cnum,$chome,$cid) = @_;
                   17287:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   17288:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   17289:     my %checkresponsetypes;
                   17290:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   17291:         my ($item,$name,$value) = split(/:/,$key);
                   17292:         if ($item eq 'resourcetag') {
                   17293:             if ($name eq 'responsetype') {
                   17294:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   17295:             }
                   17296:         }
                   17297:     }
                   17298:     my $navmap = Apache::lonnavmaps::navmap->new();
                   17299:     if (defined($navmap)) {
                   17300:         my %allresponses;
                   17301:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
                   17302:             my %responses = $res->responseTypes();
                   17303:             foreach my $key (keys(%responses)) {
                   17304:                 next unless(exists($checkresponsetypes{$key}));
                   17305:                 $allresponses{$key} += $responses{$key};
                   17306:             }
                   17307:         }
                   17308:         foreach my $key (keys(%allresponses)) {
                   17309:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   17310:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   17311:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   17312:             }
                   17313:         }
                   17314:         undef($navmap);
                   17315:     }
                   17316:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   17317:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   17318:     }
                   17319:     return;
                   17320: }
                   17321: 
1.1075.2.27  raeburn  17322: sub allmaps_incourse {
                   17323:     my ($cdom,$cnum,$chome,$cid) = @_;
                   17324:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   17325:         $cid = $env{'request.course.id'};
                   17326:         $cdom = $env{'course.'.$cid.'.domain'};
                   17327:         $cnum = $env{'course.'.$cid.'.num'};
                   17328:         $chome = $env{'course.'.$cid.'.home'};
                   17329:     }
                   17330:     my %allmaps = ();
                   17331:     my $lastchange =
                   17332:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   17333:     if ($lastchange > $env{'request.course.tied'}) {
                   17334:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   17335:         unless ($ferr) {
                   17336:             &update_content_constraints($cdom,$cnum,$chome,$cid);
                   17337:         }
                   17338:     }
                   17339:     my $navmap = Apache::lonnavmaps::navmap->new();
                   17340:     if (defined($navmap)) {
                   17341:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   17342:             $allmaps{$res->src()} = 1;
                   17343:         }
                   17344:     }
                   17345:     return \%allmaps;
                   17346: }
                   17347: 
1.1075.2.11  raeburn  17348: sub parse_supplemental_title {
                   17349:     my ($title) = @_;
                   17350: 
                   17351:     my ($foldertitle,$renametitle);
                   17352:     if ($title =~ /&amp;&amp;&amp;/) {
                   17353:         $title = &HTML::Entites::decode($title);
                   17354:     }
                   17355:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   17356:         $renametitle=$4;
                   17357:         my ($time,$uname,$udom) = ($1,$2,$3);
                   17358:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   17359:         my $name =  &plainname($uname,$udom);
                   17360:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   17361:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
                   17362:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
                   17363:             $name.': <br />'.$foldertitle;
                   17364:     }
                   17365:     if (wantarray) {
                   17366:         return ($title,$foldertitle,$renametitle);
                   17367:     }
                   17368:     return $title;
                   17369: }
                   17370: 
1.1075.2.43  raeburn  17371: sub recurse_supplemental {
                   17372:     my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
                   17373:     if ($suppmap) {
                   17374:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   17375:         if ($fatal) {
                   17376:             $errors ++;
                   17377:         } else {
                   17378:             if ($#LONCAPA::map::resources > 0) {
                   17379:                 foreach my $res (@LONCAPA::map::resources) {
                   17380:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
                   17381:                     if (($src ne '') && ($status eq 'res')) {
1.1075.2.46  raeburn  17382:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
                   17383:                             ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1075.2.43  raeburn  17384:                         } else {
                   17385:                             $numfiles ++;
                   17386:                         }
                   17387:                     }
                   17388:                 }
                   17389:             }
                   17390:         }
                   17391:     }
                   17392:     return ($numfiles,$errors);
                   17393: }
                   17394: 
1.1075.2.18  raeburn  17395: sub symb_to_docspath {
1.1075.2.119  raeburn  17396:     my ($symb,$navmapref) = @_;
                   17397:     return unless ($symb && ref($navmapref));
1.1075.2.18  raeburn  17398:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   17399:     if ($resurl=~/\.(sequence|page)$/) {
                   17400:         $mapurl=$resurl;
                   17401:     } elsif ($resurl eq 'adm/navmaps') {
                   17402:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   17403:     }
                   17404:     my $mapresobj;
1.1075.2.119  raeburn  17405:     unless (ref($$navmapref)) {
                   17406:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   17407:     }
                   17408:     if (ref($$navmapref)) {
                   17409:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1075.2.18  raeburn  17410:     }
                   17411:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   17412:     my $type=$2;
                   17413:     my $path;
                   17414:     if (ref($mapresobj)) {
                   17415:         my $pcslist = $mapresobj->map_hierarchy();
                   17416:         if ($pcslist ne '') {
                   17417:             foreach my $pc (split(/,/,$pcslist)) {
                   17418:                 next if ($pc <= 1);
1.1075.2.119  raeburn  17419:                 my $res = $$navmapref->getByMapPc($pc);
1.1075.2.18  raeburn  17420:                 if (ref($res)) {
                   17421:                     my $thisurl = $res->src();
                   17422:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   17423:                     my $thistitle = $res->title();
                   17424:                     $path .= '&'.
                   17425:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1075.2.46  raeburn  17426:                              &escape($thistitle).
1.1075.2.18  raeburn  17427:                              ':'.$res->randompick().
                   17428:                              ':'.$res->randomout().
                   17429:                              ':'.$res->encrypted().
                   17430:                              ':'.$res->randomorder().
                   17431:                              ':'.$res->is_page();
                   17432:                 }
                   17433:             }
                   17434:         }
                   17435:         $path =~ s/^\&//;
                   17436:         my $maptitle = $mapresobj->title();
                   17437:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  17438:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17439:         }
                   17440:         $path .= (($path ne '')? '&' : '').
                   17441:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17442:                  &escape($maptitle).
1.1075.2.18  raeburn  17443:                  ':'.$mapresobj->randompick().
                   17444:                  ':'.$mapresobj->randomout().
                   17445:                  ':'.$mapresobj->encrypted().
                   17446:                  ':'.$mapresobj->randomorder().
                   17447:                  ':'.$mapresobj->is_page();
                   17448:     } else {
                   17449:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   17450:         my $ispage = (($type eq 'page')? 1 : '');
                   17451:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  17452:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17453:         }
                   17454:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17455:                 &escape($maptitle).':::::'.$ispage;
1.1075.2.18  raeburn  17456:     }
                   17457:     unless ($mapurl eq 'default') {
                   17458:         $path = 'default&'.
1.1075.2.46  raeburn  17459:                 &escape('Main Content').
1.1075.2.18  raeburn  17460:                 ':::::&'.$path;
                   17461:     }
                   17462:     return $path;
                   17463: }
                   17464: 
1.1075.2.14  raeburn  17465: sub captcha_display {
1.1075.2.137  raeburn  17466:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17467:     my ($output,$error);
1.1075.2.107  raeburn  17468:     my ($captcha,$pubkey,$privkey,$version) =
1.1075.2.137  raeburn  17469:         &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17470:     if ($captcha eq 'original') {
                   17471:         $output = &create_captcha();
                   17472:         unless ($output) {
                   17473:             $error = 'captcha';
                   17474:         }
                   17475:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17476:         $output = &create_recaptcha($pubkey,$version);
1.1075.2.14  raeburn  17477:         unless ($output) {
                   17478:             $error = 'recaptcha';
                   17479:         }
                   17480:     }
1.1075.2.107  raeburn  17481:     return ($output,$error,$captcha,$version);
1.1075.2.14  raeburn  17482: }
                   17483: 
                   17484: sub captcha_response {
1.1075.2.137  raeburn  17485:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17486:     my ($captcha_chk,$captcha_error);
1.1075.2.137  raeburn  17487:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17488:     if ($captcha eq 'original') {
                   17489:         ($captcha_chk,$captcha_error) = &check_captcha();
                   17490:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17491:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1075.2.14  raeburn  17492:     } else {
                   17493:         $captcha_chk = 1;
                   17494:     }
                   17495:     return ($captcha_chk,$captcha_error);
                   17496: }
                   17497: 
                   17498: sub get_captcha_config {
1.1075.2.137  raeburn  17499:     my ($context,$lonhost,$dom_in_effect) = @_;
1.1075.2.107  raeburn  17500:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1075.2.14  raeburn  17501:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   17502:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   17503:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   17504:     if ($context eq 'usercreation') {
                   17505:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   17506:         if (ref($domconfig{$context}) eq 'HASH') {
                   17507:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   17508:             if (ref($hashtocheck) eq 'HASH') {
                   17509:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   17510:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   17511:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   17512:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   17513:                     }
                   17514:                     if ($privkey && $pubkey) {
                   17515:                         $captcha = 'recaptcha';
1.1075.2.107  raeburn  17516:                         $version = $hashtocheck->{'recaptchaversion'};
                   17517:                         if ($version ne '2') {
                   17518:                             $version = 1;
                   17519:                         }
1.1075.2.14  raeburn  17520:                     } else {
                   17521:                         $captcha = 'original';
                   17522:                     }
                   17523:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   17524:                     $captcha = 'original';
                   17525:                 }
                   17526:             }
                   17527:         } else {
                   17528:             $captcha = 'captcha';
                   17529:         }
                   17530:     } elsif ($context eq 'login') {
                   17531:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   17532:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   17533:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   17534:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
                   17535:             if ($privkey && $pubkey) {
                   17536:                 $captcha = 'recaptcha';
1.1075.2.107  raeburn  17537:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   17538:                 if ($version ne '2') {
                   17539:                     $version = 1;
                   17540:                 }
1.1075.2.14  raeburn  17541:             } else {
                   17542:                 $captcha = 'original';
                   17543:             }
                   17544:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   17545:             $captcha = 'original';
                   17546:         }
1.1075.2.137  raeburn  17547:     } elsif ($context eq 'passwords') {
                   17548:         if ($dom_in_effect) {
                   17549:             my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
                   17550:             if ($passwdconf{'captcha'} eq 'recaptcha') {
                   17551:                 if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
                   17552:                     $pubkey = $passwdconf{'recaptchakeys'}{'public'};
                   17553:                     $privkey = $passwdconf{'recaptchakeys'}{'private'};
                   17554:                 }
                   17555:                 if ($privkey && $pubkey) {
                   17556:                     $captcha = 'recaptcha';
                   17557:                     $version = $passwdconf{'recaptchaversion'};
                   17558:                     if ($version ne '2') {
                   17559:                         $version = 1;
                   17560:                     }
                   17561:                 } else {
                   17562:                     $captcha = 'original';
                   17563:                 }
                   17564:             } elsif ($passwdconf{'captcha'} ne 'notused') {
                   17565:                 $captcha = 'original';
                   17566:             }
                   17567:         }
1.1075.2.14  raeburn  17568:     }
1.1075.2.107  raeburn  17569:     return ($captcha,$pubkey,$privkey,$version);
1.1075.2.14  raeburn  17570: }
                   17571: 
                   17572: sub create_captcha {
                   17573:     my %captcha_params = &captcha_settings();
                   17574:     my ($output,$maxtries,$tries) = ('',10,0);
                   17575:     while ($tries < $maxtries) {
                   17576:         $tries ++;
                   17577:         my $captcha = Authen::Captcha->new (
                   17578:                                            output_folder => $captcha_params{'output_dir'},
                   17579:                                            data_folder   => $captcha_params{'db_dir'},
                   17580:                                           );
                   17581:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   17582: 
                   17583:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   17584:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1075.2.158  raeburn  17585:                       '<span class="LC_nobreak">'.
1.1075.2.14  raeburn  17586:                       &mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1075.2.66  raeburn  17587:                       '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
1.1075.2.158  raeburn  17588:                       '</span><br />'.
1.1075.2.66  raeburn  17589:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1075.2.14  raeburn  17590:             last;
                   17591:         }
                   17592:     }
1.1075.2.158  raeburn  17593:     if ($output eq '') {
                   17594:         &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
                   17595:     }
1.1075.2.14  raeburn  17596:     return $output;
                   17597: }
                   17598: 
                   17599: sub captcha_settings {
                   17600:     my %captcha_params = (
                   17601:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   17602:                            www_output_dir => "/captchaspool",
                   17603:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   17604:                            numchars       => '5',
                   17605:                          );
                   17606:     return %captcha_params;
                   17607: }
                   17608: 
                   17609: sub check_captcha {
                   17610:     my ($captcha_chk,$captcha_error);
                   17611:     my $code = $env{'form.code'};
                   17612:     my $md5sum = $env{'form.crypt'};
                   17613:     my %captcha_params = &captcha_settings();
                   17614:     my $captcha = Authen::Captcha->new(
                   17615:                       output_folder => $captcha_params{'output_dir'},
                   17616:                       data_folder   => $captcha_params{'db_dir'},
                   17617:                   );
1.1075.2.26  raeburn  17618:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14  raeburn  17619:     my %captcha_hash = (
                   17620:                         0       => 'Code not checked (file error)',
                   17621:                        -1      => 'Failed: code expired',
                   17622:                        -2      => 'Failed: invalid code (not in database)',
                   17623:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   17624:     );
                   17625:     if ($captcha_chk != 1) {
                   17626:         $captcha_error = $captcha_hash{$captcha_chk}
                   17627:     }
                   17628:     return ($captcha_chk,$captcha_error);
                   17629: }
                   17630: 
                   17631: sub create_recaptcha {
1.1075.2.107  raeburn  17632:     my ($pubkey,$version) = @_;
                   17633:     if ($version >= 2) {
1.1075.2.158  raeburn  17634:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
                   17635:                '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1075.2.107  raeburn  17636:     } else {
                   17637:         my $use_ssl;
                   17638:         if ($ENV{'SERVER_PORT'} == 443) {
                   17639:             $use_ssl = 1;
                   17640:         }
                   17641:         my $captcha = Captcha::reCAPTCHA->new;
                   17642:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   17643:                $captcha->get_html($pubkey,undef,$use_ssl).
                   17644:                &mt('If the text is hard to read, [_1] will replace them.',
                   17645:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   17646:                '<br /><br />';
                   17647:      }
1.1075.2.14  raeburn  17648: }
                   17649: 
                   17650: sub check_recaptcha {
1.1075.2.107  raeburn  17651:     my ($privkey,$version) = @_;
1.1075.2.14  raeburn  17652:     my $captcha_chk;
1.1075.2.150  raeburn  17653:     my $ip = &Apache::lonnet::get_requestor_ip(); 
1.1075.2.107  raeburn  17654:     if ($version >= 2) {
                   17655:         my $ua = LWP::UserAgent->new;
                   17656:         $ua->timeout(10);
                   17657:         my %info = (
                   17658:                      secret   => $privkey,
                   17659:                      response => $env{'form.g-recaptcha-response'},
1.1075.2.150  raeburn  17660:                      remoteip => $ip,
1.1075.2.107  raeburn  17661:                    );
                   17662:         my $response = $ua->post('https://www.google.com/recaptcha/api/siteverify',\%info);
                   17663:         if ($response->is_success)  {
                   17664:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   17665:             if (ref($data) eq 'HASH') {
                   17666:                 if ($data->{'success'}) {
                   17667:                     $captcha_chk = 1;
                   17668:                 }
                   17669:             }
                   17670:         }
                   17671:     } else {
                   17672:         my $captcha = Captcha::reCAPTCHA->new;
                   17673:         my $captcha_result =
                   17674:             $captcha->check_answer(
                   17675:                                     $privkey,
1.1075.2.150  raeburn  17676:                                     $ip,
1.1075.2.107  raeburn  17677:                                     $env{'form.recaptcha_challenge_field'},
                   17678:                                     $env{'form.recaptcha_response_field'},
                   17679:                                   );
                   17680:         if ($captcha_result->{is_valid}) {
                   17681:             $captcha_chk = 1;
                   17682:         }
1.1075.2.14  raeburn  17683:     }
                   17684:     return $captcha_chk;
                   17685: }
                   17686: 
1.1075.2.64  raeburn  17687: sub emailusername_info {
1.1075.2.103  raeburn  17688:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1075.2.64  raeburn  17689:     my %titles = &Apache::lonlocal::texthash (
                   17690:                      lastname      => 'Last Name',
                   17691:                      firstname     => 'First Name',
                   17692:                      institution   => 'School/college/university',
                   17693:                      location      => "School's city, state/province, country",
                   17694:                      web           => "School's web address",
                   17695:                      officialemail => 'E-mail address at institution (if different)',
1.1075.2.103  raeburn  17696:                      id            => 'Student/Employee ID',
1.1075.2.64  raeburn  17697:                  );
                   17698:     return (\@fields,\%titles);
                   17699: }
                   17700: 
1.1075.2.56  raeburn  17701: sub cleanup_html {
                   17702:     my ($incoming) = @_;
                   17703:     my $outgoing;
                   17704:     if ($incoming ne '') {
                   17705:         $outgoing = $incoming;
                   17706:         $outgoing =~ s/;/&#059;/g;
                   17707:         $outgoing =~ s/\#/&#035;/g;
                   17708:         $outgoing =~ s/\&/&#038;/g;
                   17709:         $outgoing =~ s/</&#060;/g;
                   17710:         $outgoing =~ s/>/&#062;/g;
                   17711:         $outgoing =~ s/\(/&#040/g;
                   17712:         $outgoing =~ s/\)/&#041;/g;
                   17713:         $outgoing =~ s/"/&#034;/g;
                   17714:         $outgoing =~ s/'/&#039;/g;
                   17715:         $outgoing =~ s/\$/&#036;/g;
                   17716:         $outgoing =~ s{/}{&#047;}g;
                   17717:         $outgoing =~ s/=/&#061;/g;
                   17718:         $outgoing =~ s/\\/&#092;/g
                   17719:     }
                   17720:     return $outgoing;
                   17721: }
                   17722: 
1.1075.2.74  raeburn  17723: # Checks for critical messages and returns a redirect url if one exists.
                   17724: # $interval indicates how often to check for messages.
1.1075.2.161.  .1(raebu 17725:21): # $context is the calling context -- roles, grades, contents, menu or flip.
1.1075.2.74  raeburn  17726: sub critical_redirect {
1.1075.2.161.  .1(raebu 17727:21):     my ($interval,$context) = @_;
1.1075.2.158  raeburn  17728:     unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
                   17729:         return ();
                   17730:     }
1.1075.2.74  raeburn  17731:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1075.2.161.  .1(raebu 17732:21):         if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
                   17733:21):             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   17734:21):             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   17735:21):             my $blocked = &blocking_status('alert',$cnum,$cdom,undef,1);
                   17736:21):             if ($blocked) {
                   17737:21):                 my $checkrole = "cm./$cdom/$cnum";
                   17738:21):                 if ($env{'request.course.sec'} ne '') {
                   17739:21):                     $checkrole .= "/$env{'request.course.sec'}";
                   17740:21):                 }
                   17741:21):                 unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   17742:21):                         ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   17743:21):                     return;
                   17744:21):                 }
                   17745:21):             }
                   17746:21):         }
1.1075.2.74  raeburn  17747:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
                   17748:                                         $env{'user.name'});
                   17749:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
                   17750:         my $redirecturl;
                   17751:         if ($what[0]) {
1.1075.2.158  raeburn  17752:             if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1075.2.74  raeburn  17753:                 $redirecturl='/adm/email?critical=display';
                   17754:                 my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   17755:                 return (1, $url);
                   17756:             }
                   17757:         }
                   17758:     }
                   17759:     return ();
                   17760: }
                   17761: 
1.1075.2.64  raeburn  17762: # Use:
                   17763: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   17764: #
                   17765: ##################################################
                   17766: #          password associated functions         #
                   17767: ##################################################
                   17768: sub des_keys {
                   17769:     # Make a new key for DES encryption.
                   17770:     # Each key has two parts which are returned separately.
                   17771:     # Please note:  Each key must be passed through the &hex function
                   17772:     # before it is output to the web browser.  The hex versions cannot
                   17773:     # be used to decrypt.
                   17774:     my @hexstr=('0','1','2','3','4','5','6','7',
                   17775:                 '8','9','a','b','c','d','e','f');
                   17776:     my $lkey='';
                   17777:     for (0..7) {
                   17778:         $lkey.=$hexstr[rand(15)];
                   17779:     }
                   17780:     my $ukey='';
                   17781:     for (0..7) {
                   17782:         $ukey.=$hexstr[rand(15)];
                   17783:     }
                   17784:     return ($lkey,$ukey);
                   17785: }
                   17786: 
                   17787: sub des_decrypt {
                   17788:     my ($key,$cyphertext) = @_;
                   17789:     my $keybin=pack("H16",$key);
                   17790:     my $cypher;
                   17791:     if ($Crypt::DES::VERSION>=2.03) {
                   17792:         $cypher=new Crypt::DES $keybin;
                   17793:     } else {
                   17794:         $cypher=new DES $keybin;
                   17795:     }
1.1075.2.106  raeburn  17796:     my $plaintext='';
                   17797:     my $cypherlength = length($cyphertext);
                   17798:     my $numchunks = int($cypherlength/32);
                   17799:     for (my $j=0; $j<$numchunks; $j++) {
                   17800:         my $start = $j*32;
                   17801:         my $cypherblock = substr($cyphertext,$start,32);
                   17802:         my $chunk =
                   17803:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   17804:         $chunk .=
                   17805:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   17806:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   17807:         $plaintext .= $chunk;
                   17808:     }
1.1075.2.64  raeburn  17809:     return $plaintext;
                   17810: }
                   17811: 
1.1075.2.161.  .1(raebu 17812:21): sub get_requested_shorturls {
                   17813:21):     my ($cdom,$cnum,$navmap) = @_;
                   17814:21):     return unless (ref($navmap));
                   17815:21):     my ($numnew,$errors);
                   17816:21):     my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
                   17817:21):     if (@toshorten) {
                   17818:21):         my (%maps,%resources,%titles);
                   17819:21):         &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
                   17820:21):                                                                'shorturls',$cdom,$cnum);
                   17821:21):         if (keys(%resources)) {
                   17822:21):             my %tocreate;
                   17823:21):             foreach my $item (sort {$a <=> $b} (@toshorten)) {
                   17824:21):                 my $symb = $resources{$item};
                   17825:21):                 if ($symb) {
                   17826:21):                     $tocreate{$cnum.'&'.$symb} = 1;
                   17827:21):                 }
                   17828:21):             }
                   17829:21):             if (keys(%tocreate)) {
                   17830:21):                 ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
                   17831:21):                                                       \%tocreate);
                   17832:21):             }
                   17833:21):         }
                   17834:21):     }
                   17835:21):     return ($numnew,$errors);
                   17836:21): }
                   17837:21): 
                   17838:21): sub make_short_symbs {
                   17839:21):     my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
                   17840:21):     my ($numnew,@errors);
                   17841:21):     if (ref($tocreateref) eq 'HASH') {
                   17842:21):         my %tocreate = %{$tocreateref};
                   17843:21):         if (keys(%tocreate)) {
                   17844:21):             my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
                   17845:21):             my $su = Short::URL->new(no_vowels => 1);
                   17846:21):             my $init = '';
                   17847:21):             my (%newunique,%addcourse,%courseonly,%failed);
                   17848:21):             # get lock on tiny db
                   17849:21):             my $now = time;
                   17850:21):             if ($lockuser eq '') {
                   17851:21):                 $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
                   17852:21):             }
                   17853:21):             my $lockhash = {
                   17854:21):                                 "lock\0$now" => $lockuser,
                   17855:21):                             };
                   17856:21):             my $tries = 0;
                   17857:21):             my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
                   17858:21):             my ($code,$error);
                   17859:21):             while (($gotlock ne 'ok') && ($tries<3)) {
                   17860:21):                 $tries ++;
                   17861:21):                 sleep 1;
                   17862:21):                 $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
                   17863:21):             }
                   17864:21):             if ($gotlock eq 'ok') {
                   17865:21):                 $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
                   17866:21):                                        \%addcourse,\%courseonly,\%failed);
                   17867:21):                 if (keys(%failed)) {
                   17868:21):                     my $numfailed = scalar(keys(%failed));
                   17869:21):                     push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
                   17870:21):                 }
                   17871:21):                 if (keys(%newunique)) {
                   17872:21):                     my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
                   17873:21):                     if ($putres eq 'ok') {
                   17874:21):                         $numnew = scalar(keys(%newunique));
                   17875:21):                         my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
                   17876:21):                         unless ($newputres eq 'ok') {
                   17877:21):                             push(@errors,&mt('error: could not store course look-up of short URLs'));
                   17878:21):                         }
                   17879:21):                     } else {
                   17880:21):                         push(@errors,&mt('error: could not store unique six character URLs'));
                   17881:21):                     }
                   17882:21):                 }
                   17883:21):                 my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
                   17884:21):                 unless ($dellockres eq 'ok') {
                   17885:21):                     push(@errors,&mt('error: could not release lockfile'));
                   17886:21):                 }
                   17887:21):             } else {
                   17888:21):                 push(@errors,&mt('error: could not obtain lockfile'));
                   17889:21):             }
                   17890:21):             if (keys(%courseonly)) {
                   17891:21):                 my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
                   17892:21):                 if ($result ne 'ok') {
                   17893:21):                     push(@errors,&mt('error: could not update course look-up of short URLs'));
                   17894:21):                 }
                   17895:21):             }
                   17896:21):         }
                   17897:21):     }
                   17898:21):     return ($numnew,\@errors);
                   17899:21): }
                   17900:21): 
                   17901:21): sub shorten_symbs {
                   17902:21):     my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
                   17903:21):     return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
                   17904:21):                    (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
                   17905:21):                    (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
                   17906:21):     my (%possibles,%collisions);
                   17907:21):     foreach my $key (keys(%{$tocreate})) {
                   17908:21):         my $num = String::CRC32::crc32($key);
                   17909:21):         my $tiny = $su->encode($num,$init);
                   17910:21):         if ($tiny) {
                   17911:21):             $possibles{$tiny} = $key;
                   17912:21):         }
                   17913:21):     }
                   17914:21):     if (!$init) {
                   17915:21):         $init = 1;
                   17916:21):     } else {
                   17917:21):         $init ++;
                   17918:21):     }
                   17919:21):     if (keys(%possibles)) {
                   17920:21):         my @posstiny = keys(%possibles);
                   17921:21):         my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
                   17922:21):         my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
                   17923:21):         if (keys(%currtiny)) {
                   17924:21):             foreach my $key (keys(%currtiny)) {
                   17925:21):                 next if ($currtiny{$key} eq '');
                   17926:21):                 if ($currtiny{$key} eq $possibles{$key}) {
                   17927:21):                     my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
                   17928:21):                     unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   17929:21):                         $courseonly->{$tsymb} = $key;
                   17930:21):                     }
                   17931:21):                 } else {
                   17932:21):                     $collisions{$possibles{$key}} = 1;
                   17933:21):                 }
                   17934:21):                 delete($possibles{$key});
                   17935:21):             }
                   17936:21):         }
                   17937:21):         foreach my $key (keys(%possibles)) {
                   17938:21):             $newunique->{$key} = $possibles{$key};
                   17939:21):             my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
                   17940:21):             unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   17941:21):                 $addcourse->{$tsymb} = $key;
                   17942:21):             }
                   17943:21):         }
                   17944:21):     }
                   17945:21):     if (keys(%collisions)) {
                   17946:21):         if ($init <5) {
                   17947:21):             if (!$init) {
                   17948:21):                 $init = 1;
                   17949:21):             } else {
                   17950:21):                 $init ++;
                   17951:21):             }
                   17952:21):             $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
                   17953:21):                                    $newunique,$addcourse,$courseonly,$failed);
                   17954:21):         } else {
                   17955:21):             foreach my $key (keys(%collisions)) {
                   17956:21):                 $failed->{$key} = 1;
                   17957:21):                 $failed->{$key} = 1;
                   17958:21):             }
                   17959:21):         }
                   17960:21):     }
                   17961:21):     return $init;
                   17962:21): }
                   17963:21): 
1.1075.2.135  raeburn  17964: sub is_nonframeable {
                   17965:     my ($url,$absolute,$hostname,$ip,$nocache) = @_;
                   17966:     my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
                   17967:     return if (($remprotocol eq '') || ($remhost eq ''));
                   17968: 
                   17969:     $remprotocol = lc($remprotocol);
                   17970:     $remhost = lc($remhost);
                   17971:     my $remport = 80;
                   17972:     if ($remprotocol eq 'https') {
                   17973:         $remport = 443;
                   17974:     }
                   17975:     my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
                   17976:     if ($cached) {
                   17977:         unless ($nocache) {
                   17978:             if ($result) {
                   17979:                 return 1;
                   17980:             } else {
                   17981:                 return 0;
                   17982:             }
                   17983:         }
                   17984:     }
                   17985:     my $uselink;
                   17986:     my $request = new HTTP::Request('HEAD',$url);
1.1075.2.142  raeburn  17987:     my $ua = LWP::UserAgent->new;
                   17988:     $ua->timeout(5);
                   17989:     my $response=$ua->request($request);
1.1075.2.135  raeburn  17990:     if ($response->is_success()) {
                   17991:         my $secpolicy = lc($response->header('content-security-policy'));
                   17992:         my $xframeop = lc($response->header('x-frame-options'));
                   17993:         $secpolicy =~ s/^\s+|\s+$//g;
                   17994:         $xframeop =~ s/^\s+|\s+$//g;
                   17995:         if (($secpolicy ne '') || ($xframeop ne '')) {
                   17996:             my $remotehost = $remprotocol.'://'.$remhost;
                   17997:             my ($origin,$protocol,$port);
                   17998:             if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
                   17999:                 $port = $ENV{'SERVER_PORT'};
                   18000:             } else {
                   18001:                 $port = 80;
                   18002:             }
                   18003:             if ($absolute eq '') {
                   18004:                 $protocol = 'http:';
                   18005:                 if ($port == 443) {
                   18006:                     $protocol = 'https:';
                   18007:                 }
                   18008:                 $origin = $protocol.'//'.lc($hostname);
                   18009:             } else {
                   18010:                 $origin = lc($absolute);
                   18011:                 ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
                   18012:             }
                   18013:             if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
                   18014:                 my $framepolicy = $1;
                   18015:                 $framepolicy =~ s/^\s+|\s+$//g;
                   18016:                 my @policies = split(/\s+/,$framepolicy);
                   18017:                 if (@policies) {
                   18018:                     if (grep(/^\Q'none'\E$/,@policies)) {
                   18019:                         $uselink = 1;
                   18020:                     } else {
                   18021:                         $uselink = 1;
                   18022:                         if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
                   18023:                                 (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
                   18024:                                 (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
                   18025:                             undef($uselink);
                   18026:                         }
                   18027:                         if ($uselink) {
                   18028:                             if (grep(/^\Q'self'\E$/,@policies)) {
                   18029:                                 if (($origin ne '') && ($remotehost eq $origin)) {
                   18030:                                     undef($uselink);
                   18031:                                 }
                   18032:                             }
                   18033:                         }
                   18034:                         if ($uselink) {
                   18035:                             my @possok;
                   18036:                             if ($ip ne '') {
                   18037:                                 push(@possok,$ip);
                   18038:                             }
                   18039:                             my $hoststr = '';
                   18040:                             foreach my $part (reverse(split(/\./,$hostname))) {
                   18041:                                 if ($hoststr eq '') {
                   18042:                                     $hoststr = $part;
                   18043:                                 } else {
                   18044:                                     $hoststr = "$part.$hoststr";
                   18045:                                 }
                   18046:                                 if ($hoststr eq $hostname) {
                   18047:                                     push(@possok,$hostname);
                   18048:                                 } else {
                   18049:                                     push(@possok,"*.$hoststr");
                   18050:                                 }
                   18051:                             }
                   18052:                             if (@possok) {
                   18053:                                 foreach my $poss (@possok) {
                   18054:                                     last if (!$uselink);
                   18055:                                     foreach my $policy (@policies) {
                   18056:                                         if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
                   18057:                                             undef($uselink);
                   18058:                                             last;
                   18059:                                         }
                   18060:                                     }
                   18061:                                 }
                   18062:                             }
                   18063:                         }
                   18064:                     }
                   18065:                 }
                   18066:             } elsif ($xframeop ne '') {
                   18067:                 $uselink = 1;
                   18068:                 my @policies = split(/\s*,\s*/,$xframeop);
                   18069:                 if (@policies) {
                   18070:                     unless (grep(/^deny$/,@policies)) {
                   18071:                         if ($origin ne '') {
                   18072:                             if (grep(/^sameorigin$/,@policies)) {
                   18073:                                 if ($remotehost eq $origin) {
                   18074:                                     undef($uselink);
                   18075:                                 }
                   18076:                             }
                   18077:                             if ($uselink) {
                   18078:                                 foreach my $policy (@policies) {
                   18079:                                     if ($policy =~ /^allow-from\s*(.+)$/) {
                   18080:                                         my $allowfrom = $1;
                   18081:                                         if (($allowfrom ne '') && ($allowfrom eq $origin)) {
                   18082:                                             undef($uselink);
                   18083:                                             last;
                   18084:                                         }
                   18085:                                     }
                   18086:                                 }
                   18087:                             }
                   18088:                         }
                   18089:                     }
                   18090:                 }
                   18091:             }
                   18092:         }
                   18093:     }
                   18094:     if ($nocache) {
                   18095:         if ($cached) {
                   18096:             my $devalidate;
                   18097:             if ($uselink && !$result) {
                   18098:                 $devalidate = 1;
                   18099:             } elsif (!$uselink && $result) {
                   18100:                 $devalidate = 1;
                   18101:             }
                   18102:             if ($devalidate) {
                   18103:                 &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
                   18104:             }
                   18105:         }
                   18106:     } else {
                   18107:         if ($uselink) {
                   18108:             $result = 1;
                   18109:         } else {
                   18110:             $result = 0;
                   18111:         }
                   18112:         &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
                   18113:     }
                   18114:     return $uselink;
                   18115: }
                   18116: 
1.1075.2.161.  .1(raebu 18117:21): sub page_menu {
                   18118:21):     my ($menucolls,$menunum) = @_;
                   18119:21):     my %menu;
                   18120:21):     foreach my $item (split(/;/,$menucolls)) {
                   18121:21):         my ($num,$value) = split(/\%/,$item);
                   18122:21):         if ($num eq $menunum) {
                   18123:21):             my @entries = split(/\&/,$value);
                   18124:21):             foreach my $entry (@entries) {
                   18125:21):                 my ($name,$fields) = split(/=/,$entry);
                   18126:21):                 if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
                   18127:21):                     $menu{$name} = $fields;
                   18128:21):                 } else {
                   18129:21):                     my @shown;
                   18130:21):                     if ($fields =~ /,/) {
                   18131:21):                         @shown = split(/,/,$fields);
                   18132:21):                     } else {
                   18133:21):                         @shown = ($fields);
                   18134:21):                     }
                   18135:21):                     if (@shown) {
                   18136:21):                         foreach my $field (@shown) {
                   18137:21):                             next if ($field eq '');
                   18138:21):                             $menu{$field} = 1;
                   18139:21):                         }
                   18140:21):                     }
                   18141:21):                 }
                   18142:21):             }
                   18143:21):         }
                   18144:21):     }
                   18145:21):     return %menu;
                   18146:21): }
                   18147:21): 
1.112     bowersj2 18148: 1;
                   18149: __END__;
1.41      ng       18150: 

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