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

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.  .1(raebu    4:21): # $Id: loncommon.pm,v 1.1075.2.161 2021/12/30 15:29:57 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.519     raeburn  5469:         } 
                   5470:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 5471:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   5472:         return &Apache::lonnet::domain($domain,'description');
1.59      www      5473:     } else {
1.60      matthew  5474:         return '';
1.59      www      5475:     }
                   5476: }
1.63      www      5477: ##############################################
                   5478: 
                   5479: =pod
                   5480: 
1.112     bowersj2 5481: =item * &designparm()
1.63      www      5482: 
                   5483: Inputs: $which parameter; $domain (usually will be undef)
                   5484: 
                   5485: Returns: value of designparamter $which
                   5486: 
                   5487: =cut
1.112     bowersj2 5488: 
1.397     albertel 5489: 
1.400     albertel 5490: ##############################################
1.397     albertel 5491: sub designparm {
                   5492:     my ($which,$domain)=@_;
                   5493:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   5494:         return $env{'environment.color.'.$which};
1.96      www      5495:     }
1.63      www      5496:     $domain=&determinedomain($domain);
1.1016    raeburn  5497:     my %domdesign;
                   5498:     unless ($domain eq 'public') {
                   5499:         %domdesign = &get_domainconf($domain);
                   5500:     }
1.520     raeburn  5501:     my $output;
1.517     raeburn  5502:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   5503:         $output = $domdesign{$domain.'.'.$which};
1.63      www      5504:     } else {
1.520     raeburn  5505:         $output = $defaultdesign{$which};
                   5506:     }
                   5507:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  5508:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 5509:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   5510:             if ($output =~ m{^/res/}) {
                   5511:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   5512:                 &Apache::lonnet::repcopy($local_name);
                   5513:             }
1.520     raeburn  5514:             $output = &lonhttpdurl($output);
                   5515:         }
1.63      www      5516:     }
1.520     raeburn  5517:     return $output;
1.63      www      5518: }
1.59      www      5519: 
1.822     bisitz   5520: ##############################################
                   5521: =pod
                   5522: 
1.832     bisitz   5523: =item * &authorspace()
                   5524: 
1.1028    raeburn  5525: Inputs: $url (usually will be undef).
1.832     bisitz   5526: 
1.1075.2.40  raeburn  5527: Returns: Path to Authoring Space containing the resource or 
1.1028    raeburn  5528:          directory being viewed (or for which action is being taken). 
                   5529:          If $url is provided, and begins /priv/<domain>/<uname>
                   5530:          the path will be that portion of the $context argument.
                   5531:          Otherwise the path will be for the author space of the current
                   5532:          user when the current role is author, or for that of the 
                   5533:          co-author/assistant co-author space when the current role 
                   5534:          is co-author or assistant co-author.
1.832     bisitz   5535: 
                   5536: =cut
                   5537: 
                   5538: sub authorspace {
1.1028    raeburn  5539:     my ($url) = @_;
                   5540:     if ($url ne '') {
                   5541:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   5542:            return $1;
                   5543:         }
                   5544:     }
1.832     bisitz   5545:     my $caname = '';
1.1024    www      5546:     my $cadom = '';
1.1028    raeburn  5547:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      5548:         ($cadom,$caname) =
1.832     bisitz   5549:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  5550:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   5551:         $caname = $env{'user.name'};
1.1024    www      5552:         $cadom = $env{'user.domain'};
1.832     bisitz   5553:     }
1.1028    raeburn  5554:     if (($caname ne '') && ($cadom ne '')) {
                   5555:         return "/priv/$cadom/$caname/";
                   5556:     }
                   5557:     return;
1.832     bisitz   5558: }
                   5559: 
                   5560: ##############################################
                   5561: =pod
                   5562: 
1.822     bisitz   5563: =item * &head_subbox()
                   5564: 
                   5565: Inputs: $content (contains HTML code with page functions, etc.)
                   5566: 
                   5567: Returns: HTML div with $content
                   5568:          To be included in page header
                   5569: 
                   5570: =cut
                   5571: 
                   5572: sub head_subbox {
                   5573:     my ($content)=@_;
                   5574:     my $output =
1.993     raeburn  5575:         '<div class="LC_head_subbox">'
1.822     bisitz   5576:        .$content
                   5577:        .'</div>'
                   5578: }
                   5579: 
                   5580: ##############################################
                   5581: =pod
                   5582: 
                   5583: =item * &CSTR_pageheader()
                   5584: 
1.1026    raeburn  5585: Input: (optional) filename from which breadcrumb trail is built.
                   5586:        In most cases no input as needed, as $env{'request.filename'}
                   5587:        is appropriate for use in building the breadcrumb trail.
1.822     bisitz   5588: 
                   5589: Returns: HTML div with CSTR path and recent box
1.1075.2.40  raeburn  5590:          To be included on Authoring Space pages
1.822     bisitz   5591: 
                   5592: =cut
                   5593: 
                   5594: sub CSTR_pageheader {
1.1026    raeburn  5595:     my ($trailfile) = @_;
                   5596:     if ($trailfile eq '') {
                   5597:         $trailfile = $env{'request.filename'};
                   5598:     }
                   5599: 
                   5600: # this is for resources; directories have customtitle, and crumbs
                   5601: # and select recent are created in lonpubdir.pm
                   5602: 
                   5603:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      5604:     my ($udom,$uname,$thisdisfn)=
1.1075.2.29  raeburn  5605:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026    raeburn  5606:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   5607:     $formaction =~ s{/+}{/}g;
1.822     bisitz   5608: 
                   5609:     my $parentpath = '';
                   5610:     my $lastitem = '';
                   5611:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   5612:         $parentpath = $1;
                   5613:         $lastitem = $2;
                   5614:     } else {
                   5615:         $lastitem = $thisdisfn;
                   5616:     }
1.921     bisitz   5617: 
                   5618:     my $output =
1.822     bisitz   5619:          '<div>'
                   5620:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1075.2.40  raeburn  5621:         .'<b>'.&mt('Authoring Space:').'</b> '
1.822     bisitz   5622:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   5623:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024    www      5624:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921     bisitz   5625: 
                   5626:     if ($lastitem) {
                   5627:         $output .=
                   5628:              '<span class="LC_filename">'
                   5629:             .$lastitem
                   5630:             .'</span>';
                   5631:     }
                   5632:     $output .=
                   5633:          '<br />'
1.822     bisitz   5634:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   5635:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   5636:         .'</form>'
                   5637:         .&Apache::lonmenu::constspaceform()
                   5638:         .'</div>';
1.921     bisitz   5639: 
                   5640:     return $output;
1.822     bisitz   5641: }
                   5642: 
1.60      matthew  5643: ###############################################
                   5644: ###############################################
                   5645: 
                   5646: =pod
                   5647: 
1.112     bowersj2 5648: =back
                   5649: 
1.549     albertel 5650: =head1 HTML Helpers
1.112     bowersj2 5651: 
                   5652: =over 4
                   5653: 
                   5654: =item * &bodytag()
1.60      matthew  5655: 
                   5656: Returns a uniform header for LON-CAPA web pages.
                   5657: 
                   5658: Inputs: 
                   5659: 
1.112     bowersj2 5660: =over 4
                   5661: 
                   5662: =item * $title, A title to be displayed on the page.
                   5663: 
                   5664: =item * $function, the current role (can be undef).
                   5665: 
                   5666: =item * $addentries, extra parameters for the <body> tag.
                   5667: 
                   5668: =item * $bodyonly, if defined, only return the <body> tag.
                   5669: 
                   5670: =item * $domain, if defined, force a given domain.
                   5671: 
                   5672: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      5673:             text interface only)
1.60      matthew  5674: 
1.814     bisitz   5675: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   5676:                      navigational links
1.317     albertel 5677: 
1.338     albertel 5678: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   5679: 
1.1075.2.12  raeburn  5680: =item * $no_inline_link, if true and in remote mode, don't show the
                   5681:          'Switch To Inline Menu' link
                   5682: 
1.460     albertel 5683: =item * $args, optional argument valid values are
                   5684:             no_auto_mt_title -> prevents &mt()ing the title arg
1.1075.2.133  raeburn  5685:             use_absolute     -> for external resource or syllabus, this will
                   5686:                                 contain https://<hostname> if server uses
                   5687:                                 https (as per hosts.tab), but request is for http
                   5688:             hostname         -> hostname, from $r->hostname().
1.460     albertel 5689: 
1.1075.2.15  raeburn  5690: =item * $advtoolsref, optional argument, ref to an array containing
                   5691:             inlineremote items to be added in "Functions" menu below
                   5692:             breadcrumbs.
                   5693: 
1.1075.2.161.  .1(raebu 5694:21): =item * $ltiscope, optional argument, will be one of: resource, map or
                   5695:21):             course, if LON-CAPA is in LTI Provider context. Value is
                   5696:21):             the scope of use, i.e., launch was for access to a single, a map
                   5697:21):             or the entire course.
                   5698:21): 
                   5699:21): =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
                   5700:21):             context, this will contain the URL for the landing item in
                   5701:21):             the course, after launch from an LTI Consumer
                   5702:21): 
                   5703:21): =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
                   5704:21):             context, this will contain a reference to hash of items
                   5705:21):             to be included in the page header and/or inline menu.
                   5706:21): 
1.112     bowersj2 5707: =back
                   5708: 
1.60      matthew  5709: Returns: A uniform header for LON-CAPA web pages.  
                   5710: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   5711: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   5712: other decorations will be returned.
                   5713: 
                   5714: =cut
                   5715: 
1.54      www      5716: sub bodytag {
1.831     bisitz   5717:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1075.2.161.  .1(raebu 5718:21):         $no_nav_bar,$bgcolor,$no_inline_link,$args,$advtoolsref,
                   5719:21):         $ltiscope,$ltiuri,$ltimenu,$menucoll,$menuref)=@_;
1.339     albertel 5720: 
1.954     raeburn  5721:     my $public;
                   5722:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   5723:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   5724:         $public = 1;
                   5725:     }
1.460     albertel 5726:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1075.2.52  raeburn  5727:     my $httphost = $args->{'use_absolute'};
1.1075.2.133  raeburn  5728:     my $hostname = $args->{'hostname'};
1.339     albertel 5729: 
1.183     matthew  5730:     $function = &get_users_function() if (!$function);
1.339     albertel 5731:     my $img =    &designparm($function.'.img',$domain);
                   5732:     my $font =   &designparm($function.'.font',$domain);
                   5733:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   5734: 
1.803     bisitz   5735:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 5736: 		   'bgcolor' => $pgbg,
1.339     albertel 5737: 		   'text'    => $font,
                   5738:                    'alink'   => &designparm($function.'.alink',$domain),
                   5739: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   5740: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 5741:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 5742: 
1.63      www      5743:  # role and realm
1.1075.2.68  raeburn  5744:     my ($role,$realm) = split(m{\./},$env{'request.role'},2);
                   5745:     if ($realm) {
                   5746:         $realm = '/'.$realm;
                   5747:     }
1.1075.2.159  raeburn  5748:     if ($role eq 'ca') {
1.479     albertel 5749:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 5750:         $realm = &plainname($rname,$rdom);
1.378     raeburn  5751:     } 
1.55      www      5752: # realm
1.1075.2.158  raeburn  5753:     my ($cid,$sec);
1.258     albertel 5754:     if ($env{'request.course.id'}) {
1.1075.2.158  raeburn  5755:         $cid = $env{'request.course.id'};
                   5756:         if ($env{'request.course.sec'}) {
                   5757:             $sec = $env{'request.course.sec'};
                   5758:         }
                   5759:     } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
                   5760:         if (&Apache::lonnet::is_course($1,$2)) {
                   5761:             $cid = $1.'_'.$2;
                   5762:             $sec = $3;
                   5763:         }
                   5764:     }
                   5765:     if ($cid) {
1.378     raeburn  5766:         if ($env{'request.role'} !~ /^cr/) {
                   5767:             $role = &Apache::lonnet::plaintext($role,&course_type());
1.1075.2.115  raeburn  5768:         } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1075.2.121  raeburn  5769:             if ($env{'request.role.desc'}) {
                   5770:                 $role = $env{'request.role.desc'};
                   5771:             } else {
                   5772:                 $role = &mt('Helpdesk[_1]','&nbsp;'.$2);
                   5773:             }
1.1075.2.115  raeburn  5774:         } else {
                   5775:             $role = (split(/\//,$role,4))[-1];
1.378     raeburn  5776:         }
1.1075.2.158  raeburn  5777:         if ($sec) {
                   5778:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$sec;
1.898     raeburn  5779:         }   
1.1075.2.158  raeburn  5780: 	$realm = $env{'course.'.$cid.'.description'};
1.378     raeburn  5781:     } else {
                   5782:         $role = &Apache::lonnet::plaintext($role);
1.54      www      5783:     }
1.433     albertel 5784: 
1.359     albertel 5785:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 5786: 
1.438     albertel 5787:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 5788: 
1.101     www      5789: # construct main body tag
1.359     albertel 5790:     my $bodytag = "<body $extra_body_attr>".
1.1075.2.100  raeburn  5791: 	&Apache::lontexconvert::init_math_support();
1.252     albertel 5792: 
1.1075.2.38  raeburn  5793:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   5794: 
                   5795:     if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60      matthew  5796:         return $bodytag;
1.1075.2.38  raeburn  5797:     }
1.359     albertel 5798: 
1.954     raeburn  5799:     if ($public) {
1.433     albertel 5800: 	undef($role);
                   5801:     }
1.1075.2.158  raeburn  5802: 
1.1075.2.161.  .1(raebu 5803:21):     my $showcrstitle = 1;
                   5804:21):     if (($cid) && ($env{'request.lti.login'})) {
                   5805:21):         if (ref($ltimenu) eq 'HASH') {
                   5806:21):             unless ($ltimenu->{'role'}) {
                   5807:21):                 undef($role);
                   5808:21):             }
                   5809:21):             unless ($ltimenu->{'coursetitle'}) {
                   5810:21):                 $realm='&nbsp;';
                   5811:21):                 $showcrstitle = 0;
                   5812:21):             }
                   5813:21):         }
                   5814:21):     } elsif (($cid) && ($menucoll)) {
                   5815:21):         if (ref($menuref) eq 'HASH') {
                   5816:21):             unless ($menuref->{'role'}) {
                   5817:21):                 undef($role);
                   5818:21):             }
                   5819:21):             unless ($menuref->{'crs'}) {
                   5820:21):                 $realm='&nbsp;';
                   5821:21):                 $showcrstitle = 0;
                   5822:21):             }
                   5823:21):         }
                   5824:21):     }
                   5825:21): 
1.762     bisitz   5826:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 5827:     #
                   5828:     # Extra info if you are the DC
                   5829:     my $dc_info = '';
1.1075.2.161.  .1(raebu 5830:21):     if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1075.2.158  raeburn  5831:         (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917     raeburn  5832:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      5833:         $dc_info =~ s/\s+$//;
1.359     albertel 5834:     }
                   5835: 
1.1075.2.161.  .1(raebu 5836:21):     my $crstype;
                   5837:21):     if ($cid) {
                   5838:21):         $crstype = $env{'course.'.$cid.'.type'};
                   5839:21):     } elsif ($args->{'crstype'}) {
                   5840:21):         $crstype = $args->{'crstype'};
                   5841:21):     }
                   5842:21): 
1.1075.2.108  raeburn  5843:     $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.903     droeschl 5844: 
1.1075.2.13  raeburn  5845:     if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   5846: 
1.1075.2.38  raeburn  5847: 
                   5848: 
1.1075.2.21  raeburn  5849:     my $funclist;
                   5850:     if (($env{'environment.remote'} eq 'on') && ($env{'request.state'} ne 'construct')) {
1.1075.2.52  raeburn  5851:         $bodytag .= Apache::lonhtmlcommon::scripttag(Apache::lonmenu::utilityfunctions($httphost), 'start')."\n".
1.1075.2.21  raeburn  5852:                     Apache::lonmenu::serverform();
                   5853:         my $forbodytag;
                   5854:         &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5855:                                             $forcereg,$args->{'group'},
                   5856:                                             $args->{'bread_crumbs'},
1.1075.2.133  raeburn  5857:                                             $advtoolsref,'','',\$forbodytag);
1.1075.2.21  raeburn  5858:         unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5859:             $funclist = $forbodytag;
                   5860:         }
                   5861:     } else {
1.903     droeschl 5862: 
                   5863:         #    if ($env{'request.state'} eq 'construct') {
                   5864:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   5865:         #    }
                   5866: 
1.1075.2.38  raeburn  5867:         $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  5868:             Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359     albertel 5869: 
1.1075.2.161.  .1(raebu 5870:21):         unless ($args->{'no_primary_menu'}) {
                   5871:21):             my ($left,$right) = Apache::lonmenu::primary_menu($args->{'links_disabled'});
1.1075.2.2  raeburn  5872: 
1.1075.2.161.  .1(raebu 5873:21):             if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
                   5874:21):                 if ($dc_info) {
                   5875:21):                     $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   5876:21):                 }
                   5877:21):                 $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
                   5878:21):                                <em>$realm</em> $dc_info</div>|;
                   5879:21):                 return $bodytag;
1.1075.2.1  raeburn  5880:             }
1.894     droeschl 5881: 
1.1075.2.161.  .1(raebu 5882:21):             unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
                   5883:21):                 $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
                   5884:21):             }
1.916     droeschl 5885: 
1.1075.2.161.  .1(raebu 5886:21):             $bodytag .= $right;
1.852     droeschl 5887: 
1.1075.2.161.  .1(raebu 5888:21):             if ($dc_info) {
                   5889:21):                 $dc_info = &dc_courseid_toggle($dc_info);
                   5890:21):             }
                   5891:21):             $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917     raeburn  5892:         }
1.916     droeschl 5893: 
1.1075.2.61  raeburn  5894:         #if directed to not display the secondary menu, don't.
                   5895:         if ($args->{'no_secondary_menu'}) {
                   5896:             return $bodytag;
                   5897:         }
1.903     droeschl 5898:         #don't show menus for public users
1.954     raeburn  5899:         if (!$public){
1.1075.2.161.  .1(raebu 5900:21):             unless ($args->{'no_inline_menu'}) {
                   5901:21):                 $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
                   5902:21):                                                             $args->{'no_primary_menu'},
                   5903:21):                                                             $menucoll,$menuref,
                   5904:21):                                                             $args->{'links_disabled'});
                   5905:21):             }
1.903     droeschl 5906:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  5907:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   5908:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 5909:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1075.2.161.  .1(raebu 5910:21):                                 $args->{'bread_crumbs'},'','',$hostname,$ltiscope,$ltiuri);
1.1075.2.116  raeburn  5911:             } elsif ($forcereg) {
1.1075.2.22  raeburn  5912:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1075.2.116  raeburn  5913:                                                             $args->{'group'},
1.1075.2.161  raeburn  5914:                                                             $args->{'hide_buttons'},
1.1075.2.161.  .1(raebu 5915:21):                                                             $hostname,$ltiscope,$ltiuri);
1.1075.2.15  raeburn  5916:             } else {
1.1075.2.21  raeburn  5917:                 my $forbodytag;
                   5918:                 &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5919:                                                     $forcereg,$args->{'group'},
                   5920:                                                     $args->{'bread_crumbs'},
1.1075.2.133  raeburn  5921:                                                     $advtoolsref,'',$hostname,
                   5922:                                                     \$forbodytag);
1.1075.2.21  raeburn  5923:                 unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5924:                     $bodytag .= $forbodytag;
                   5925:                 }
1.920     raeburn  5926:             }
1.903     droeschl 5927:         }else{
                   5928:             # this is to seperate menu from content when there's no secondary
                   5929:             # menu. Especially needed for public accessible ressources.
                   5930:             $bodytag .= '<hr style="clear:both" />';
                   5931:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  5932:         }
1.903     droeschl 5933: 
1.235     raeburn  5934:         return $bodytag;
1.1075.2.12  raeburn  5935:     }
                   5936: 
                   5937: #
                   5938: # Top frame rendering, Remote is up
                   5939: #
                   5940: 
                   5941:     my $imgsrc = $img;
                   5942:     if ($img =~ /^\/adm/) {
                   5943:         $imgsrc = &lonhttpdurl($img);
                   5944:     }
                   5945:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
                   5946: 
1.1075.2.60  raeburn  5947:     my $help=($no_inline_link?''
                   5948:               :&Apache::loncommon::top_nav_help('Help'));
                   5949: 
1.1075.2.12  raeburn  5950:     # Explicit link to get inline menu
                   5951:     my $menu= ($no_inline_link?''
                   5952:                :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
                   5953: 
                   5954:     if ($dc_info) {
                   5955:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   5956:     }
                   5957: 
1.1075.2.38  raeburn  5958:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
                   5959:     unless ($public) {
                   5960:         $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
                   5961:                                 undef,'LC_menubuttons_link');
                   5962:     }
                   5963: 
1.1075.2.12  raeburn  5964:     unless ($env{'form.inhibitmenu'}) {
                   5965:         $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.1075.2.38  raeburn  5966:                        <ol class="LC_primary_menu LC_floatright LC_right">
1.1075.2.60  raeburn  5967:                        <li>$help</li>
1.1075.2.12  raeburn  5968:                        <li>$menu</li>
                   5969:                        </ol><div id="LC_realm"> $realm $dc_info</div>|;
                   5970:     }
1.1075.2.13  raeburn  5971:     if ($env{'request.state'} eq 'construct') {
                   5972:         if (!$public){
                   5973:             if ($env{'request.state'} eq 'construct') {
                   5974:                 $funclist = &Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  5975:                                 &Apache::lonmenu::utilityfunctions($httphost), 'start').
1.1075.2.13  raeburn  5976:                             &Apache::lonhtmlcommon::scripttag('','end').
                   5977:                             &Apache::lonmenu::innerregister($forcereg,
                   5978:                                                             $args->{'bread_crumbs'});
                   5979:             }
                   5980:         }
                   5981:     }
1.1075.2.21  raeburn  5982:     return $bodytag."\n".$funclist;
1.182     matthew  5983: }
                   5984: 
1.917     raeburn  5985: sub dc_courseid_toggle {
                   5986:     my ($dc_info) = @_;
1.980     raeburn  5987:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  5988:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  5989:            &mt('(More ...)').'</a></span>'.
                   5990:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5991: }
                   5992: 
1.330     albertel 5993: sub make_attr_string {
                   5994:     my ($register,$attr_ref) = @_;
                   5995: 
                   5996:     if ($attr_ref && !ref($attr_ref)) {
                   5997: 	die("addentries Must be a hash ref ".
                   5998: 	    join(':',caller(1))." ".
                   5999: 	    join(':',caller(0))." ");
                   6000:     }
                   6001: 
                   6002:     if ($register) {
1.339     albertel 6003: 	my ($on_load,$on_unload);
                   6004: 	foreach my $key (keys(%{$attr_ref})) {
                   6005: 	    if      (lc($key) eq 'onload') {
                   6006: 		$on_load.=$attr_ref->{$key}.';';
                   6007: 		delete($attr_ref->{$key});
                   6008: 
                   6009: 	    } elsif (lc($key) eq 'onunload') {
                   6010: 		$on_unload.=$attr_ref->{$key}.';';
                   6011: 		delete($attr_ref->{$key});
                   6012: 	    }
                   6013: 	}
1.1075.2.12  raeburn  6014:         if ($env{'environment.remote'} eq 'on') {
                   6015:             $attr_ref->{'onload'}  =
                   6016:                 &Apache::lonmenu::loadevents().  $on_load;
                   6017:             $attr_ref->{'onunload'}=
                   6018:                 &Apache::lonmenu::unloadevents().$on_unload;
                   6019:         } else {  
                   6020: 	    $attr_ref->{'onload'}  = $on_load;
                   6021: 	    $attr_ref->{'onunload'}= $on_unload;
                   6022:         }
1.330     albertel 6023:     }
1.339     albertel 6024: 
1.330     albertel 6025:     my $attr_string;
1.1075.2.56  raeburn  6026:     foreach my $attr (sort(keys(%$attr_ref))) {
1.330     albertel 6027: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   6028:     }
                   6029:     return $attr_string;
                   6030: }
                   6031: 
                   6032: 
1.182     matthew  6033: ###############################################
1.251     albertel 6034: ###############################################
                   6035: 
                   6036: =pod
                   6037: 
                   6038: =item * &endbodytag()
                   6039: 
                   6040: Returns a uniform footer for LON-CAPA web pages.
                   6041: 
1.635     raeburn  6042: Inputs: 1 - optional reference to an args hash
                   6043: If in the hash, key for noredirectlink has a value which evaluates to true,
                   6044: a 'Continue' link is not displayed if the page contains an
                   6045: internal redirect in the <head></head> section,
                   6046: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 6047: 
                   6048: =cut
                   6049: 
                   6050: sub endbodytag {
1.635     raeburn  6051:     my ($args) = @_;
1.1075.2.6  raeburn  6052:     my $endbodytag;
                   6053:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   6054:         $endbodytag='</body>';
                   6055:     }
1.315     albertel 6056:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  6057:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   6058: 	    $endbodytag=
                   6059: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   6060: 	        &mt('Continue').'</a>'.
                   6061: 	        $endbodytag;
                   6062:         }
1.315     albertel 6063:     }
1.251     albertel 6064:     return $endbodytag;
                   6065: }
                   6066: 
1.352     albertel 6067: =pod
                   6068: 
                   6069: =item * &standard_css()
                   6070: 
                   6071: Returns a style sheet
                   6072: 
                   6073: Inputs: (all optional)
                   6074:             domain         -> force to color decorate a page for a specific
                   6075:                                domain
                   6076:             function       -> force usage of a specific rolish color scheme
                   6077:             bgcolor        -> override the default page bgcolor
                   6078: 
                   6079: =cut
                   6080: 
1.343     albertel 6081: sub standard_css {
1.345     albertel 6082:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 6083:     $function  = &get_users_function() if (!$function);
                   6084:     my $img    = &designparm($function.'.img',   $domain);
                   6085:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   6086:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 6087:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 6088: #second colour for later usage
1.345     albertel 6089:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 6090:     my $pgbg_or_bgcolor =
                   6091: 	         $bgcolor ||
1.352     albertel 6092: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 6093:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 6094:     my $alink  = &designparm($function.'.alink', $domain);
                   6095:     my $vlink  = &designparm($function.'.vlink', $domain);
                   6096:     my $link   = &designparm($function.'.link',  $domain);
                   6097: 
1.602     albertel 6098:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 6099:     my $mono                 = 'monospace';
1.850     bisitz   6100:     my $data_table_head      = $sidebg;
                   6101:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   6102:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 6103:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 6104:     my $data_table_highlight = '#FFFF00';
1.352     albertel 6105:     my $mail_new             = '#FFBB77';
                   6106:     my $mail_new_hover       = '#DD9955';
                   6107:     my $mail_read            = '#BBBB77';
                   6108:     my $mail_read_hover      = '#999944';
                   6109:     my $mail_replied         = '#AAAA88';
                   6110:     my $mail_replied_hover   = '#888855';
                   6111:     my $mail_other           = '#99BBBB';
                   6112:     my $mail_other_hover     = '#669999';
1.391     albertel 6113:     my $table_header         = '#DDDDDD';
1.489     raeburn  6114:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   6115:     my $lg_border_color      = '#C8C8C8';
1.952     onken    6116:     my $button_hover         = '#BF2317';
1.392     albertel 6117: 
1.608     albertel 6118:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   6119:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   6120:                                              : '0 3px 0 4px';
1.448     albertel 6121: 
1.523     albertel 6122: 
1.343     albertel 6123:     return <<END;
1.947     droeschl 6124: 
                   6125: /* needed for iframe to allow 100% height in FF */
                   6126: body, html { 
                   6127:     margin: 0;
                   6128:     padding: 0 0.5%;
                   6129:     height: 99%; /* to avoid scrollbars */
                   6130: }
                   6131: 
1.795     www      6132: body {
1.911     bisitz   6133:   font-family: $sans;
                   6134:   line-height:130%;
                   6135:   font-size:0.83em;
                   6136:   color:$font;
1.795     www      6137: }
                   6138: 
1.959     onken    6139: a:focus,
                   6140: a:focus img {
1.795     www      6141:   color: red;
                   6142: }
1.698     harmsja  6143: 
1.911     bisitz   6144: form, .inline {
                   6145:   display: inline;
1.795     www      6146: }
1.721     harmsja  6147: 
1.795     www      6148: .LC_right {
1.911     bisitz   6149:   text-align:right;
1.795     www      6150: }
                   6151: 
                   6152: .LC_middle {
1.911     bisitz   6153:   vertical-align:middle;
1.795     www      6154: }
1.721     harmsja  6155: 
1.1075.2.38  raeburn  6156: .LC_floatleft {
                   6157:   float: left;
                   6158: }
                   6159: 
                   6160: .LC_floatright {
                   6161:   float: right;
                   6162: }
                   6163: 
1.911     bisitz   6164: .LC_400Box {
                   6165:   width:400px;
                   6166: }
1.721     harmsja  6167: 
1.947     droeschl 6168: .LC_iframecontainer {
                   6169:     width: 98%;
                   6170:     margin: 0;
                   6171:     position: fixed;
                   6172:     top: 8.5em;
                   6173:     bottom: 0;
                   6174: }
                   6175: 
                   6176: .LC_iframecontainer iframe{
                   6177:     border: none;
                   6178:     width: 100%;
                   6179:     height: 100%;
                   6180: }
                   6181: 
1.778     bisitz   6182: .LC_filename {
                   6183:   font-family: $mono;
                   6184:   white-space:pre;
1.921     bisitz   6185:   font-size: 120%;
1.778     bisitz   6186: }
                   6187: 
                   6188: .LC_fileicon {
                   6189:   border: none;
                   6190:   height: 1.3em;
                   6191:   vertical-align: text-bottom;
                   6192:   margin-right: 0.3em;
                   6193:   text-decoration:none;
                   6194: }
                   6195: 
1.1008    www      6196: .LC_setting {
                   6197:   text-decoration:underline;
                   6198: }
                   6199: 
1.350     albertel 6200: .LC_error {
                   6201:   color: red;
                   6202: }
1.795     www      6203: 
1.1075.2.15  raeburn  6204: .LC_warning {
                   6205:   color: darkorange;
                   6206: }
                   6207: 
1.457     albertel 6208: .LC_diff_removed {
1.733     bisitz   6209:   color: red;
1.394     albertel 6210: }
1.532     albertel 6211: 
                   6212: .LC_info,
1.457     albertel 6213: .LC_success,
                   6214: .LC_diff_added {
1.350     albertel 6215:   color: green;
                   6216: }
1.795     www      6217: 
1.802     bisitz   6218: div.LC_confirm_box {
                   6219:   background-color: #FAFAFA;
                   6220:   border: 1px solid $lg_border_color;
                   6221:   margin-right: 0;
                   6222:   padding: 5px;
                   6223: }
                   6224: 
                   6225: div.LC_confirm_box .LC_error img,
                   6226: div.LC_confirm_box .LC_success img {
                   6227:   vertical-align: middle;
                   6228: }
                   6229: 
1.1075.2.108  raeburn  6230: .LC_maxwidth {
                   6231:   max-width: 100%;
                   6232:   height: auto;
                   6233: }
                   6234: 
                   6235: .LC_textsize_mobile {
                   6236:   \@media only screen and (max-device-width: 480px) {
                   6237:       -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
                   6238:   }
                   6239: }
                   6240: 
1.440     albertel 6241: .LC_icon {
1.771     droeschl 6242:   border: none;
1.790     droeschl 6243:   vertical-align: middle;
1.771     droeschl 6244: }
                   6245: 
1.543     albertel 6246: .LC_docs_spacer {
                   6247:   width: 25px;
                   6248:   height: 1px;
1.771     droeschl 6249:   border: none;
1.543     albertel 6250: }
1.346     albertel 6251: 
1.532     albertel 6252: .LC_internal_info {
1.735     bisitz   6253:   color: #999999;
1.532     albertel 6254: }
                   6255: 
1.794     www      6256: .LC_discussion {
1.1050    www      6257:   background: $data_table_dark;
1.911     bisitz   6258:   border: 1px solid black;
                   6259:   margin: 2px;
1.794     www      6260: }
                   6261: 
                   6262: .LC_disc_action_left {
1.1050    www      6263:   background: $sidebg;
1.911     bisitz   6264:   text-align: left;
1.1050    www      6265:   padding: 4px;
                   6266:   margin: 2px;
1.794     www      6267: }
                   6268: 
                   6269: .LC_disc_action_right {
1.1050    www      6270:   background: $sidebg;
1.911     bisitz   6271:   text-align: right;
1.1050    www      6272:   padding: 4px;
                   6273:   margin: 2px;
1.794     www      6274: }
                   6275: 
                   6276: .LC_disc_new_item {
1.911     bisitz   6277:   background: white;
                   6278:   border: 2px solid red;
1.1050    www      6279:   margin: 4px;
                   6280:   padding: 4px;
1.794     www      6281: }
                   6282: 
                   6283: .LC_disc_old_item {
1.911     bisitz   6284:   background: white;
1.1050    www      6285:   margin: 4px;
                   6286:   padding: 4px;
1.794     www      6287: }
                   6288: 
1.458     albertel 6289: table.LC_pastsubmission {
                   6290:   border: 1px solid black;
                   6291:   margin: 2px;
                   6292: }
                   6293: 
1.924     bisitz   6294: table#LC_menubuttons {
1.345     albertel 6295:   width: 100%;
                   6296:   background: $pgbg;
1.392     albertel 6297:   border: 2px;
1.402     albertel 6298:   border-collapse: separate;
1.803     bisitz   6299:   padding: 0;
1.345     albertel 6300: }
1.392     albertel 6301: 
1.801     tempelho 6302: table#LC_title_bar a {
                   6303:   color: $fontmenu;
                   6304: }
1.836     bisitz   6305: 
1.807     droeschl 6306: table#LC_title_bar {
1.819     tempelho 6307:   clear: both;
1.836     bisitz   6308:   display: none;
1.807     droeschl 6309: }
                   6310: 
1.795     www      6311: table#LC_title_bar,
1.933     droeschl 6312: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 6313: table#LC_title_bar.LC_with_remote {
1.359     albertel 6314:   width: 100%;
1.392     albertel 6315:   border-color: $pgbg;
                   6316:   border-style: solid;
                   6317:   border-width: $border;
1.379     albertel 6318:   background: $pgbg;
1.801     tempelho 6319:   color: $fontmenu;
1.392     albertel 6320:   border-collapse: collapse;
1.803     bisitz   6321:   padding: 0;
1.819     tempelho 6322:   margin: 0;
1.359     albertel 6323: }
1.795     www      6324: 
1.933     droeschl 6325: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 6326:     margin: 0;
                   6327:     padding: 0;
1.933     droeschl 6328:     position: relative;
                   6329:     list-style: none;
1.913     droeschl 6330: }
1.933     droeschl 6331: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 6332:     display: inline;
                   6333: }
1.933     droeschl 6334: 
                   6335: .LC_breadcrumb_tools_navigation {
1.913     droeschl 6336:     padding: 0;
1.933     droeschl 6337:     margin: 0;
                   6338:     float: left;
1.913     droeschl 6339: }
1.933     droeschl 6340: .LC_breadcrumb_tools_tools {
                   6341:     padding: 0;
                   6342:     margin: 0;
1.913     droeschl 6343:     float: right;
                   6344: }
                   6345: 
1.359     albertel 6346: table#LC_title_bar td {
                   6347:   background: $tabbg;
                   6348: }
1.795     www      6349: 
1.911     bisitz   6350: table#LC_menubuttons img {
1.803     bisitz   6351:   border: none;
1.346     albertel 6352: }
1.795     www      6353: 
1.842     droeschl 6354: .LC_breadcrumbs_component {
1.911     bisitz   6355:   float: right;
                   6356:   margin: 0 1em;
1.357     albertel 6357: }
1.842     droeschl 6358: .LC_breadcrumbs_component img {
1.911     bisitz   6359:   vertical-align: middle;
1.777     tempelho 6360: }
1.795     www      6361: 
1.1075.2.108  raeburn  6362: .LC_breadcrumbs_hoverable {
                   6363:   background: $sidebg;
                   6364: }
                   6365: 
1.383     albertel 6366: td.LC_table_cell_checkbox {
                   6367:   text-align: center;
                   6368: }
1.795     www      6369: 
                   6370: .LC_fontsize_small {
1.911     bisitz   6371:   font-size: 70%;
1.705     tempelho 6372: }
                   6373: 
1.844     bisitz   6374: #LC_breadcrumbs {
1.911     bisitz   6375:   clear:both;
                   6376:   background: $sidebg;
                   6377:   border-bottom: 1px solid $lg_border_color;
                   6378:   line-height: 2.5em;
1.933     droeschl 6379:   overflow: hidden;
1.911     bisitz   6380:   margin: 0;
                   6381:   padding: 0;
1.995     raeburn  6382:   text-align: left;
1.819     tempelho 6383: }
1.862     bisitz   6384: 
1.1075.2.16  raeburn  6385: .LC_head_subbox, .LC_actionbox {
1.911     bisitz   6386:   clear:both;
                   6387:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 6388:   border: 1px solid $sidebg;
1.1075.2.16  raeburn  6389:   margin: 0 0 10px 0;
1.966     bisitz   6390:   padding: 3px;
1.995     raeburn  6391:   text-align: left;
1.822     bisitz   6392: }
                   6393: 
1.795     www      6394: .LC_fontsize_medium {
1.911     bisitz   6395:   font-size: 85%;
1.705     tempelho 6396: }
                   6397: 
1.795     www      6398: .LC_fontsize_large {
1.911     bisitz   6399:   font-size: 120%;
1.705     tempelho 6400: }
                   6401: 
1.346     albertel 6402: .LC_menubuttons_inline_text {
                   6403:   color: $font;
1.698     harmsja  6404:   font-size: 90%;
1.701     harmsja  6405:   padding-left:3px;
1.346     albertel 6406: }
                   6407: 
1.934     droeschl 6408: .LC_menubuttons_inline_text img{
                   6409:   vertical-align: middle;
                   6410: }
                   6411: 
1.1051    www      6412: li.LC_menubuttons_inline_text img {
1.951     onken    6413:   cursor:pointer;
1.1002    droeschl 6414:   text-decoration: none;
1.951     onken    6415: }
                   6416: 
1.526     www      6417: .LC_menubuttons_link {
                   6418:   text-decoration: none;
                   6419: }
1.795     www      6420: 
1.522     albertel 6421: .LC_menubuttons_category {
1.521     www      6422:   color: $font;
1.526     www      6423:   background: $pgbg;
1.521     www      6424:   font-size: larger;
                   6425:   font-weight: bold;
                   6426: }
                   6427: 
1.346     albertel 6428: td.LC_menubuttons_text {
1.911     bisitz   6429:   color: $font;
1.346     albertel 6430: }
1.706     harmsja  6431: 
1.346     albertel 6432: .LC_current_location {
                   6433:   background: $tabbg;
                   6434: }
1.795     www      6435: 
1.1075.2.134  raeburn  6436: td.LC_zero_height {
                   6437:   line-height: 0;
                   6438:   cellpadding: 0;
                   6439: }
                   6440: 
1.938     bisitz   6441: table.LC_data_table {
1.347     albertel 6442:   border: 1px solid #000000;
1.402     albertel 6443:   border-collapse: separate;
1.426     albertel 6444:   border-spacing: 1px;
1.610     albertel 6445:   background: $pgbg;
1.347     albertel 6446: }
1.795     www      6447: 
1.422     albertel 6448: .LC_data_table_dense {
                   6449:   font-size: small;
                   6450: }
1.795     www      6451: 
1.507     raeburn  6452: table.LC_nested_outer {
                   6453:   border: 1px solid #000000;
1.589     raeburn  6454:   border-collapse: collapse;
1.803     bisitz   6455:   border-spacing: 0;
1.507     raeburn  6456:   width: 100%;
                   6457: }
1.795     www      6458: 
1.879     raeburn  6459: table.LC_innerpickbox,
1.507     raeburn  6460: table.LC_nested {
1.803     bisitz   6461:   border: none;
1.589     raeburn  6462:   border-collapse: collapse;
1.803     bisitz   6463:   border-spacing: 0;
1.507     raeburn  6464:   width: 100%;
                   6465: }
1.795     www      6466: 
1.911     bisitz   6467: table.LC_data_table tr th,
                   6468: table.LC_calendar tr th,
1.879     raeburn  6469: table.LC_prior_tries tr th,
                   6470: table.LC_innerpickbox tr th {
1.349     albertel 6471:   font-weight: bold;
                   6472:   background-color: $data_table_head;
1.801     tempelho 6473:   color:$fontmenu;
1.701     harmsja  6474:   font-size:90%;
1.347     albertel 6475: }
1.795     www      6476: 
1.879     raeburn  6477: table.LC_innerpickbox tr th,
                   6478: table.LC_innerpickbox tr td {
                   6479:   vertical-align: top;
                   6480: }
                   6481: 
1.711     raeburn  6482: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   6483:   background-color: #CCCCCC;
1.711     raeburn  6484:   font-weight: bold;
                   6485:   text-align: left;
                   6486: }
1.795     www      6487: 
1.912     bisitz   6488: table.LC_data_table tr.LC_odd_row > td {
                   6489:   background-color: $data_table_light;
                   6490:   padding: 2px;
                   6491:   vertical-align: top;
                   6492: }
                   6493: 
1.809     bisitz   6494: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 6495:   background-color: $data_table_light;
1.912     bisitz   6496:   vertical-align: top;
                   6497: }
                   6498: 
                   6499: table.LC_data_table tr.LC_even_row > td {
                   6500:   background-color: $data_table_dark;
1.425     albertel 6501:   padding: 2px;
1.900     bisitz   6502:   vertical-align: top;
1.347     albertel 6503: }
1.795     www      6504: 
1.809     bisitz   6505: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 6506:   background-color: $data_table_dark;
1.900     bisitz   6507:   vertical-align: top;
1.347     albertel 6508: }
1.795     www      6509: 
1.425     albertel 6510: table.LC_data_table tr.LC_data_table_highlight td {
                   6511:   background-color: $data_table_darker;
                   6512: }
1.795     www      6513: 
1.639     raeburn  6514: table.LC_data_table tr td.LC_leftcol_header {
                   6515:   background-color: $data_table_head;
                   6516:   font-weight: bold;
                   6517: }
1.795     www      6518: 
1.451     albertel 6519: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  6520: table.LC_nested tr.LC_empty_row td {
1.421     albertel 6521:   font-weight: bold;
                   6522:   font-style: italic;
                   6523:   text-align: center;
                   6524:   padding: 8px;
1.347     albertel 6525: }
1.795     www      6526: 
1.1075.2.30  raeburn  6527: table.LC_data_table tr.LC_empty_row td,
                   6528: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   6529:   background-color: $sidebg;
                   6530: }
                   6531: 
                   6532: table.LC_nested tr.LC_empty_row td {
                   6533:   background-color: #FFFFFF;
                   6534: }
                   6535: 
1.890     droeschl 6536: table.LC_caption {
                   6537: }
                   6538: 
1.507     raeburn  6539: table.LC_nested tr.LC_empty_row td {
1.465     albertel 6540:   padding: 4ex
                   6541: }
1.795     www      6542: 
1.507     raeburn  6543: table.LC_nested_outer tr th {
                   6544:   font-weight: bold;
1.801     tempelho 6545:   color:$fontmenu;
1.507     raeburn  6546:   background-color: $data_table_head;
1.701     harmsja  6547:   font-size: small;
1.507     raeburn  6548:   border-bottom: 1px solid #000000;
                   6549: }
1.795     www      6550: 
1.507     raeburn  6551: table.LC_nested_outer tr td.LC_subheader {
                   6552:   background-color: $data_table_head;
                   6553:   font-weight: bold;
                   6554:   font-size: small;
                   6555:   border-bottom: 1px solid #000000;
                   6556:   text-align: right;
1.451     albertel 6557: }
1.795     www      6558: 
1.507     raeburn  6559: table.LC_nested tr.LC_info_row td {
1.735     bisitz   6560:   background-color: #CCCCCC;
1.451     albertel 6561:   font-weight: bold;
                   6562:   font-size: small;
1.507     raeburn  6563:   text-align: center;
                   6564: }
1.795     www      6565: 
1.589     raeburn  6566: table.LC_nested tr.LC_info_row td.LC_left_item,
                   6567: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  6568:   text-align: left;
1.451     albertel 6569: }
1.795     www      6570: 
1.507     raeburn  6571: table.LC_nested td {
1.735     bisitz   6572:   background-color: #FFFFFF;
1.451     albertel 6573:   font-size: small;
1.507     raeburn  6574: }
1.795     www      6575: 
1.507     raeburn  6576: table.LC_nested_outer tr th.LC_right_item,
                   6577: table.LC_nested tr.LC_info_row td.LC_right_item,
                   6578: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   6579: table.LC_nested tr td.LC_right_item {
1.451     albertel 6580:   text-align: right;
                   6581: }
                   6582: 
1.507     raeburn  6583: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   6584:   background-color: #EEEEEE;
1.451     albertel 6585: }
                   6586: 
1.473     raeburn  6587: table.LC_createuser {
                   6588: }
                   6589: 
                   6590: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  6591:   font-size: small;
1.473     raeburn  6592: }
                   6593: 
                   6594: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   6595:   background-color: #CCCCCC;
1.473     raeburn  6596:   font-weight: bold;
                   6597:   text-align: center;
                   6598: }
                   6599: 
1.349     albertel 6600: table.LC_calendar {
                   6601:   border: 1px solid #000000;
                   6602:   border-collapse: collapse;
1.917     raeburn  6603:   width: 98%;
1.349     albertel 6604: }
1.795     www      6605: 
1.349     albertel 6606: table.LC_calendar_pickdate {
                   6607:   font-size: xx-small;
                   6608: }
1.795     www      6609: 
1.349     albertel 6610: table.LC_calendar tr td {
                   6611:   border: 1px solid #000000;
                   6612:   vertical-align: top;
1.917     raeburn  6613:   width: 14%;
1.349     albertel 6614: }
1.795     www      6615: 
1.349     albertel 6616: table.LC_calendar tr td.LC_calendar_day_empty {
                   6617:   background-color: $data_table_dark;
                   6618: }
1.795     www      6619: 
1.779     bisitz   6620: table.LC_calendar tr td.LC_calendar_day_current {
                   6621:   background-color: $data_table_highlight;
1.777     tempelho 6622: }
1.795     www      6623: 
1.938     bisitz   6624: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 6625:   background-color: $mail_new;
                   6626: }
1.795     www      6627: 
1.938     bisitz   6628: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 6629:   background-color: $mail_new_hover;
                   6630: }
1.795     www      6631: 
1.938     bisitz   6632: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 6633:   background-color: $mail_read;
                   6634: }
1.795     www      6635: 
1.938     bisitz   6636: /*
                   6637: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 6638:   background-color: $mail_read_hover;
                   6639: }
1.938     bisitz   6640: */
1.795     www      6641: 
1.938     bisitz   6642: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 6643:   background-color: $mail_replied;
                   6644: }
1.795     www      6645: 
1.938     bisitz   6646: /*
                   6647: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 6648:   background-color: $mail_replied_hover;
                   6649: }
1.938     bisitz   6650: */
1.795     www      6651: 
1.938     bisitz   6652: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 6653:   background-color: $mail_other;
                   6654: }
1.795     www      6655: 
1.938     bisitz   6656: /*
                   6657: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 6658:   background-color: $mail_other_hover;
                   6659: }
1.938     bisitz   6660: */
1.494     raeburn  6661: 
1.777     tempelho 6662: table.LC_data_table tr > td.LC_browser_file,
                   6663: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   6664:   background: #AAEE77;
1.389     albertel 6665: }
1.795     www      6666: 
1.777     tempelho 6667: table.LC_data_table tr > td.LC_browser_file_locked,
                   6668: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 6669:   background: #FFAA99;
1.387     albertel 6670: }
1.795     www      6671: 
1.777     tempelho 6672: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   6673:   background: #888888;
1.779     bisitz   6674: }
1.795     www      6675: 
1.777     tempelho 6676: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   6677: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   6678:   background: #F8F866;
1.777     tempelho 6679: }
1.795     www      6680: 
1.696     bisitz   6681: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   6682:   background: #E0E8FF;
1.387     albertel 6683: }
1.696     bisitz   6684: 
1.707     bisitz   6685: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   6686:   /* background: #77FF77; */
1.707     bisitz   6687: }
1.795     www      6688: 
1.707     bisitz   6689: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   6690:   border-right: 8px solid #FFFF77;
1.707     bisitz   6691: }
1.795     www      6692: 
1.707     bisitz   6693: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   6694:   border-right: 8px solid #FFAA77;
1.707     bisitz   6695: }
1.795     www      6696: 
1.707     bisitz   6697: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   6698:   border-right: 8px solid #FF7777;
1.707     bisitz   6699: }
1.795     www      6700: 
1.707     bisitz   6701: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   6702:   border-right: 8px solid #AAFF77;
1.707     bisitz   6703: }
1.795     www      6704: 
1.707     bisitz   6705: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   6706:   border-right: 8px solid #11CC55;
1.707     bisitz   6707: }
                   6708: 
1.388     albertel 6709: span.LC_current_location {
1.701     harmsja  6710:   font-size:larger;
1.388     albertel 6711:   background: $pgbg;
                   6712: }
1.387     albertel 6713: 
1.1029    www      6714: span.LC_current_nav_location {
                   6715:   font-weight:bold;
                   6716:   background: $sidebg;
                   6717: }
                   6718: 
1.395     albertel 6719: span.LC_parm_menu_item {
                   6720:   font-size: larger;
                   6721: }
1.795     www      6722: 
1.395     albertel 6723: span.LC_parm_scope_all {
                   6724:   color: red;
                   6725: }
1.795     www      6726: 
1.395     albertel 6727: span.LC_parm_scope_folder {
                   6728:   color: green;
                   6729: }
1.795     www      6730: 
1.395     albertel 6731: span.LC_parm_scope_resource {
                   6732:   color: orange;
                   6733: }
1.795     www      6734: 
1.395     albertel 6735: span.LC_parm_part {
                   6736:   color: blue;
                   6737: }
1.795     www      6738: 
1.911     bisitz   6739: span.LC_parm_folder,
                   6740: span.LC_parm_symb {
1.395     albertel 6741:   font-size: x-small;
                   6742:   font-family: $mono;
                   6743:   color: #AAAAAA;
                   6744: }
                   6745: 
1.977     bisitz   6746: ul.LC_parm_parmlist li {
                   6747:   display: inline-block;
                   6748:   padding: 0.3em 0.8em;
                   6749:   vertical-align: top;
                   6750:   width: 150px;
                   6751:   border-top:1px solid $lg_border_color;
                   6752: }
                   6753: 
1.795     www      6754: td.LC_parm_overview_level_menu,
                   6755: td.LC_parm_overview_map_menu,
                   6756: td.LC_parm_overview_parm_selectors,
                   6757: td.LC_parm_overview_restrictions  {
1.396     albertel 6758:   border: 1px solid black;
                   6759:   border-collapse: collapse;
                   6760: }
1.795     www      6761: 
1.396     albertel 6762: table.LC_parm_overview_restrictions td {
                   6763:   border-width: 1px 4px 1px 4px;
                   6764:   border-style: solid;
                   6765:   border-color: $pgbg;
                   6766:   text-align: center;
                   6767: }
1.795     www      6768: 
1.396     albertel 6769: table.LC_parm_overview_restrictions th {
                   6770:   background: $tabbg;
                   6771:   border-width: 1px 4px 1px 4px;
                   6772:   border-style: solid;
                   6773:   border-color: $pgbg;
                   6774: }
1.795     www      6775: 
1.398     albertel 6776: table#LC_helpmenu {
1.803     bisitz   6777:   border: none;
1.398     albertel 6778:   height: 55px;
1.803     bisitz   6779:   border-spacing: 0;
1.398     albertel 6780: }
                   6781: 
                   6782: table#LC_helpmenu fieldset legend {
                   6783:   font-size: larger;
                   6784: }
1.795     www      6785: 
1.397     albertel 6786: table#LC_helpmenu_links {
                   6787:   width: 100%;
                   6788:   border: 1px solid black;
                   6789:   background: $pgbg;
1.803     bisitz   6790:   padding: 0;
1.397     albertel 6791:   border-spacing: 1px;
                   6792: }
1.795     www      6793: 
1.397     albertel 6794: table#LC_helpmenu_links tr td {
                   6795:   padding: 1px;
                   6796:   background: $tabbg;
1.399     albertel 6797:   text-align: center;
                   6798:   font-weight: bold;
1.397     albertel 6799: }
1.396     albertel 6800: 
1.795     www      6801: table#LC_helpmenu_links a:link,
                   6802: table#LC_helpmenu_links a:visited,
1.397     albertel 6803: table#LC_helpmenu_links a:active {
                   6804:   text-decoration: none;
                   6805:   color: $font;
                   6806: }
1.795     www      6807: 
1.397     albertel 6808: table#LC_helpmenu_links a:hover {
                   6809:   text-decoration: underline;
                   6810:   color: $vlink;
                   6811: }
1.396     albertel 6812: 
1.417     albertel 6813: .LC_chrt_popup_exists {
                   6814:   border: 1px solid #339933;
                   6815:   margin: -1px;
                   6816: }
1.795     www      6817: 
1.417     albertel 6818: .LC_chrt_popup_up {
                   6819:   border: 1px solid yellow;
                   6820:   margin: -1px;
                   6821: }
1.795     www      6822: 
1.417     albertel 6823: .LC_chrt_popup {
                   6824:   border: 1px solid #8888FF;
                   6825:   background: #CCCCFF;
                   6826: }
1.795     www      6827: 
1.421     albertel 6828: table.LC_pick_box {
                   6829:   border-collapse: separate;
                   6830:   background: white;
                   6831:   border: 1px solid black;
                   6832:   border-spacing: 1px;
                   6833: }
1.795     www      6834: 
1.421     albertel 6835: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   6836:   background: $sidebg;
1.421     albertel 6837:   font-weight: bold;
1.900     bisitz   6838:   text-align: left;
1.740     bisitz   6839:   vertical-align: top;
1.421     albertel 6840:   width: 184px;
                   6841:   padding: 8px;
                   6842: }
1.795     www      6843: 
1.579     raeburn  6844: table.LC_pick_box td.LC_pick_box_value {
                   6845:   text-align: left;
                   6846:   padding: 8px;
                   6847: }
1.795     www      6848: 
1.579     raeburn  6849: table.LC_pick_box td.LC_pick_box_select {
                   6850:   text-align: left;
                   6851:   padding: 8px;
                   6852: }
1.795     www      6853: 
1.424     albertel 6854: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   6855:   padding: 0;
1.421     albertel 6856:   height: 1px;
                   6857:   background: black;
                   6858: }
1.795     www      6859: 
1.421     albertel 6860: table.LC_pick_box td.LC_pick_box_submit {
                   6861:   text-align: right;
                   6862: }
1.795     www      6863: 
1.579     raeburn  6864: table.LC_pick_box td.LC_evenrow_value {
                   6865:   text-align: left;
                   6866:   padding: 8px;
                   6867:   background-color: $data_table_light;
                   6868: }
1.795     www      6869: 
1.579     raeburn  6870: table.LC_pick_box td.LC_oddrow_value {
                   6871:   text-align: left;
                   6872:   padding: 8px;
                   6873:   background-color: $data_table_light;
                   6874: }
1.795     www      6875: 
1.579     raeburn  6876: span.LC_helpform_receipt_cat {
                   6877:   font-weight: bold;
                   6878: }
1.795     www      6879: 
1.424     albertel 6880: table.LC_group_priv_box {
                   6881:   background: white;
                   6882:   border: 1px solid black;
                   6883:   border-spacing: 1px;
                   6884: }
1.795     www      6885: 
1.424     albertel 6886: table.LC_group_priv_box td.LC_pick_box_title {
                   6887:   background: $tabbg;
                   6888:   font-weight: bold;
                   6889:   text-align: right;
                   6890:   width: 184px;
                   6891: }
1.795     www      6892: 
1.424     albertel 6893: table.LC_group_priv_box td.LC_groups_fixed {
                   6894:   background: $data_table_light;
                   6895:   text-align: center;
                   6896: }
1.795     www      6897: 
1.424     albertel 6898: table.LC_group_priv_box td.LC_groups_optional {
                   6899:   background: $data_table_dark;
                   6900:   text-align: center;
                   6901: }
1.795     www      6902: 
1.424     albertel 6903: table.LC_group_priv_box td.LC_groups_functionality {
                   6904:   background: $data_table_darker;
                   6905:   text-align: center;
                   6906:   font-weight: bold;
                   6907: }
1.795     www      6908: 
1.424     albertel 6909: table.LC_group_priv td {
                   6910:   text-align: left;
1.803     bisitz   6911:   padding: 0;
1.424     albertel 6912: }
                   6913: 
                   6914: .LC_navbuttons {
                   6915:   margin: 2ex 0ex 2ex 0ex;
                   6916: }
1.795     www      6917: 
1.423     albertel 6918: .LC_topic_bar {
                   6919:   font-weight: bold;
                   6920:   background: $tabbg;
1.918     wenzelju 6921:   margin: 1em 0em 1em 2em;
1.805     bisitz   6922:   padding: 3px;
1.918     wenzelju 6923:   font-size: 1.2em;
1.423     albertel 6924: }
1.795     www      6925: 
1.423     albertel 6926: .LC_topic_bar span {
1.918     wenzelju 6927:   left: 0.5em;
                   6928:   position: absolute;
1.423     albertel 6929:   vertical-align: middle;
1.918     wenzelju 6930:   font-size: 1.2em;
1.423     albertel 6931: }
1.795     www      6932: 
1.423     albertel 6933: table.LC_course_group_status {
                   6934:   margin: 20px;
                   6935: }
1.795     www      6936: 
1.423     albertel 6937: table.LC_status_selector td {
                   6938:   vertical-align: top;
                   6939:   text-align: center;
1.424     albertel 6940:   padding: 4px;
                   6941: }
1.795     www      6942: 
1.599     albertel 6943: div.LC_feedback_link {
1.616     albertel 6944:   clear: both;
1.829     kalberla 6945:   background: $sidebg;
1.779     bisitz   6946:   width: 100%;
1.829     kalberla 6947:   padding-bottom: 10px;
                   6948:   border: 1px $tabbg solid;
1.833     kalberla 6949:   height: 22px;
                   6950:   line-height: 22px;
                   6951:   padding-top: 5px;
                   6952: }
                   6953: 
                   6954: div.LC_feedback_link img {
                   6955:   height: 22px;
1.867     kalberla 6956:   vertical-align:middle;
1.829     kalberla 6957: }
                   6958: 
1.911     bisitz   6959: div.LC_feedback_link a {
1.829     kalberla 6960:   text-decoration: none;
1.489     raeburn  6961: }
1.795     www      6962: 
1.867     kalberla 6963: div.LC_comblock {
1.911     bisitz   6964:   display:inline;
1.867     kalberla 6965:   color:$font;
                   6966:   font-size:90%;
                   6967: }
                   6968: 
                   6969: div.LC_feedback_link div.LC_comblock {
                   6970:   padding-left:5px;
                   6971: }
                   6972: 
                   6973: div.LC_feedback_link div.LC_comblock a {
                   6974:   color:$font;
                   6975: }
                   6976: 
1.489     raeburn  6977: span.LC_feedback_link {
1.858     bisitz   6978:   /* background: $feedback_link_bg; */
1.599     albertel 6979:   font-size: larger;
                   6980: }
1.795     www      6981: 
1.599     albertel 6982: span.LC_message_link {
1.858     bisitz   6983:   /* background: $feedback_link_bg; */
1.599     albertel 6984:   font-size: larger;
                   6985:   position: absolute;
                   6986:   right: 1em;
1.489     raeburn  6987: }
1.421     albertel 6988: 
1.515     albertel 6989: table.LC_prior_tries {
1.524     albertel 6990:   border: 1px solid #000000;
                   6991:   border-collapse: separate;
                   6992:   border-spacing: 1px;
1.515     albertel 6993: }
1.523     albertel 6994: 
1.515     albertel 6995: table.LC_prior_tries td {
1.524     albertel 6996:   padding: 2px;
1.515     albertel 6997: }
1.523     albertel 6998: 
                   6999: .LC_answer_correct {
1.795     www      7000:   background: lightgreen;
                   7001:   color: darkgreen;
                   7002:   padding: 6px;
1.523     albertel 7003: }
1.795     www      7004: 
1.523     albertel 7005: .LC_answer_charged_try {
1.797     www      7006:   background: #FFAAAA;
1.795     www      7007:   color: darkred;
                   7008:   padding: 6px;
1.523     albertel 7009: }
1.795     www      7010: 
1.779     bisitz   7011: .LC_answer_not_charged_try,
1.523     albertel 7012: .LC_answer_no_grade,
                   7013: .LC_answer_late {
1.795     www      7014:   background: lightyellow;
1.523     albertel 7015:   color: black;
1.795     www      7016:   padding: 6px;
1.523     albertel 7017: }
1.795     www      7018: 
1.523     albertel 7019: .LC_answer_previous {
1.795     www      7020:   background: lightblue;
                   7021:   color: darkblue;
                   7022:   padding: 6px;
1.523     albertel 7023: }
1.795     www      7024: 
1.779     bisitz   7025: .LC_answer_no_message {
1.777     tempelho 7026:   background: #FFFFFF;
                   7027:   color: black;
1.795     www      7028:   padding: 6px;
1.779     bisitz   7029: }
1.795     www      7030: 
1.1075.2.140  raeburn  7031: .LC_answer_unknown,
                   7032: .LC_answer_warning {
1.779     bisitz   7033:   background: orange;
                   7034:   color: black;
1.795     www      7035:   padding: 6px;
1.777     tempelho 7036: }
1.795     www      7037: 
1.529     albertel 7038: span.LC_prior_numerical,
                   7039: span.LC_prior_string,
                   7040: span.LC_prior_custom,
                   7041: span.LC_prior_reaction,
                   7042: span.LC_prior_math {
1.925     bisitz   7043:   font-family: $mono;
1.523     albertel 7044:   white-space: pre;
                   7045: }
                   7046: 
1.525     albertel 7047: span.LC_prior_string {
1.925     bisitz   7048:   font-family: $mono;
1.525     albertel 7049:   white-space: pre;
                   7050: }
                   7051: 
1.523     albertel 7052: table.LC_prior_option {
                   7053:   width: 100%;
                   7054:   border-collapse: collapse;
                   7055: }
1.795     www      7056: 
1.911     bisitz   7057: table.LC_prior_rank,
1.795     www      7058: table.LC_prior_match {
1.528     albertel 7059:   border-collapse: collapse;
                   7060: }
1.795     www      7061: 
1.528     albertel 7062: table.LC_prior_option tr td,
                   7063: table.LC_prior_rank tr td,
                   7064: table.LC_prior_match tr td {
1.524     albertel 7065:   border: 1px solid #000000;
1.515     albertel 7066: }
                   7067: 
1.855     bisitz   7068: .LC_nobreak {
1.544     albertel 7069:   white-space: nowrap;
1.519     raeburn  7070: }
                   7071: 
1.576     raeburn  7072: span.LC_cusr_emph {
                   7073:   font-style: italic;
                   7074: }
                   7075: 
1.633     raeburn  7076: span.LC_cusr_subheading {
                   7077:   font-weight: normal;
                   7078:   font-size: 85%;
                   7079: }
                   7080: 
1.861     bisitz   7081: div.LC_docs_entry_move {
1.859     bisitz   7082:   border: 1px solid #BBBBBB;
1.545     albertel 7083:   background: #DDDDDD;
1.861     bisitz   7084:   width: 22px;
1.859     bisitz   7085:   padding: 1px;
                   7086:   margin: 0;
1.545     albertel 7087: }
                   7088: 
1.861     bisitz   7089: table.LC_data_table tr > td.LC_docs_entry_commands,
                   7090: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 7091:   font-size: x-small;
                   7092: }
1.795     www      7093: 
1.861     bisitz   7094: .LC_docs_entry_parameter {
                   7095:   white-space: nowrap;
                   7096: }
                   7097: 
1.544     albertel 7098: .LC_docs_copy {
1.545     albertel 7099:   color: #000099;
1.544     albertel 7100: }
1.795     www      7101: 
1.544     albertel 7102: .LC_docs_cut {
1.545     albertel 7103:   color: #550044;
1.544     albertel 7104: }
1.795     www      7105: 
1.544     albertel 7106: .LC_docs_rename {
1.545     albertel 7107:   color: #009900;
1.544     albertel 7108: }
1.795     www      7109: 
1.544     albertel 7110: .LC_docs_remove {
1.545     albertel 7111:   color: #990000;
                   7112: }
                   7113: 
1.1075.2.134  raeburn  7114: .LC_domprefs_email,
1.547     albertel 7115: .LC_docs_reinit_warn,
                   7116: .LC_docs_ext_edit {
                   7117:   font-size: x-small;
                   7118: }
                   7119: 
1.545     albertel 7120: table.LC_docs_adddocs td,
                   7121: table.LC_docs_adddocs th {
                   7122:   border: 1px solid #BBBBBB;
                   7123:   padding: 4px;
                   7124:   background: #DDDDDD;
1.543     albertel 7125: }
                   7126: 
1.584     albertel 7127: table.LC_sty_begin {
                   7128:   background: #BBFFBB;
                   7129: }
1.795     www      7130: 
1.584     albertel 7131: table.LC_sty_end {
                   7132:   background: #FFBBBB;
                   7133: }
                   7134: 
1.589     raeburn  7135: table.LC_double_column {
1.803     bisitz   7136:   border-width: 0;
1.589     raeburn  7137:   border-collapse: collapse;
                   7138:   width: 100%;
                   7139:   padding: 2px;
                   7140: }
                   7141: 
                   7142: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  7143:   top: 2px;
1.589     raeburn  7144:   left: 2px;
                   7145:   width: 47%;
                   7146:   vertical-align: top;
                   7147: }
                   7148: 
                   7149: table.LC_double_column tr td.LC_right_col {
                   7150:   top: 2px;
1.779     bisitz   7151:   right: 2px;
1.589     raeburn  7152:   width: 47%;
                   7153:   vertical-align: top;
                   7154: }
                   7155: 
1.591     raeburn  7156: div.LC_left_float {
                   7157:   float: left;
                   7158:   padding-right: 5%;
1.597     albertel 7159:   padding-bottom: 4px;
1.591     raeburn  7160: }
                   7161: 
                   7162: div.LC_clear_float_header {
1.597     albertel 7163:   padding-bottom: 2px;
1.591     raeburn  7164: }
                   7165: 
                   7166: div.LC_clear_float_footer {
1.597     albertel 7167:   padding-top: 10px;
1.591     raeburn  7168:   clear: both;
                   7169: }
                   7170: 
1.597     albertel 7171: div.LC_grade_show_user {
1.941     bisitz   7172: /*  border-left: 5px solid $sidebg; */
                   7173:   border-top: 5px solid #000000;
                   7174:   margin: 50px 0 0 0;
1.936     bisitz   7175:   padding: 15px 0 5px 10px;
1.597     albertel 7176: }
1.795     www      7177: 
1.936     bisitz   7178: div.LC_grade_show_user_odd_row {
1.941     bisitz   7179: /*  border-left: 5px solid #000000; */
                   7180: }
                   7181: 
                   7182: div.LC_grade_show_user div.LC_Box {
                   7183:   margin-right: 50px;
1.597     albertel 7184: }
                   7185: 
                   7186: div.LC_grade_submissions,
                   7187: div.LC_grade_message_center,
1.936     bisitz   7188: div.LC_grade_info_links {
1.597     albertel 7189:   margin: 5px;
                   7190:   width: 99%;
                   7191:   background: #FFFFFF;
                   7192: }
1.795     www      7193: 
1.597     albertel 7194: div.LC_grade_submissions_header,
1.936     bisitz   7195: div.LC_grade_message_center_header {
1.705     tempelho 7196:   font-weight: bold;
                   7197:   font-size: large;
1.597     albertel 7198: }
1.795     www      7199: 
1.597     albertel 7200: div.LC_grade_submissions_body,
1.936     bisitz   7201: div.LC_grade_message_center_body {
1.597     albertel 7202:   border: 1px solid black;
                   7203:   width: 99%;
                   7204:   background: #FFFFFF;
                   7205: }
1.795     www      7206: 
1.613     albertel 7207: table.LC_scantron_action {
                   7208:   width: 100%;
                   7209: }
1.795     www      7210: 
1.613     albertel 7211: table.LC_scantron_action tr th {
1.698     harmsja  7212:   font-weight:bold;
                   7213:   font-style:normal;
1.613     albertel 7214: }
1.795     www      7215: 
1.779     bisitz   7216: .LC_edit_problem_header,
1.614     albertel 7217: div.LC_edit_problem_footer {
1.705     tempelho 7218:   font-weight: normal;
                   7219:   font-size:  medium;
1.602     albertel 7220:   margin: 2px;
1.1060    bisitz   7221:   background-color: $sidebg;
1.600     albertel 7222: }
1.795     www      7223: 
1.600     albertel 7224: div.LC_edit_problem_header,
1.602     albertel 7225: div.LC_edit_problem_header div,
1.614     albertel 7226: div.LC_edit_problem_footer,
                   7227: div.LC_edit_problem_footer div,
1.602     albertel 7228: div.LC_edit_problem_editxml_header,
                   7229: div.LC_edit_problem_editxml_header div {
1.1075.2.112  raeburn  7230:   z-index: 100;
1.600     albertel 7231: }
1.795     www      7232: 
1.600     albertel 7233: div.LC_edit_problem_header_title {
1.705     tempelho 7234:   font-weight: bold;
                   7235:   font-size: larger;
1.602     albertel 7236:   background: $tabbg;
                   7237:   padding: 3px;
1.1060    bisitz   7238:   margin: 0 0 5px 0;
1.602     albertel 7239: }
1.795     www      7240: 
1.602     albertel 7241: table.LC_edit_problem_header_title {
                   7242:   width: 100%;
1.600     albertel 7243:   background: $tabbg;
1.602     albertel 7244: }
                   7245: 
1.1075.2.112  raeburn  7246: div.LC_edit_actionbar {
                   7247:     background-color: $sidebg;
                   7248:     margin: 0;
                   7249:     padding: 0;
                   7250:     line-height: 200%;
1.602     albertel 7251: }
1.795     www      7252: 
1.1075.2.112  raeburn  7253: div.LC_edit_actionbar div{
                   7254:     padding: 0;
                   7255:     margin: 0;
                   7256:     display: inline-block;
1.600     albertel 7257: }
1.795     www      7258: 
1.1075.2.34  raeburn  7259: .LC_edit_opt {
                   7260:   padding-left: 1em;
                   7261:   white-space: nowrap;
                   7262: }
                   7263: 
1.1075.2.57  raeburn  7264: .LC_edit_problem_latexhelper{
                   7265:     text-align: right;
                   7266: }
                   7267: 
                   7268: #LC_edit_problem_colorful div{
                   7269:     margin-left: 40px;
                   7270: }
                   7271: 
1.1075.2.112  raeburn  7272: #LC_edit_problem_codemirror div{
                   7273:     margin-left: 0px;
                   7274: }
                   7275: 
1.911     bisitz   7276: img.stift {
1.803     bisitz   7277:   border-width: 0;
                   7278:   vertical-align: middle;
1.677     riegler  7279: }
1.680     riegler  7280: 
1.923     bisitz   7281: table td.LC_mainmenu_col_fieldset {
1.680     riegler  7282:   vertical-align: top;
1.777     tempelho 7283: }
1.795     www      7284: 
1.716     raeburn  7285: div.LC_createcourse {
1.911     bisitz   7286:   margin: 10px 10px 10px 10px;
1.716     raeburn  7287: }
                   7288: 
1.917     raeburn  7289: .LC_dccid {
1.1075.2.38  raeburn  7290:   float: right;
1.917     raeburn  7291:   margin: 0.2em 0 0 0;
                   7292:   padding: 0;
                   7293:   font-size: 90%;
                   7294:   display:none;
                   7295: }
                   7296: 
1.897     wenzelju 7297: ol.LC_primary_menu a:hover,
1.721     harmsja  7298: ol#LC_MenuBreadcrumbs a:hover,
                   7299: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 7300: ul#LC_secondary_menu a:hover,
1.721     harmsja  7301: .LC_FormSectionClearButton input:hover
1.795     www      7302: ul.LC_TabContent   li:hover a {
1.952     onken    7303:   color:$button_hover;
1.911     bisitz   7304:   text-decoration:none;
1.693     droeschl 7305: }
                   7306: 
1.779     bisitz   7307: h1 {
1.911     bisitz   7308:   padding: 0;
                   7309:   line-height:130%;
1.693     droeschl 7310: }
1.698     harmsja  7311: 
1.911     bisitz   7312: h2,
                   7313: h3,
                   7314: h4,
                   7315: h5,
                   7316: h6 {
                   7317:   margin: 5px 0 5px 0;
                   7318:   padding: 0;
                   7319:   line-height:130%;
1.693     droeschl 7320: }
1.795     www      7321: 
                   7322: .LC_hcell {
1.911     bisitz   7323:   padding:3px 15px 3px 15px;
                   7324:   margin: 0;
                   7325:   background-color:$tabbg;
                   7326:   color:$fontmenu;
                   7327:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 7328: }
1.795     www      7329: 
1.840     bisitz   7330: .LC_Box > .LC_hcell {
1.911     bisitz   7331:   margin: 0 -10px 10px -10px;
1.835     bisitz   7332: }
                   7333: 
1.721     harmsja  7334: .LC_noBorder {
1.911     bisitz   7335:   border: 0;
1.698     harmsja  7336: }
1.693     droeschl 7337: 
1.721     harmsja  7338: .LC_FormSectionClearButton input {
1.911     bisitz   7339:   background-color:transparent;
                   7340:   border: none;
                   7341:   cursor:pointer;
                   7342:   text-decoration:underline;
1.693     droeschl 7343: }
1.763     bisitz   7344: 
                   7345: .LC_help_open_topic {
1.911     bisitz   7346:   color: #FFFFFF;
                   7347:   background-color: #EEEEFF;
                   7348:   margin: 1px;
                   7349:   padding: 4px;
                   7350:   border: 1px solid #000033;
                   7351:   white-space: nowrap;
                   7352:   /* vertical-align: middle; */
1.759     neumanie 7353: }
1.693     droeschl 7354: 
1.911     bisitz   7355: dl,
                   7356: ul,
                   7357: div,
                   7358: fieldset {
                   7359:   margin: 10px 10px 10px 0;
                   7360:   /* overflow: hidden; */
1.693     droeschl 7361: }
1.795     www      7362: 
1.1075.2.90  raeburn  7363: article.geogebraweb div {
                   7364:     margin: 0;
                   7365: }
                   7366: 
1.838     bisitz   7367: fieldset > legend {
1.911     bisitz   7368:   font-weight: bold;
                   7369:   padding: 0 5px 0 5px;
1.838     bisitz   7370: }
                   7371: 
1.813     bisitz   7372: #LC_nav_bar {
1.911     bisitz   7373:   float: left;
1.995     raeburn  7374:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   7375:   margin: 0 0 2px 0;
1.807     droeschl 7376: }
                   7377: 
1.916     droeschl 7378: #LC_realm {
                   7379:   margin: 0.2em 0 0 0;
                   7380:   padding: 0;
                   7381:   font-weight: bold;
                   7382:   text-align: center;
1.995     raeburn  7383:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 7384: }
                   7385: 
1.911     bisitz   7386: #LC_nav_bar em {
                   7387:   font-weight: bold;
                   7388:   font-style: normal;
1.807     droeschl 7389: }
                   7390: 
1.897     wenzelju 7391: ol.LC_primary_menu {
1.934     droeschl 7392:   margin: 0;
1.1075.2.2  raeburn  7393:   padding: 0;
1.807     droeschl 7394: }
                   7395: 
1.852     droeschl 7396: ol#LC_PathBreadcrumbs {
1.911     bisitz   7397:   margin: 0;
1.693     droeschl 7398: }
                   7399: 
1.897     wenzelju 7400: ol.LC_primary_menu li {
1.1075.2.2  raeburn  7401:   color: RGB(80, 80, 80);
                   7402:   vertical-align: middle;
                   7403:   text-align: left;
                   7404:   list-style: none;
1.1075.2.112  raeburn  7405:   position: relative;
1.1075.2.2  raeburn  7406:   float: left;
1.1075.2.112  raeburn  7407:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   7408:   line-height: 1.5em;
1.1075.2.2  raeburn  7409: }
                   7410: 
1.1075.2.113  raeburn  7411: ol.LC_primary_menu li a, 
1.1075.2.112  raeburn  7412: ol.LC_primary_menu li p {
1.1075.2.2  raeburn  7413:   display: block;
                   7414:   margin: 0;
                   7415:   padding: 0 5px 0 10px;
                   7416:   text-decoration: none;
                   7417: }
                   7418: 
1.1075.2.112  raeburn  7419: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   7420:   display: inline-block;
                   7421:   width: 95%;
                   7422:   text-align: left;
                   7423: }
                   7424: 
                   7425: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   7426:   display: inline-block;
                   7427:   width: 5%;
                   7428:   float: right;
                   7429:   text-align: right;
                   7430:   font-size: 70%;
                   7431: }
                   7432: 
                   7433: ol.LC_primary_menu ul {
1.1075.2.2  raeburn  7434:   display: none;
1.1075.2.112  raeburn  7435:   width: 15em;
1.1075.2.2  raeburn  7436:   background-color: $data_table_light;
1.1075.2.112  raeburn  7437:   position: absolute;
                   7438:   top: 100%;
                   7439: }
                   7440: 
                   7441: ol.LC_primary_menu ul ul {
                   7442:   left: 100%;
                   7443:   top: 0;
1.1075.2.2  raeburn  7444: }
                   7445: 
1.1075.2.112  raeburn  7446: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1075.2.2  raeburn  7447:   display: block;
                   7448:   position: absolute;
                   7449:   margin: 0;
                   7450:   padding: 0;
1.1075.2.5  raeburn  7451:   z-index: 2;
1.1075.2.2  raeburn  7452: }
                   7453: 
                   7454: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1075.2.112  raeburn  7455: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1075.2.2  raeburn  7456:   font-size: 90%;
1.911     bisitz   7457:   vertical-align: top;
1.1075.2.2  raeburn  7458:   float: none;
1.1075.2.5  raeburn  7459:   border-left: 1px solid black;
                   7460:   border-right: 1px solid black;
1.1075.2.112  raeburn  7461: /* A dark bottom border to visualize different menu options;
                   7462: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   7463:   border-bottom: 1px solid $data_table_dark;
1.1075.2.2  raeburn  7464: }
                   7465: 
1.1075.2.112  raeburn  7466: ol.LC_primary_menu li li p:hover {
                   7467:   color:$button_hover;
                   7468:   text-decoration:none;
                   7469:   background-color:$data_table_dark;
1.1075.2.2  raeburn  7470: }
                   7471: 
                   7472: ol.LC_primary_menu li li a:hover {
                   7473:    color:$button_hover;
                   7474:    background-color:$data_table_dark;
1.693     droeschl 7475: }
                   7476: 
1.1075.2.112  raeburn  7477: /* Font-size equal to the size of the predecessors*/
                   7478: ol.LC_primary_menu li:hover li li {
                   7479:   font-size: 100%;
                   7480: }
                   7481: 
1.897     wenzelju 7482: ol.LC_primary_menu li img {
1.911     bisitz   7483:   vertical-align: bottom;
1.934     droeschl 7484:   height: 1.1em;
1.1075.2.3  raeburn  7485:   margin: 0.2em 0 0 0;
1.693     droeschl 7486: }
                   7487: 
1.897     wenzelju 7488: ol.LC_primary_menu a {
1.911     bisitz   7489:   color: RGB(80, 80, 80);
                   7490:   text-decoration: none;
1.693     droeschl 7491: }
1.795     www      7492: 
1.949     droeschl 7493: ol.LC_primary_menu a.LC_new_message {
                   7494:   font-weight:bold;
                   7495:   color: darkred;
                   7496: }
                   7497: 
1.975     raeburn  7498: ol.LC_docs_parameters {
                   7499:   margin-left: 0;
                   7500:   padding: 0;
                   7501:   list-style: none;
                   7502: }
                   7503: 
                   7504: ol.LC_docs_parameters li {
                   7505:   margin: 0;
                   7506:   padding-right: 20px;
                   7507:   display: inline;
                   7508: }
                   7509: 
1.976     raeburn  7510: ol.LC_docs_parameters li:before {
                   7511:   content: "\\002022 \\0020";
                   7512: }
                   7513: 
                   7514: li.LC_docs_parameters_title {
                   7515:   font-weight: bold;
                   7516: }
                   7517: 
                   7518: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   7519:   content: "";
                   7520: }
                   7521: 
1.897     wenzelju 7522: ul#LC_secondary_menu {
1.1075.2.23  raeburn  7523:   clear: right;
1.911     bisitz   7524:   color: $fontmenu;
                   7525:   background: $tabbg;
                   7526:   list-style: none;
                   7527:   padding: 0;
                   7528:   margin: 0;
                   7529:   width: 100%;
1.995     raeburn  7530:   text-align: left;
1.1075.2.4  raeburn  7531:   float: left;
1.808     droeschl 7532: }
                   7533: 
1.897     wenzelju 7534: ul#LC_secondary_menu li {
1.911     bisitz   7535:   font-weight: bold;
                   7536:   line-height: 1.8em;
                   7537:   border-right: 1px solid black;
1.1075.2.4  raeburn  7538:   float: left;
                   7539: }
                   7540: 
                   7541: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   7542:   background-color: $data_table_light;
                   7543: }
                   7544: 
                   7545: ul#LC_secondary_menu li a {
                   7546:   padding: 0 0.8em;
                   7547: }
                   7548: 
                   7549: ul#LC_secondary_menu li ul {
                   7550:   display: none;
                   7551: }
                   7552: 
                   7553: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   7554:   display: block;
                   7555:   position: absolute;
                   7556:   margin: 0;
                   7557:   padding: 0;
                   7558:   list-style:none;
                   7559:   float: none;
                   7560:   background-color: $data_table_light;
1.1075.2.5  raeburn  7561:   z-index: 2;
1.1075.2.10  raeburn  7562:   margin-left: -1px;
1.1075.2.4  raeburn  7563: }
                   7564: 
                   7565: ul#LC_secondary_menu li ul li {
                   7566:   font-size: 90%;
                   7567:   vertical-align: top;
                   7568:   border-left: 1px solid black;
                   7569:   border-right: 1px solid black;
1.1075.2.33  raeburn  7570:   background-color: $data_table_light;
1.1075.2.4  raeburn  7571:   list-style:none;
                   7572:   float: none;
                   7573: }
                   7574: 
                   7575: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   7576:   background-color: $data_table_dark;
1.807     droeschl 7577: }
                   7578: 
1.847     tempelho 7579: ul.LC_TabContent {
1.911     bisitz   7580:   display:block;
                   7581:   background: $sidebg;
                   7582:   border-bottom: solid 1px $lg_border_color;
                   7583:   list-style:none;
1.1020    raeburn  7584:   margin: -1px -10px 0 -10px;
1.911     bisitz   7585:   padding: 0;
1.693     droeschl 7586: }
                   7587: 
1.795     www      7588: ul.LC_TabContent li,
                   7589: ul.LC_TabContentBigger li {
1.911     bisitz   7590:   float:left;
1.741     harmsja  7591: }
1.795     www      7592: 
1.897     wenzelju 7593: ul#LC_secondary_menu li a {
1.911     bisitz   7594:   color: $fontmenu;
                   7595:   text-decoration: none;
1.693     droeschl 7596: }
1.795     www      7597: 
1.721     harmsja  7598: ul.LC_TabContent {
1.952     onken    7599:   min-height:20px;
1.721     harmsja  7600: }
1.795     www      7601: 
                   7602: ul.LC_TabContent li {
1.911     bisitz   7603:   vertical-align:middle;
1.959     onken    7604:   padding: 0 16px 0 10px;
1.911     bisitz   7605:   background-color:$tabbg;
                   7606:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  7607:   border-left: solid 1px $font;
1.721     harmsja  7608: }
1.795     www      7609: 
1.847     tempelho 7610: ul.LC_TabContent .right {
1.911     bisitz   7611:   float:right;
1.847     tempelho 7612: }
                   7613: 
1.911     bisitz   7614: ul.LC_TabContent li a,
                   7615: ul.LC_TabContent li {
                   7616:   color:rgb(47,47,47);
                   7617:   text-decoration:none;
                   7618:   font-size:95%;
                   7619:   font-weight:bold;
1.952     onken    7620:   min-height:20px;
                   7621: }
                   7622: 
1.959     onken    7623: ul.LC_TabContent li a:hover,
                   7624: ul.LC_TabContent li a:focus {
1.952     onken    7625:   color: $button_hover;
1.959     onken    7626:   background:none;
                   7627:   outline:none;
1.952     onken    7628: }
                   7629: 
                   7630: ul.LC_TabContent li:hover {
                   7631:   color: $button_hover;
                   7632:   cursor:pointer;
1.721     harmsja  7633: }
1.795     www      7634: 
1.911     bisitz   7635: ul.LC_TabContent li.active {
1.952     onken    7636:   color: $font;
1.911     bisitz   7637:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    7638:   border-bottom:solid 1px #FFFFFF;
                   7639:   cursor: default;
1.744     ehlerst  7640: }
1.795     www      7641: 
1.959     onken    7642: ul.LC_TabContent li.active a {
                   7643:   color:$font;
                   7644:   background:#FFFFFF;
                   7645:   outline: none;
                   7646: }
1.1047    raeburn  7647: 
                   7648: ul.LC_TabContent li.goback {
                   7649:   float: left;
                   7650:   border-left: none;
                   7651: }
                   7652: 
1.870     tempelho 7653: #maincoursedoc {
1.911     bisitz   7654:   clear:both;
1.870     tempelho 7655: }
                   7656: 
                   7657: ul.LC_TabContentBigger {
1.911     bisitz   7658:   display:block;
                   7659:   list-style:none;
                   7660:   padding: 0;
1.870     tempelho 7661: }
                   7662: 
1.795     www      7663: ul.LC_TabContentBigger li {
1.911     bisitz   7664:   vertical-align:bottom;
                   7665:   height: 30px;
                   7666:   font-size:110%;
                   7667:   font-weight:bold;
                   7668:   color: #737373;
1.841     tempelho 7669: }
                   7670: 
1.957     onken    7671: ul.LC_TabContentBigger li.active {
                   7672:   position: relative;
                   7673:   top: 1px;
                   7674: }
                   7675: 
1.870     tempelho 7676: ul.LC_TabContentBigger li a {
1.911     bisitz   7677:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   7678:   height: 30px;
                   7679:   line-height: 30px;
                   7680:   text-align: center;
                   7681:   display: block;
                   7682:   text-decoration: none;
1.958     onken    7683:   outline: none;  
1.741     harmsja  7684: }
1.795     www      7685: 
1.870     tempelho 7686: ul.LC_TabContentBigger li.active a {
1.911     bisitz   7687:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   7688:   color:$font;
1.744     ehlerst  7689: }
1.795     www      7690: 
1.870     tempelho 7691: ul.LC_TabContentBigger li b {
1.911     bisitz   7692:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   7693:   display: block;
                   7694:   float: left;
                   7695:   padding: 0 30px;
1.957     onken    7696:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 7697: }
                   7698: 
1.956     onken    7699: ul.LC_TabContentBigger li:hover b {
                   7700:   color:$button_hover;
                   7701: }
                   7702: 
1.870     tempelho 7703: ul.LC_TabContentBigger li.active b {
1.911     bisitz   7704:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   7705:   color:$font;
1.957     onken    7706:   border: 0;
1.741     harmsja  7707: }
1.693     droeschl 7708: 
1.870     tempelho 7709: 
1.862     bisitz   7710: ul.LC_CourseBreadcrumbs {
                   7711:   background: $sidebg;
1.1020    raeburn  7712:   height: 2em;
1.862     bisitz   7713:   padding-left: 10px;
1.1020    raeburn  7714:   margin: 0;
1.862     bisitz   7715:   list-style-position: inside;
                   7716: }
                   7717: 
1.911     bisitz   7718: ol#LC_MenuBreadcrumbs,
1.862     bisitz   7719: ol#LC_PathBreadcrumbs {
1.911     bisitz   7720:   padding-left: 10px;
                   7721:   margin: 0;
1.933     droeschl 7722:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 7723: }
                   7724: 
1.911     bisitz   7725: ol#LC_MenuBreadcrumbs li,
                   7726: ol#LC_PathBreadcrumbs li,
1.862     bisitz   7727: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   7728:   display: inline;
1.933     droeschl 7729:   white-space: normal;  
1.693     droeschl 7730: }
                   7731: 
1.823     bisitz   7732: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   7733: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   7734:   text-decoration: none;
                   7735:   font-size:90%;
1.693     droeschl 7736: }
1.795     www      7737: 
1.969     droeschl 7738: ol#LC_MenuBreadcrumbs h1 {
                   7739:   display: inline;
                   7740:   font-size: 90%;
                   7741:   line-height: 2.5em;
                   7742:   margin: 0;
                   7743:   padding: 0;
                   7744: }
                   7745: 
1.795     www      7746: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   7747:   text-decoration:none;
                   7748:   font-size:100%;
                   7749:   font-weight:bold;
1.693     droeschl 7750: }
1.795     www      7751: 
1.840     bisitz   7752: .LC_Box {
1.911     bisitz   7753:   border: solid 1px $lg_border_color;
                   7754:   padding: 0 10px 10px 10px;
1.746     neumanie 7755: }
1.795     www      7756: 
1.1020    raeburn  7757: .LC_DocsBox {
                   7758:   border: solid 1px $lg_border_color;
                   7759:   padding: 0 0 10px 10px;
                   7760: }
                   7761: 
1.795     www      7762: .LC_AboutMe_Image {
1.911     bisitz   7763:   float:left;
                   7764:   margin-right:10px;
1.747     neumanie 7765: }
1.795     www      7766: 
                   7767: .LC_Clear_AboutMe_Image {
1.911     bisitz   7768:   clear:left;
1.747     neumanie 7769: }
1.795     www      7770: 
1.721     harmsja  7771: dl.LC_ListStyleClean dt {
1.911     bisitz   7772:   padding-right: 5px;
                   7773:   display: table-header-group;
1.693     droeschl 7774: }
                   7775: 
1.721     harmsja  7776: dl.LC_ListStyleClean dd {
1.911     bisitz   7777:   display: table-row;
1.693     droeschl 7778: }
                   7779: 
1.721     harmsja  7780: .LC_ListStyleClean,
                   7781: .LC_ListStyleSimple,
                   7782: .LC_ListStyleNormal,
1.795     www      7783: .LC_ListStyleSpecial {
1.911     bisitz   7784:   /* display:block; */
                   7785:   list-style-position: inside;
                   7786:   list-style-type: none;
                   7787:   overflow: hidden;
                   7788:   padding: 0;
1.693     droeschl 7789: }
                   7790: 
1.721     harmsja  7791: .LC_ListStyleSimple li,
                   7792: .LC_ListStyleSimple dd,
                   7793: .LC_ListStyleNormal li,
                   7794: .LC_ListStyleNormal dd,
                   7795: .LC_ListStyleSpecial li,
1.795     www      7796: .LC_ListStyleSpecial dd {
1.911     bisitz   7797:   margin: 0;
                   7798:   padding: 5px 5px 5px 10px;
                   7799:   clear: both;
1.693     droeschl 7800: }
                   7801: 
1.721     harmsja  7802: .LC_ListStyleClean li,
                   7803: .LC_ListStyleClean dd {
1.911     bisitz   7804:   padding-top: 0;
                   7805:   padding-bottom: 0;
1.693     droeschl 7806: }
                   7807: 
1.721     harmsja  7808: .LC_ListStyleSimple dd,
1.795     www      7809: .LC_ListStyleSimple li {
1.911     bisitz   7810:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 7811: }
                   7812: 
1.721     harmsja  7813: .LC_ListStyleSpecial li,
                   7814: .LC_ListStyleSpecial dd {
1.911     bisitz   7815:   list-style-type: none;
                   7816:   background-color: RGB(220, 220, 220);
                   7817:   margin-bottom: 4px;
1.693     droeschl 7818: }
                   7819: 
1.721     harmsja  7820: table.LC_SimpleTable {
1.911     bisitz   7821:   margin:5px;
                   7822:   border:solid 1px $lg_border_color;
1.795     www      7823: }
1.693     droeschl 7824: 
1.721     harmsja  7825: table.LC_SimpleTable tr {
1.911     bisitz   7826:   padding: 0;
                   7827:   border:solid 1px $lg_border_color;
1.693     droeschl 7828: }
1.795     www      7829: 
                   7830: table.LC_SimpleTable thead {
1.911     bisitz   7831:   background:rgb(220,220,220);
1.693     droeschl 7832: }
                   7833: 
1.721     harmsja  7834: div.LC_columnSection {
1.911     bisitz   7835:   display: block;
                   7836:   clear: both;
                   7837:   overflow: hidden;
                   7838:   margin: 0;
1.693     droeschl 7839: }
                   7840: 
1.721     harmsja  7841: div.LC_columnSection>* {
1.911     bisitz   7842:   float: left;
                   7843:   margin: 10px 20px 10px 0;
                   7844:   overflow:hidden;
1.693     droeschl 7845: }
1.721     harmsja  7846: 
1.795     www      7847: table em {
1.911     bisitz   7848:   font-weight: bold;
                   7849:   font-style: normal;
1.748     schulted 7850: }
1.795     www      7851: 
1.779     bisitz   7852: table.LC_tableBrowseRes,
1.795     www      7853: table.LC_tableOfContent {
1.911     bisitz   7854:   border:none;
                   7855:   border-spacing: 1px;
                   7856:   padding: 3px;
                   7857:   background-color: #FFFFFF;
                   7858:   font-size: 90%;
1.753     droeschl 7859: }
1.789     droeschl 7860: 
1.911     bisitz   7861: table.LC_tableOfContent {
                   7862:   border-collapse: collapse;
1.789     droeschl 7863: }
                   7864: 
1.771     droeschl 7865: table.LC_tableBrowseRes a,
1.768     schulted 7866: table.LC_tableOfContent a {
1.911     bisitz   7867:   background-color: transparent;
                   7868:   text-decoration: none;
1.753     droeschl 7869: }
                   7870: 
1.795     www      7871: table.LC_tableOfContent img {
1.911     bisitz   7872:   border: none;
                   7873:   height: 1.3em;
                   7874:   vertical-align: text-bottom;
                   7875:   margin-right: 0.3em;
1.753     droeschl 7876: }
1.757     schulted 7877: 
1.795     www      7878: a#LC_content_toolbar_firsthomework {
1.911     bisitz   7879:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  7880: }
                   7881: 
1.795     www      7882: a#LC_content_toolbar_everything {
1.911     bisitz   7883:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  7884: }
                   7885: 
1.795     www      7886: a#LC_content_toolbar_uncompleted {
1.911     bisitz   7887:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  7888: }
                   7889: 
1.795     www      7890: #LC_content_toolbar_clearbubbles {
1.911     bisitz   7891:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  7892: }
                   7893: 
1.795     www      7894: a#LC_content_toolbar_changefolder {
1.911     bisitz   7895:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 7896: }
                   7897: 
1.795     www      7898: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   7899:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 7900: }
                   7901: 
1.1043    raeburn  7902: a#LC_content_toolbar_edittoplevel {
                   7903:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   7904: }
                   7905: 
1.795     www      7906: ul#LC_toolbar li a:hover {
1.911     bisitz   7907:   background-position: bottom center;
1.757     schulted 7908: }
                   7909: 
1.795     www      7910: ul#LC_toolbar {
1.911     bisitz   7911:   padding: 0;
                   7912:   margin: 2px;
                   7913:   list-style:none;
                   7914:   position:relative;
                   7915:   background-color:white;
1.1075.2.9  raeburn  7916:   overflow: auto;
1.757     schulted 7917: }
                   7918: 
1.795     www      7919: ul#LC_toolbar li {
1.911     bisitz   7920:   border:1px solid white;
                   7921:   padding: 0;
                   7922:   margin: 0;
                   7923:   float: left;
                   7924:   display:inline;
                   7925:   vertical-align:middle;
1.1075.2.9  raeburn  7926:   white-space: nowrap;
1.911     bisitz   7927: }
1.757     schulted 7928: 
1.783     amueller 7929: 
1.795     www      7930: a.LC_toolbarItem {
1.911     bisitz   7931:   display:block;
                   7932:   padding: 0;
                   7933:   margin: 0;
                   7934:   height: 32px;
                   7935:   width: 32px;
                   7936:   color:white;
                   7937:   border: none;
                   7938:   background-repeat:no-repeat;
                   7939:   background-color:transparent;
1.757     schulted 7940: }
                   7941: 
1.915     droeschl 7942: ul.LC_funclist {
                   7943:     margin: 0;
                   7944:     padding: 0.5em 1em 0.5em 0;
                   7945: }
                   7946: 
1.933     droeschl 7947: ul.LC_funclist > li:first-child {
                   7948:     font-weight:bold; 
                   7949:     margin-left:0.8em;
                   7950: }
                   7951: 
1.915     droeschl 7952: ul.LC_funclist + ul.LC_funclist {
                   7953:     /* 
                   7954:        left border as a seperator if we have more than
                   7955:        one list 
                   7956:     */
                   7957:     border-left: 1px solid $sidebg;
                   7958:     /* 
                   7959:        this hides the left border behind the border of the 
                   7960:        outer box if element is wrapped to the next 'line' 
                   7961:     */
                   7962:     margin-left: -1px;
                   7963: }
                   7964: 
1.843     bisitz   7965: ul.LC_funclist li {
1.915     droeschl 7966:   display: inline;
1.782     bisitz   7967:   white-space: nowrap;
1.915     droeschl 7968:   margin: 0 0 0 25px;
                   7969:   line-height: 150%;
1.782     bisitz   7970: }
                   7971: 
1.974     wenzelju 7972: .LC_hidden {
                   7973:   display: none;
                   7974: }
                   7975: 
1.1030    www      7976: .LCmodal-overlay {
                   7977: 		position:fixed;
                   7978: 		top:0;
                   7979: 		right:0;
                   7980: 		bottom:0;
                   7981: 		left:0;
                   7982: 		height:100%;
                   7983: 		width:100%;
                   7984: 		margin:0;
                   7985: 		padding:0;
                   7986: 		background:#999;
                   7987: 		opacity:.75;
                   7988: 		filter: alpha(opacity=75);
                   7989: 		-moz-opacity: 0.75;
                   7990: 		z-index:101;
                   7991: }
                   7992: 
                   7993: * html .LCmodal-overlay {   
                   7994: 		position: absolute;
                   7995: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   7996: }
                   7997: 
                   7998: .LCmodal-window {
                   7999: 		position:fixed;
                   8000: 		top:50%;
                   8001: 		left:50%;
                   8002: 		margin:0;
                   8003: 		padding:0;
                   8004: 		z-index:102;
                   8005: 	}
                   8006: 
                   8007: * html .LCmodal-window {
                   8008: 		position:absolute;
                   8009: }
                   8010: 
                   8011: .LCclose-window {
                   8012: 		position:absolute;
                   8013: 		width:32px;
                   8014: 		height:32px;
                   8015: 		right:8px;
                   8016: 		top:8px;
                   8017: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   8018: 		text-indent:-99999px;
                   8019: 		overflow:hidden;
                   8020: 		cursor:pointer;
                   8021: }
                   8022: 
1.1075.2.158  raeburn  8023: .LCisDisabled {
                   8024:   cursor: not-allowed;
                   8025:   opacity: 0.5;
                   8026: }
                   8027: 
                   8028: a[aria-disabled="true"] {
                   8029:   color: currentColor;
                   8030:   display: inline-block;  /* For IE11/ MS Edge bug */
                   8031:   pointer-events: none;
                   8032:   text-decoration: none;
                   8033: }
                   8034: 
1.1075.2.141  raeburn  8035: pre.LC_wordwrap {
                   8036:   white-space: pre-wrap;
                   8037:   white-space: -moz-pre-wrap;
                   8038:   white-space: -pre-wrap;
                   8039:   white-space: -o-pre-wrap;
                   8040:   word-wrap: break-word;
                   8041: }
                   8042: 
1.1075.2.17  raeburn  8043: /*
                   8044:   styles used by TTH when "Default set of options to pass to tth/m
                   8045:   when converting TeX" in course settings has been set
                   8046: 
                   8047:   option passed: -t
                   8048: 
                   8049: */
                   8050: 
                   8051: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   8052: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   8053: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   8054: td div.norm {line-height:normal;}
                   8055: 
                   8056: /*
                   8057:   option passed -y3
                   8058: */
                   8059: 
                   8060: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   8061: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   8062: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   8063: 
1.1075.2.121  raeburn  8064: #LC_minitab_header {
                   8065:   float:left;
                   8066:   width:100%;
                   8067:   background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
                   8068:   font-size:93%;
                   8069:   line-height:normal;
                   8070:   margin: 0.5em 0 0.5em 0;
                   8071: }
                   8072: #LC_minitab_header ul {
                   8073:   margin:0;
                   8074:   padding:10px 10px 0;
                   8075:   list-style:none;
                   8076: }
                   8077: #LC_minitab_header li {
                   8078:   float:left;
                   8079:   background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
                   8080:   margin:0;
                   8081:   padding:0 0 0 9px;
                   8082: }
                   8083: #LC_minitab_header a {
                   8084:   display:block;
                   8085:   background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
                   8086:   padding:5px 15px 4px 6px;
                   8087: }
                   8088: #LC_minitab_header #LC_current_minitab {
                   8089:   background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
                   8090: }
                   8091: #LC_minitab_header #LC_current_minitab a {
                   8092:   background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
                   8093:   padding-bottom:5px;
                   8094: }
                   8095: 
                   8096: 
1.343     albertel 8097: END
                   8098: }
                   8099: 
1.306     albertel 8100: =pod
                   8101: 
                   8102: =item * &headtag()
                   8103: 
                   8104: Returns a uniform footer for LON-CAPA web pages.
                   8105: 
1.307     albertel 8106: Inputs: $title - optional title for the head
                   8107:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 8108:         $args - optional arguments
1.319     albertel 8109:             force_register - if is true call registerurl so the remote is 
                   8110:                              informed
1.415     albertel 8111:             redirect       -> array ref of
                   8112:                                    1- seconds before redirect occurs
                   8113:                                    2- url to redirect to
                   8114:                                    3- whether the side effect should occur
1.315     albertel 8115:                            (side effect of setting 
                   8116:                                $env{'internal.head.redirect'} to the url 
                   8117:                                redirected too)
1.352     albertel 8118:             domain         -> force to color decorate a page for a specific
                   8119:                                domain
                   8120:             function       -> force usage of a specific rolish color scheme
                   8121:             bgcolor        -> override the default page bgcolor
1.460     albertel 8122:             no_auto_mt_title
                   8123:                            -> prevent &mt()ing the title arg
1.464     albertel 8124: 
1.306     albertel 8125: =cut
                   8126: 
                   8127: sub headtag {
1.313     albertel 8128:     my ($title,$head_extra,$args) = @_;
1.306     albertel 8129:     
1.363     albertel 8130:     my $function = $args->{'function'} || &get_users_function();
                   8131:     my $domain   = $args->{'domain'}   || &determinedomain();
                   8132:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1075.2.52  raeburn  8133:     my $httphost = $args->{'use_absolute'};
1.418     albertel 8134:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 8135: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 8136: 		   #time(),
1.418     albertel 8137: 		   $env{'environment.color.timestamp'},
1.363     albertel 8138: 		   $function,$domain,$bgcolor);
                   8139: 
1.369     www      8140:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 8141: 
1.308     albertel 8142:     my $result =
                   8143: 	'<head>'.
1.1075.2.56  raeburn  8144: 	&font_settings($args);
1.319     albertel 8145: 
1.1075.2.72  raeburn  8146:     my $inhibitprint;
                   8147:     if ($args->{'print_suppress'}) {
                   8148:         $inhibitprint = &print_suppression();
                   8149:     }
1.1064    raeburn  8150: 
1.461     albertel 8151:     if (!$args->{'frameset'}) {
                   8152: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   8153:     }
1.1075.2.12  raeburn  8154:     if ($args->{'force_register'}) {
                   8155:         $result .= &Apache::lonmenu::registerurl(1);
1.319     albertel 8156:     }
1.436     albertel 8157:     if (!$args->{'no_nav_bar'} 
                   8158: 	&& !$args->{'only_body'}
                   8159: 	&& !$args->{'frameset'}) {
1.1075.2.52  raeburn  8160: 	$result .= &help_menu_js($httphost);
1.1032    www      8161:         $result.=&modal_window();
1.1038    www      8162:         $result.=&togglebox_script();
1.1034    www      8163:         $result.=&wishlist_window();
1.1041    www      8164:         $result.=&LCprogressbarUpdate_script();
1.1034    www      8165:     } else {
                   8166:         if ($args->{'add_modal'}) {
                   8167:            $result.=&modal_window();
                   8168:         }
                   8169:         if ($args->{'add_wishlist'}) {
                   8170:            $result.=&wishlist_window();
                   8171:         }
1.1038    www      8172:         if ($args->{'add_togglebox'}) {
                   8173:            $result.=&togglebox_script();
                   8174:         }
1.1041    www      8175:         if ($args->{'add_progressbar'}) {
                   8176:            $result.=&LCprogressbarUpdate_script();
                   8177:         }
1.436     albertel 8178:     }
1.314     albertel 8179:     if (ref($args->{'redirect'})) {
1.414     albertel 8180: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 8181: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 8182: 	if (!$inhibit_continue) {
                   8183: 	    $env{'internal.head.redirect'} = $url;
                   8184: 	}
1.313     albertel 8185: 	$result.=<<ADDMETA
                   8186: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 8187: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 8188: ADDMETA
1.1075.2.89  raeburn  8189:     } else {
                   8190:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
                   8191:             my $requrl = $env{'request.uri'};
                   8192:             if ($requrl eq '') {
                   8193:                 $requrl = $ENV{'REQUEST_URI'};
                   8194:                 $requrl =~ s/\?.+$//;
                   8195:             }
                   8196:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
                   8197:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
                   8198:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
                   8199:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
                   8200:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
                   8201:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1075.2.145  raeburn  8202:                     my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1075.2.151  raeburn  8203:                     my ($offload,$offloadoth);
1.1075.2.89  raeburn  8204:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
                   8205:                         if ($domdefs{'offloadnow'}{$lonhost}) {
1.1075.2.145  raeburn  8206:                             $offload = 1;
1.1075.2.151  raeburn  8207:                             if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8208:                                 (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8209:                                 unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8210:                                     $offloadoth = 1;
                   8211:                                     $dom_in_use = $env{'user.domain'};
                   8212:                                 }
                   8213:                             }
1.1075.2.145  raeburn  8214:                         }
                   8215:                     }
                   8216:                     unless ($offload) {
                   8217:                         if (ref($domdefs{'offloadoth'}) eq 'HASH') {
                   8218:                             if ($domdefs{'offloadoth'}{$lonhost}) {
                   8219:                                 if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8220:                                     (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8221:                                     unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8222:                                         $offload = 1;
1.1075.2.151  raeburn  8223:                                         $offloadoth = 1;
1.1075.2.145  raeburn  8224:                                         $dom_in_use = $env{'user.domain'};
                   8225:                                     }
1.1075.2.89  raeburn  8226:                                 }
1.1075.2.145  raeburn  8227:                             }
                   8228:                         }
                   8229:                     }
                   8230:                     if ($offload) {
1.1075.2.158  raeburn  8231:                         my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1075.2.151  raeburn  8232:                         if (($newserver eq '') && ($offloadoth)) {
                   8233:                             my @domains = &Apache::lonnet::current_machine_domains();
1.1075.2.161.  .1(raebu 8234:21):                             if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
1.1075.2.151  raeburn  8235:                                 ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
                   8236:                             }
                   8237:                         }
1.1075.2.145  raeburn  8238:                         if (($newserver) && ($newserver ne $lonhost)) {
                   8239:                             my $numsec = 5;
                   8240:                             my $timeout = $numsec * 1000;
                   8241:                             my ($newurl,$locknum,%locks,$msg);
                   8242:                             if ($env{'request.role.adv'}) {
                   8243:                                 ($locknum,%locks) = &Apache::lonnet::get_locks();
                   8244:                             }
                   8245:                             my $disable_submit = 0;
                   8246:                             if ($requrl =~ /$LONCAPA::assess_re/) {
                   8247:                                 $disable_submit = 1;
                   8248:                             }
                   8249:                             if ($locknum) {
                   8250:                                 my @lockinfo = sort(values(%locks));
1.1075.2.153  raeburn  8251:                                 $msg = &mt('Once the following tasks are complete:')." \n".
1.1075.2.145  raeburn  8252:                                        join(", ",sort(values(%locks)))."\n";
                   8253:                                 if (&show_course()) {
                   8254:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
1.1075.2.89  raeburn  8255:                                 } else {
1.1075.2.145  raeburn  8256:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
                   8257:                                 }
                   8258:                             } else {
                   8259:                                 if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
                   8260:                                     $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
                   8261:                                 }
                   8262:                                 $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
                   8263:                                 $newurl = '/adm/switchserver?otherserver='.$newserver;
                   8264:                                 if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
                   8265:                                     $newurl .= '&role='.$env{'request.role'};
                   8266:                                 }
                   8267:                                 if ($env{'request.symb'}) {
                   8268:                                     my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
                   8269:                                     if ($shownsymb =~ m{^/enc/}) {
                   8270:                                         my $reqdmajor = 2;
                   8271:                                         my $reqdminor = 11;
                   8272:                                         my $reqdsubminor = 3;
                   8273:                                         my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
                   8274:                                         my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
                   8275:                                         my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
                   8276:                                         if (($major eq '' && $minor eq '') ||
                   8277:                                             (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
                   8278:                                             (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
                   8279:                                              ($reqdsubminor > $subminor))))) {
                   8280:                                             undef($shownsymb);
                   8281:                                         }
1.1075.2.89  raeburn  8282:                                     }
1.1075.2.145  raeburn  8283:                                     if ($shownsymb) {
                   8284:                                         &js_escape(\$shownsymb);
                   8285:                                         $newurl .= '&symb='.$shownsymb;
1.1075.2.89  raeburn  8286:                                     }
1.1075.2.145  raeburn  8287:                                 } else {
                   8288:                                     my $shownurl = &Apache::lonenc::check_encrypt($requrl);
                   8289:                                     &js_escape(\$shownurl);
                   8290:                                     $newurl .= '&origurl='.$shownurl;
1.1075.2.89  raeburn  8291:                                 }
1.1075.2.145  raeburn  8292:                             }
                   8293:                             &js_escape(\$msg);
                   8294:                             $result.=<<OFFLOAD
1.1075.2.89  raeburn  8295: <meta http-equiv="pragma" content="no-cache" />
                   8296: <script type="text/javascript">
1.1075.2.92  raeburn  8297: // <![CDATA[
1.1075.2.89  raeburn  8298: function LC_Offload_Now() {
                   8299:     var dest = "$newurl";
                   8300:     if (dest != '') {
                   8301:         window.location.href="$newurl";
                   8302:     }
                   8303: }
1.1075.2.92  raeburn  8304: \$(document).ready(function () {
                   8305:     window.alert('$msg');
                   8306:     if ($disable_submit) {
1.1075.2.89  raeburn  8307:         \$(".LC_hwk_submit").prop("disabled", true);
                   8308:         \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1075.2.92  raeburn  8309:     }
                   8310:     setTimeout('LC_Offload_Now()', $timeout);
                   8311: });
                   8312: // ]]>
1.1075.2.89  raeburn  8313: </script>
                   8314: OFFLOAD
                   8315:                         }
                   8316:                     }
                   8317:                 }
                   8318:             }
                   8319:         }
1.313     albertel 8320:     }
1.306     albertel 8321:     if (!defined($title)) {
                   8322: 	$title = 'The LearningOnline Network with CAPA';
                   8323:     }
1.460     albertel 8324:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   8325:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.1075.2.61  raeburn  8326: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'"';
                   8327:     if (!$args->{'frameset'}) {
                   8328:         $result .= ' /';
                   8329:     }
                   8330:     $result .= '>'
1.1064    raeburn  8331:         .$inhibitprint
1.414     albertel 8332: 	.$head_extra;
1.1075.2.108  raeburn  8333:     my $clientmobile;
                   8334:     if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   8335:         (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
                   8336:     } else {
                   8337:         $clientmobile = $env{'browser.mobile'};
                   8338:     }
                   8339:     if ($clientmobile) {
1.1075.2.42  raeburn  8340:         $result .= '
                   8341: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
                   8342: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   8343:     }
1.1075.2.126  raeburn  8344:     $result .= '<meta name="google" content="notranslate" />'."\n";
1.962     droeschl 8345:     return $result.'</head>';
1.306     albertel 8346: }
                   8347: 
                   8348: =pod
                   8349: 
1.340     albertel 8350: =item * &font_settings()
                   8351: 
                   8352: Returns neccessary <meta> to set the proper encoding
                   8353: 
1.1075.2.56  raeburn  8354: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 8355: 
                   8356: =cut
                   8357: 
                   8358: sub font_settings {
1.1075.2.56  raeburn  8359:     my ($args) = @_;
1.340     albertel 8360:     my $headerstring='';
1.1075.2.56  raeburn  8361:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   8362:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.340     albertel 8363: 	$headerstring.=
1.1075.2.61  raeburn  8364: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   8365:         if (!$args->{'frameset'}) {
                   8366:             $headerstring.= ' /';
                   8367:         }
                   8368:         $headerstring .= '>'."\n";
1.340     albertel 8369:     }
                   8370:     return $headerstring;
                   8371: }
                   8372: 
1.341     albertel 8373: =pod
                   8374: 
1.1064    raeburn  8375: =item * &print_suppression()
                   8376: 
                   8377: In course context returns css which causes the body to be blank when media="print",
                   8378: if printout generation is unavailable for the current resource.
                   8379: 
                   8380: This could be because:
                   8381: 
                   8382: (a) printstartdate is in the future
                   8383: 
                   8384: (b) printenddate is in the past
                   8385: 
                   8386: (c) there is an active exam block with "printout"
                   8387: functionality blocked
                   8388: 
                   8389: Users with pav, pfo or evb privileges are exempt.
                   8390: 
                   8391: Inputs: none
                   8392: 
                   8393: =cut
                   8394: 
                   8395: 
                   8396: sub print_suppression {
                   8397:     my $noprint;
                   8398:     if ($env{'request.course.id'}) {
                   8399:         my $scope = $env{'request.course.id'};
                   8400:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8401:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   8402:             return;
                   8403:         }
                   8404:         if ($env{'request.course.sec'} ne '') {
                   8405:             $scope .= "/$env{'request.course.sec'}";
                   8406:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8407:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  8408:                 return;
1.1064    raeburn  8409:             }
                   8410:         }
                   8411:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8412:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.158  raeburn  8413:         my $clientip = &Apache::lonnet::get_requestor_ip();
                   8414:         my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064    raeburn  8415:         if ($blocked) {
                   8416:             my $checkrole = "cm./$cdom/$cnum";
                   8417:             if ($env{'request.course.sec'} ne '') {
                   8418:                 $checkrole .= "/$env{'request.course.sec'}";
                   8419:             }
                   8420:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   8421:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   8422:                 $noprint = 1;
                   8423:             }
                   8424:         }
                   8425:         unless ($noprint) {
                   8426:             my $symb = &Apache::lonnet::symbread();
                   8427:             if ($symb ne '') {
                   8428:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   8429:                 if (ref($navmap)) {
                   8430:                     my $res = $navmap->getBySymb($symb);
                   8431:                     if (ref($res)) {
                   8432:                         if (!$res->resprintable()) {
                   8433:                             $noprint = 1;
                   8434:                         }
                   8435:                     }
                   8436:                 }
                   8437:             }
                   8438:         }
                   8439:         if ($noprint) {
                   8440:             return <<"ENDSTYLE";
                   8441: <style type="text/css" media="print">
                   8442:     body { display:none }
                   8443: </style>
                   8444: ENDSTYLE
                   8445:         }
                   8446:     }
                   8447:     return;
                   8448: }
                   8449: 
                   8450: =pod
                   8451: 
1.341     albertel 8452: =item * &xml_begin()
                   8453: 
                   8454: Returns the needed doctype and <html>
                   8455: 
                   8456: Inputs: none
                   8457: 
                   8458: =cut
                   8459: 
                   8460: sub xml_begin {
1.1075.2.61  raeburn  8461:     my ($is_frameset) = @_;
1.341     albertel 8462:     my $output='';
                   8463: 
                   8464:     if ($env{'browser.mathml'}) {
                   8465: 	$output='<?xml version="1.0"?>'
                   8466:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   8467: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   8468:             
                   8469: #	    .'<!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">] >'
                   8470: 	    .'<!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">'
                   8471:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   8472: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1075.2.61  raeburn  8473:     } elsif ($is_frameset) {
                   8474:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
                   8475:                 '<html>'."\n";
1.341     albertel 8476:     } else {
1.1075.2.61  raeburn  8477: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   8478:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 8479:     }
                   8480:     return $output;
                   8481: }
1.340     albertel 8482: 
                   8483: =pod
                   8484: 
1.306     albertel 8485: =item * &start_page()
                   8486: 
                   8487: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   8488: 
1.648     raeburn  8489: Inputs:
                   8490: 
                   8491: =over 4
                   8492: 
                   8493: $title - optional title for the page
                   8494: 
                   8495: $head_extra - optional extra HTML to incude inside the <head>
                   8496: 
                   8497: $args - additional optional args supported are:
                   8498: 
                   8499: =over 8
                   8500: 
                   8501:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 8502:                                     arg on
1.814     bisitz   8503:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  8504:              add_entries    -> additional attributes to add to the  <body>
                   8505:              domain         -> force to color decorate a page for a 
1.317     albertel 8506:                                     specific domain
1.648     raeburn  8507:              function       -> force usage of a specific rolish color
1.317     albertel 8508:                                     scheme
1.648     raeburn  8509:              redirect       -> see &headtag()
                   8510:              bgcolor        -> override the default page bg color
                   8511:              js_ready       -> return a string ready for being used in 
1.317     albertel 8512:                                     a javascript writeln
1.648     raeburn  8513:              html_encode    -> return a string ready for being used in 
1.320     albertel 8514:                                     a html attribute
1.648     raeburn  8515:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 8516:                                     $forcereg arg
1.648     raeburn  8517:              frameset       -> if true will start with a <frameset>
1.330     albertel 8518:                                     rather than <body>
1.648     raeburn  8519:              skip_phases    -> hash ref of 
1.338     albertel 8520:                                     head -> skip the <html><head> generation
                   8521:                                     body -> skip all <body> generation
1.1075.2.12  raeburn  8522:              no_inline_link -> if true and in remote mode, don't show the
                   8523:                                     'Switch To Inline Menu' link
1.648     raeburn  8524:              no_auto_mt_title -> prevent &mt()ing the title arg
1.867     kalberla 8525:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  8526:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1075.2.123  raeburn  8527:              bread_crumbs_nomenu -> if true will pass false as the value of $menulink
                   8528:                                     to lonhtmlcommon::breadcrumbs
1.1075.2.15  raeburn  8529:              group          -> includes the current group, if page is for a
                   8530:                                specific group
1.1075.2.133  raeburn  8531:              use_absolute   -> for request for external resource or syllabus, this
                   8532:                                will contain https://<hostname> if server uses
                   8533:                                https (as per hosts.tab), but request is for http
                   8534:              hostname       -> hostname, originally from $r->hostname(), (optional).
1.1075.2.158  raeburn  8535:              links_disabled -> Links in primary and secondary menus are disabled
                   8536:                                (Can enable them once page has loaded - see lonroles.pm
                   8537:                                for an example).
1.361     albertel 8538: 
1.648     raeburn  8539: =back
1.460     albertel 8540: 
1.648     raeburn  8541: =back
1.562     albertel 8542: 
1.306     albertel 8543: =cut
                   8544: 
                   8545: sub start_page {
1.309     albertel 8546:     my ($title,$head_extra,$args) = @_;
1.318     albertel 8547:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 8548: 
1.315     albertel 8549:     $env{'internal.start_page'}++;
1.1075.2.161.  .1(raebu 8550:21):     my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964     droeschl 8551: 
1.338     albertel 8552:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1075.2.62  raeburn  8553:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 8554:     }
1.1075.2.161.  .1(raebu 8555:21): 
                   8556:21):     if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
                   8557:21):         if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
                   8558:21):             unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
                   8559:21):                 $args->{'no_primary_menu'} = 1;
                   8560:21):             }
                   8561:21):             unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
                   8562:21):                 $args->{'no_inline_menu'} = 1;
                   8563:21):             }
                   8564:21):             if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
                   8565:21):                 map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
                   8566:21):             }
                   8567:21):         } else {
                   8568:21):             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8569:21):             my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
                   8570:21):             if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
                   8571:21):                 unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
                   8572:21):                     $args->{'no_primary_menu'} = 1;
                   8573:21):                 }
                   8574:21):                 unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
                   8575:21):                     $args->{'no_inline_menu'} = 1;
                   8576:21):                 }
                   8577:21):                 if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
                   8578:21):                     map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
                   8579:21):                 }
                   8580:21):             }
                   8581:21):         }
                   8582:21):         ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
                   8583:21):                                   $env{'course.'.$env{'request.course.id'}.'.domain'},
                   8584:21):                                   $env{'course.'.$env{'request.course.id'}.'.num'});
                   8585:21):     } elsif ($env{'request.course.id'}) {
                   8586:21):         my $expiretime=600;
                   8587:21):         if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
                   8588:21):             &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
                   8589:21):         }
                   8590:21):         my ($deeplinkmenu,$menuref);
                   8591:21):         ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
                   8592:21):         if ($menucoll) {
                   8593:21):             if (ref($menuref) eq 'HASH') {
                   8594:21):                 %menu = %{$menuref};
                   8595:21):             }
                   8596:21):             if ($menu{'top'} eq 'n') {
                   8597:21):                 $args->{'no_primary_menu'} = 1;
                   8598:21):             }
                   8599:21):             if ($menu{'inline'} eq 'n') {
                   8600:21):                 unless (&Apache::lonnet::allowed('opa')) {
                   8601:21):                     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8602:21):                     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   8603:21):                     my $crstype = &course_type();
                   8604:21):                     my $now = time;
                   8605:21):                     my $ccrole;
                   8606:21):                     if ($crstype eq 'Community') {
                   8607:21):                         $ccrole = 'co';
                   8608:21):                     } else {
                   8609:21):                         $ccrole = 'cc';
                   8610:21):                     }
                   8611:21):                     if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
                   8612:21):                         my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
                   8613:21):                         if ((($start) && ($start<0)) ||
                   8614:21):                             (($end) && ($end<$now))  ||
                   8615:21):                             (($start) && ($now<$start))) {
                   8616:21):                             $args->{'no_inline_menu'} = 1;
                   8617:21):                         }
                   8618:21):                     } else {
                   8619:21):                         $args->{'no_inline_menu'} = 1;
                   8620:21):                     }
                   8621:21):                 }
                   8622:21):             }
                   8623:21):         }
                   8624:21):     }
1.338     albertel 8625:     
                   8626:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   8627: 	if ($args->{'frameset'}) {
                   8628: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   8629: 						$args->{'add_entries'});
                   8630: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   8631:         } else {
                   8632:             $result .=
                   8633:                 &bodytag($title, 
                   8634:                          $args->{'function'},       $args->{'add_entries'},
                   8635:                          $args->{'only_body'},      $args->{'domain'},
                   8636:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12  raeburn  8637:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
1.1075.2.161.  .1(raebu 8638:21):                          $args,                     \@advtools,
                   8639:21):                          $ltiscope,$ltiuri,\%ltimenu,$menucoll,\%menu);
1.831     bisitz   8640:         }
1.330     albertel 8641:     }
1.338     albertel 8642: 
1.315     albertel 8643:     if ($args->{'js_ready'}) {
1.713     kaisler  8644: 		$result = &js_ready($result);
1.315     albertel 8645:     }
1.320     albertel 8646:     if ($args->{'html_encode'}) {
1.713     kaisler  8647: 		$result = &html_encode($result);
                   8648:     }
                   8649: 
1.813     bisitz   8650:     # Preparation for new and consistent functionlist at top of screen
                   8651:     # if ($args->{'functionlist'}) {
                   8652:     #            $result .= &build_functionlist();
                   8653:     #}
                   8654: 
1.964     droeschl 8655:     # Don't add anything more if only_body wanted or in const space
                   8656:     return $result if    $args->{'only_body'} 
                   8657:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   8658: 
                   8659:     #Breadcrumbs
1.758     kaisler  8660:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   8661: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   8662: 		#if any br links exists, add them to the breadcrumbs
                   8663: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   8664: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   8665: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   8666: 			}
                   8667: 		}
1.1075.2.19  raeburn  8668:                 # if @advtools array contains items add then to the breadcrumbs
                   8669:                 if (@advtools > 0) {
                   8670:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   8671:                 }
1.1075.2.123  raeburn  8672:                 my $menulink;
                   8673:                 # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
1.1075.2.161.  .1(raebu 8674:21):                 if ((exists($args->{'bread_crumbs_nomenu'})) ||
                   8675:21):                     ($ltiscope eq 'map') || ($ltiscope eq 'resource')) {
1.1075.2.123  raeburn  8676:                     $menulink = 0;
                   8677:                 } else {
                   8678:                     undef($menulink);
                   8679:                 }
1.758     kaisler  8680: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   8681: 		if(exists($args->{'bread_crumbs_component'})){
1.1075.2.123  raeburn  8682: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.1075.2.161.  .1(raebu 8683:21): 		} else {
1.1075.2.123  raeburn  8684: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758     kaisler  8685: 		}
1.1075.2.24  raeburn  8686:     } elsif (($env{'environment.remote'} eq 'on') &&
                   8687:              ($env{'form.inhibitmenu'} ne 'yes') &&
                   8688:              ($env{'request.noversionuri'} =~ m{^/res/}) &&
                   8689:              ($env{'request.noversionuri'} !~ m{^/res/adm/pages/})) {
1.1075.2.21  raeburn  8690:         $result .= '<div style="padding:0;margin:0;clear:both"><hr /></div>';
1.320     albertel 8691:     }
1.315     albertel 8692:     return $result;
1.306     albertel 8693: }
                   8694: 
                   8695: sub end_page {
1.315     albertel 8696:     my ($args) = @_;
                   8697:     $env{'internal.end_page'}++;
1.330     albertel 8698:     my $result;
1.335     albertel 8699:     if ($args->{'discussion'}) {
                   8700: 	my ($target,$parser);
                   8701: 	if (ref($args->{'discussion'})) {
                   8702: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   8703: 				$args->{'discussion'}{'parser'});
                   8704: 	}
                   8705: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   8706:     }
1.330     albertel 8707:     if ($args->{'frameset'}) {
                   8708: 	$result .= '</frameset>';
                   8709:     } else {
1.635     raeburn  8710: 	$result .= &endbodytag($args);
1.330     albertel 8711:     }
1.1075.2.6  raeburn  8712:     unless ($args->{'notbody'}) {
                   8713:         $result .= "\n</html>";
                   8714:     }
1.330     albertel 8715: 
1.315     albertel 8716:     if ($args->{'js_ready'}) {
1.317     albertel 8717: 	$result = &js_ready($result);
1.315     albertel 8718:     }
1.335     albertel 8719: 
1.320     albertel 8720:     if ($args->{'html_encode'}) {
                   8721: 	$result = &html_encode($result);
                   8722:     }
1.335     albertel 8723: 
1.315     albertel 8724:     return $result;
                   8725: }
                   8726: 
1.1075.2.161.  .1(raebu 8727:21): sub menucoll_in_effect {
                   8728:21):     my ($menucoll,$deeplinkmenu,%menu);
                   8729:21):     if ($env{'request.course.id'}) {
                   8730:21):         $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
                   8731:21):         if ($env{'request.deeplink.login'}) {
                   8732:21):             my ($deeplink_symb,$deeplink,$check_login_symb);
                   8733:21):             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   8734:21):             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8735:21):             if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
                   8736:21):                 if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
                   8737:21):                     my $navmap = Apache::lonnavmaps::navmap->new();
                   8738:21):                     if (ref($navmap)) {
                   8739:21):                         $deeplink = $navmap->get_mapparam(undef,
                   8740:21):                                                           &Apache::lonnet::declutter($env{'request.noversionuri'}),
                   8741:21):                                                           '0.deeplink');
                   8742:21):                     } else {
                   8743:21):                         $check_login_symb = 1;
                   8744:21):                     }
                   8745:21):                 } else {
                   8746:21):                     my $symb=&Apache::lonnet::symbread();
                   8747:21):                     if ($symb) {
                   8748:21):                         $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
                   8749:21):                     } else {
                   8750:21):                         $check_login_symb = 1;
                   8751:21):                     }
                   8752:21):                 }
                   8753:21):             } else {
                   8754:21):                 $check_login_symb = 1;
                   8755:21):             }
                   8756:21):             if ($check_login_symb) {
                   8757:21):                 $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
                   8758:21):                 if ($deeplink_symb =~ /\.(page|sequence)$/) {
                   8759:21):                     my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
                   8760:21):                     my $navmap = Apache::lonnavmaps::navmap->new();
                   8761:21):                     if (ref($navmap)) {
                   8762:21):                         $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
                   8763:21):                     }
                   8764:21):                 } else {
                   8765:21):                     $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
                   8766:21):                 }
                   8767:21):             }
                   8768:21):             if ($deeplink ne '') {
                   8769:21):                 my ($state,$others,$listed,$scope,$protect,$display) = split(/,/,$deeplink);
                   8770:21):                 if ($display =~ /^\d+$/) {
                   8771:21):                     $deeplinkmenu = 1;
                   8772:21):                     $menucoll = $display;
                   8773:21):                 }
                   8774:21):             }
                   8775:21):         }
                   8776:21):         if ($menucoll) {
                   8777:21):             %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
                   8778:21):         }
                   8779:21):     }
                   8780:21):     return ($menucoll,$deeplinkmenu,\%menu);
                   8781:21): }
                   8782:21): 
                   8783:21): sub deeplink_login_symb {
                   8784:21):     my ($cnum,$cdom) = @_;
                   8785:21):     my $login_symb;
                   8786:21):     if ($env{'request.deeplink.login'}) {
                   8787:21):         $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
                   8788:21):     }
                   8789:21):     return $login_symb;
                   8790:21): }
                   8791:21): 
                   8792:21): sub symb_from_tinyurl {
                   8793:21):     my ($url,$cnum,$cdom) = @_;
                   8794:21):     if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
                   8795:21):         my $key = $1;
                   8796:21):         my ($tinyurl,$login);
                   8797:21):         my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
                   8798:21):         if (defined($cached)) {
                   8799:21):             $tinyurl = $result;
                   8800:21):         } else {
                   8801:21):             my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
                   8802:21):             my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
                   8803:21):             if ($currtiny{$key} ne '') {
                   8804:21):                 $tinyurl = $currtiny{$key};
                   8805:21):                 &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
                   8806:21):             }
                   8807:21):         }
                   8808:21):         if ($tinyurl ne '') {
                   8809:21):             my ($cnumreq,$symb) = split(/\&/,$tinyurl);
                   8810:21):             if (wantarray) {
                   8811:21):                 return ($cnumreq,$symb);
                   8812:21):             } elsif ($cnumreq eq $cnum) {
                   8813:21):                 return $symb;
                   8814:21):             }
                   8815:21):         }
                   8816:21):     }
                   8817:21):     if (wantarray) {
                   8818:21):         return ();
                   8819:21):     } else {
                   8820:21):         return;
                   8821:21):     }
                   8822:21): }
                   8823:21): 
1.1034    www      8824: sub wishlist_window {
                   8825:     return(<<'ENDWISHLIST');
1.1046    raeburn  8826: <script type="text/javascript">
1.1034    www      8827: // <![CDATA[
                   8828: // <!-- BEGIN LON-CAPA Internal
                   8829: function set_wishlistlink(title, path) {
                   8830:     if (!title) {
                   8831:         title = document.title;
                   8832:         title = title.replace(/^LON-CAPA /,'');
                   8833:     }
1.1075.2.65  raeburn  8834:     title = encodeURIComponent(title);
1.1075.2.83  raeburn  8835:     title = title.replace("'","\\\'");
1.1034    www      8836:     if (!path) {
                   8837:         path = location.pathname;
                   8838:     }
1.1075.2.65  raeburn  8839:     path = encodeURIComponent(path);
1.1075.2.83  raeburn  8840:     path = path.replace("'","\\\'");
1.1034    www      8841:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   8842:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   8843: }
                   8844: // END LON-CAPA Internal -->
                   8845: // ]]>
                   8846: </script>
                   8847: ENDWISHLIST
                   8848: }
                   8849: 
1.1030    www      8850: sub modal_window {
                   8851:     return(<<'ENDMODAL');
1.1046    raeburn  8852: <script type="text/javascript">
1.1030    www      8853: // <![CDATA[
                   8854: // <!-- BEGIN LON-CAPA Internal
                   8855: var modalWindow = {
                   8856: 	parent:"body",
                   8857: 	windowId:null,
                   8858: 	content:null,
                   8859: 	width:null,
                   8860: 	height:null,
                   8861: 	close:function()
                   8862: 	{
                   8863: 	        $(".LCmodal-window").remove();
                   8864: 	        $(".LCmodal-overlay").remove();
                   8865: 	},
                   8866: 	open:function()
                   8867: 	{
                   8868: 		var modal = "";
                   8869: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   8870: 		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;\">";
                   8871: 		modal += this.content;
                   8872: 		modal += "</div>";	
                   8873: 
                   8874: 		$(this.parent).append(modal);
                   8875: 
                   8876: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   8877: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   8878: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   8879: 	}
                   8880: };
1.1075.2.42  raeburn  8881: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      8882: 	{
1.1075.2.119  raeburn  8883:                 source = source.replace(/'/g,"&#39;");
1.1030    www      8884: 		modalWindow.windowId = "myModal";
                   8885: 		modalWindow.width = width;
                   8886: 		modalWindow.height = height;
1.1075.2.80  raeburn  8887: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      8888: 		modalWindow.open();
1.1075.2.87  raeburn  8889: 	};
1.1030    www      8890: // END LON-CAPA Internal -->
                   8891: // ]]>
                   8892: </script>
                   8893: ENDMODAL
                   8894: }
                   8895: 
                   8896: sub modal_link {
1.1075.2.42  raeburn  8897:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      8898:     unless ($width) { $width=480; }
                   8899:     unless ($height) { $height=400; }
1.1031    www      8900:     unless ($scrolling) { $scrolling='yes'; }
1.1075.2.42  raeburn  8901:     unless ($transparency) { $transparency='true'; }
                   8902: 
1.1074    raeburn  8903:     my $target_attr;
                   8904:     if (defined($target)) {
                   8905:         $target_attr = 'target="'.$target.'"';
                   8906:     }
                   8907:     return <<"ENDLINK";
1.1075.2.143  raeburn  8908: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074    raeburn  8909: ENDLINK
1.1030    www      8910: }
                   8911: 
1.1032    www      8912: sub modal_adhoc_script {
1.1075.2.155  raeburn  8913:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
                   8914:     my $mathjax;
                   8915:     if ($possmathjax) {
                   8916:         $mathjax = <<'ENDJAX';
                   8917:                if (typeof MathJax == 'object') {
                   8918:                    MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
                   8919:                }
                   8920: ENDJAX
                   8921:     }
1.1032    www      8922:     return (<<ENDADHOC);
1.1046    raeburn  8923: <script type="text/javascript">
1.1032    www      8924: // <![CDATA[
                   8925:         var $funcname = function()
                   8926:         {
                   8927:                 modalWindow.windowId = "myModal";
                   8928:                 modalWindow.width = $width;
                   8929:                 modalWindow.height = $height;
                   8930:                 modalWindow.content = '$content';
                   8931:                 modalWindow.open();
1.1075.2.155  raeburn  8932:                 $mathjax
1.1032    www      8933:         };  
                   8934: // ]]>
                   8935: </script>
                   8936: ENDADHOC
                   8937: }
                   8938: 
1.1041    www      8939: sub modal_adhoc_inner {
1.1075.2.155  raeburn  8940:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041    www      8941:     my $innerwidth=$width-20;
                   8942:     $content=&js_ready(
1.1042    www      8943:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1075.2.42  raeburn  8944:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   8945:                  $content.
1.1041    www      8946:                  &end_scrollbox().
1.1075.2.42  raeburn  8947:                  &end_page()
1.1041    www      8948:              );
1.1075.2.155  raeburn  8949:     return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041    www      8950: }
                   8951: 
                   8952: sub modal_adhoc_window {
1.1075.2.155  raeburn  8953:     my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
                   8954:     return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041    www      8955:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   8956: }
                   8957: 
                   8958: sub modal_adhoc_launch {
                   8959:     my ($funcname,$width,$height,$content)=@_;
                   8960:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   8961: <script type="text/javascript">
                   8962: // <![CDATA[
                   8963: $funcname();
                   8964: // ]]>
                   8965: </script>
                   8966: ENDLAUNCH
                   8967: }
                   8968: 
                   8969: sub modal_adhoc_close {
                   8970:     return (<<ENDCLOSE);
                   8971: <script type="text/javascript">
                   8972: // <![CDATA[
                   8973: modalWindow.close();
                   8974: // ]]>
                   8975: </script>
                   8976: ENDCLOSE
                   8977: }
                   8978: 
1.1038    www      8979: sub togglebox_script {
                   8980:    return(<<ENDTOGGLE);
                   8981: <script type="text/javascript"> 
                   8982: // <![CDATA[
                   8983: function LCtoggleDisplay(id,hidetext,showtext) {
                   8984:    link = document.getElementById(id + "link").childNodes[0];
                   8985:    with (document.getElementById(id).style) {
                   8986:       if (display == "none" ) {
                   8987:           display = "inline";
                   8988:           link.nodeValue = hidetext;
                   8989:         } else {
                   8990:           display = "none";
                   8991:           link.nodeValue = showtext;
                   8992:        }
                   8993:    }
                   8994: }
                   8995: // ]]>
                   8996: </script>
                   8997: ENDTOGGLE
                   8998: }
                   8999: 
1.1039    www      9000: sub start_togglebox {
                   9001:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   9002:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   9003:     unless ($showtext) { $showtext=&mt('show'); }
                   9004:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   9005:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   9006:     return &start_data_table().
                   9007:            &start_data_table_header_row().
                   9008:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   9009:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   9010:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   9011:            &end_data_table_header_row().
                   9012:            '<tr id="'.$id.'" style="display:none""><td>';
                   9013: }
                   9014: 
                   9015: sub end_togglebox {
                   9016:     return '</td></tr>'.&end_data_table();
                   9017: }
                   9018: 
1.1041    www      9019: sub LCprogressbar_script {
1.1075.2.130  raeburn  9020:    my ($id,$number_to_do)=@_;
                   9021:    if ($number_to_do) {
                   9022:        return(<<ENDPROGRESS);
1.1041    www      9023: <script type="text/javascript">
                   9024: // <![CDATA[
1.1045    www      9025: \$('#progressbar$id').progressbar({
1.1041    www      9026:   value: 0,
                   9027:   change: function(event, ui) {
                   9028:     var newVal = \$(this).progressbar('option', 'value');
                   9029:     \$('.pblabel', this).text(LCprogressTxt);
                   9030:   }
                   9031: });
                   9032: // ]]>
                   9033: </script>
                   9034: ENDPROGRESS
1.1075.2.130  raeburn  9035:    } else {
                   9036:        return(<<ENDPROGRESS);
                   9037: <script type="text/javascript">
                   9038: // <![CDATA[
                   9039: \$('#progressbar$id').progressbar({
                   9040:   value: false,
                   9041:   create: function(event, ui) {
                   9042:     \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
                   9043:     \$('.ui-progressbar-overlay', this).css({'margin':'0'});
                   9044:   }
                   9045: });
                   9046: // ]]>
                   9047: </script>
                   9048: ENDPROGRESS
                   9049:    }
1.1041    www      9050: }
                   9051: 
                   9052: sub LCprogressbarUpdate_script {
                   9053:    return(<<ENDPROGRESSUPDATE);
                   9054: <style type="text/css">
                   9055: .ui-progressbar { position:relative; }
1.1075.2.130  raeburn  9056: .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      9057: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   9058: </style>
                   9059: <script type="text/javascript">
                   9060: // <![CDATA[
1.1045    www      9061: var LCprogressTxt='---';
                   9062: 
1.1075.2.130  raeburn  9063: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041    www      9064:    LCprogressTxt=progresstext;
1.1075.2.130  raeburn  9065:    if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
                   9066:        \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
                   9067:    } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
                   9068:        \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
                   9069:    } else {
                   9070:        \$('#progressbar'+id).progressbar('value',percent);
                   9071:    }
1.1041    www      9072: }
                   9073: // ]]>
                   9074: </script>
                   9075: ENDPROGRESSUPDATE
                   9076: }
                   9077: 
1.1042    www      9078: my $LClastpercent;
1.1045    www      9079: my $LCidcnt;
                   9080: my $LCcurrentid;
1.1042    www      9081: 
1.1041    www      9082: sub LCprogressbar {
1.1075.2.130  raeburn  9083:     my ($r,$number_to_do,$preamble)=@_;
1.1042    www      9084:     $LClastpercent=0;
1.1045    www      9085:     $LCidcnt++;
                   9086:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1075.2.130  raeburn  9087:     my ($starting,$content);
                   9088:     if ($number_to_do) {
                   9089:         $starting=&mt('Starting');
                   9090:         $content=(<<ENDPROGBAR);
                   9091: $preamble
1.1045    www      9092:   <div id="progressbar$LCcurrentid">
1.1041    www      9093:     <span class="pblabel">$starting</span>
                   9094:   </div>
                   9095: ENDPROGBAR
1.1075.2.130  raeburn  9096:     } else {
                   9097:         $starting=&mt('Loading...');
                   9098:         $LClastpercent='false';
                   9099:         $content=(<<ENDPROGBAR);
                   9100: $preamble
                   9101:   <div id="progressbar$LCcurrentid">
                   9102:       <div class="progress-label">$starting</div>
                   9103:   </div>
                   9104: ENDPROGBAR
                   9105:     }
                   9106:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041    www      9107: }
                   9108: 
                   9109: sub LCprogressbarUpdate {
1.1075.2.130  raeburn  9110:     my ($r,$val,$text,$number_to_do)=@_;
                   9111:     if ($number_to_do) {
                   9112:         unless ($val) { 
                   9113:             if ($LClastpercent) {
                   9114:                 $val=$LClastpercent;
                   9115:             } else {
                   9116:                 $val=0;
                   9117:             }
                   9118:         }
                   9119:         if ($val<0) { $val=0; }
                   9120:         if ($val>100) { $val=0; }
                   9121:         $LClastpercent=$val;
                   9122:         unless ($text) { $text=$val.'%'; }
                   9123:     } else {
                   9124:         $val = 'false';
1.1042    www      9125:     }
1.1041    www      9126:     $text=&js_ready($text);
1.1044    www      9127:     &r_print($r,<<ENDUPDATE);
1.1041    www      9128: <script type="text/javascript">
                   9129: // <![CDATA[
1.1075.2.130  raeburn  9130: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041    www      9131: // ]]>
                   9132: </script>
                   9133: ENDUPDATE
1.1035    www      9134: }
                   9135: 
1.1042    www      9136: sub LCprogressbarClose {
                   9137:     my ($r)=@_;
                   9138:     $LClastpercent=0;
1.1044    www      9139:     &r_print($r,<<ENDCLOSE);
1.1042    www      9140: <script type="text/javascript">
                   9141: // <![CDATA[
1.1045    www      9142: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      9143: // ]]>
                   9144: </script>
                   9145: ENDCLOSE
1.1044    www      9146: }
                   9147: 
                   9148: sub r_print {
                   9149:     my ($r,$to_print)=@_;
                   9150:     if ($r) {
                   9151:       $r->print($to_print);
                   9152:       $r->rflush();
                   9153:     } else {
                   9154:       print($to_print);
                   9155:     }
1.1042    www      9156: }
                   9157: 
1.320     albertel 9158: sub html_encode {
                   9159:     my ($result) = @_;
                   9160: 
1.322     albertel 9161:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 9162:     
                   9163:     return $result;
                   9164: }
1.1044    www      9165: 
1.317     albertel 9166: sub js_ready {
                   9167:     my ($result) = @_;
                   9168: 
1.323     albertel 9169:     $result =~ s/[\n\r]/ /xmsg;
                   9170:     $result =~ s/\\/\\\\/xmsg;
                   9171:     $result =~ s/'/\\'/xmsg;
1.372     albertel 9172:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 9173:     
                   9174:     return $result;
                   9175: }
                   9176: 
1.315     albertel 9177: sub validate_page {
                   9178:     if (  exists($env{'internal.start_page'})
1.316     albertel 9179: 	  &&     $env{'internal.start_page'} > 1) {
                   9180: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 9181: 				 $env{'internal.start_page'}.' '.
1.316     albertel 9182: 				 $ENV{'request.filename'});
1.315     albertel 9183:     }
                   9184:     if (  exists($env{'internal.end_page'})
1.316     albertel 9185: 	  &&     $env{'internal.end_page'} > 1) {
                   9186: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 9187: 				 $env{'internal.end_page'}.' '.
1.316     albertel 9188: 				 $env{'request.filename'});
1.315     albertel 9189:     }
                   9190:     if (     exists($env{'internal.start_page'})
                   9191: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 9192: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   9193: 				 $env{'request.filename'});
1.315     albertel 9194:     }
                   9195:     if (   ! exists($env{'internal.start_page'})
                   9196: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 9197: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   9198: 				 $env{'request.filename'});
1.315     albertel 9199:     }
1.306     albertel 9200: }
1.315     albertel 9201: 
1.996     www      9202: 
                   9203: sub start_scrollbox {
1.1075.2.56  raeburn  9204:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  9205:     unless ($outerwidth) { $outerwidth='520px'; }
                   9206:     unless ($width) { $width='500px'; }
                   9207:     unless ($height) { $height='200px'; }
1.1075    raeburn  9208:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  9209:     if ($id ne '') {
1.1075.2.42  raeburn  9210:         $table_id = ' id="table_'.$id.'"';
                   9211:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  9212:     }
1.1075    raeburn  9213:     if ($bgcolor ne '') {
                   9214:         $tdcol = "background-color: $bgcolor;";
                   9215:     }
1.1075.2.42  raeburn  9216:     my $nicescroll_js;
                   9217:     if ($env{'browser.mobile'}) {
                   9218:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   9219:     }
1.1075    raeburn  9220:     return <<"END";
1.1075.2.42  raeburn  9221: $nicescroll_js
                   9222: 
                   9223: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
1.1075.2.56  raeburn  9224: <div style="overflow:auto; width:$width; height:$height;"$div_id>
1.1075    raeburn  9225: END
1.996     www      9226: }
                   9227: 
                   9228: sub end_scrollbox {
1.1036    www      9229:     return '</div></td></tr></table>';
1.996     www      9230: }
                   9231: 
1.1075.2.42  raeburn  9232: sub nicescroll_javascript {
                   9233:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   9234:     my %options;
                   9235:     if (ref($cursor) eq 'HASH') {
                   9236:         %options = %{$cursor};
                   9237:     }
                   9238:     unless ($options{'railalign'} =~ /^left|right$/) {
                   9239:         $options{'railalign'} = 'left';
                   9240:     }
                   9241:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   9242:         my $function  = &get_users_function();
                   9243:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
                   9244:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   9245:             $options{'cursorcolor'} = '#00F';
                   9246:         }
                   9247:     }
                   9248:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   9249:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
                   9250:             $options{'cursoropacity'}='1.0';
                   9251:         }
                   9252:     } else {
                   9253:         $options{'cursoropacity'}='1.0';
                   9254:     }
                   9255:     if ($options{'cursorfixedheight'} eq 'none') {
                   9256:         delete($options{'cursorfixedheight'});
                   9257:     } else {
                   9258:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   9259:     }
                   9260:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   9261:         delete($options{'railoffset'});
                   9262:     }
                   9263:     my @niceoptions;
                   9264:     while (my($key,$value) = each(%options)) {
                   9265:         if ($value =~ /^\{.+\}$/) {
                   9266:             push(@niceoptions,$key.':'.$value);
                   9267:         } else {
                   9268:             push(@niceoptions,$key.':"'.$value.'"');
                   9269:         }
                   9270:     }
                   9271:     my $nicescroll_js = '
                   9272: $(document).ready(
                   9273:       function() {
                   9274:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   9275:       }
                   9276: );
                   9277: ';
                   9278:     if ($framecheck) {
                   9279:         $nicescroll_js .= '
                   9280: function expand_div(caller) {
                   9281:     if (top === self) {
                   9282:         document.getElementById("'.$id.'").style.width = "auto";
                   9283:         document.getElementById("'.$id.'").style.height = "auto";
                   9284:     } else {
                   9285:         try {
                   9286:             if (parent.frames) {
                   9287:                 if (parent.frames.length > 1) {
                   9288:                     var framesrc = parent.frames[1].location.href;
                   9289:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   9290:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   9291:                         document.getElementById("'.$id.'").style.width = "auto";
                   9292:                         document.getElementById("'.$id.'").style.height = "auto";
                   9293:                     }
                   9294:                 }
                   9295:             }
                   9296:         } catch (e) {
                   9297:             return;
                   9298:         }
                   9299:     }
                   9300:     return;
                   9301: }
                   9302: ';
                   9303:     }
                   9304:     if ($needjsready) {
                   9305:         $nicescroll_js = '
                   9306: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   9307:     } else {
                   9308:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   9309:     }
                   9310:     return $nicescroll_js;
                   9311: }
                   9312: 
1.318     albertel 9313: sub simple_error_page {
1.1075.2.49  raeburn  9314:     my ($r,$title,$msg,$args) = @_;
                   9315:     if (ref($args) eq 'HASH') {
                   9316:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
                   9317:     } else {
                   9318:         $msg = &mt($msg);
                   9319:     }
                   9320: 
1.318     albertel 9321:     my $page =
                   9322: 	&Apache::loncommon::start_page($title).
1.1075.2.49  raeburn  9323: 	'<p class="LC_error">'.$msg.'</p>'.
1.318     albertel 9324: 	&Apache::loncommon::end_page();
                   9325:     if (ref($r)) {
                   9326: 	$r->print($page);
1.327     albertel 9327: 	return;
1.318     albertel 9328:     }
                   9329:     return $page;
                   9330: }
1.347     albertel 9331: 
                   9332: {
1.610     albertel 9333:     my @row_count;
1.961     onken    9334: 
                   9335:     sub start_data_table_count {
                   9336:         unshift(@row_count, 0);
                   9337:         return;
                   9338:     }
                   9339: 
                   9340:     sub end_data_table_count {
                   9341:         shift(@row_count);
                   9342:         return;
                   9343:     }
                   9344: 
1.347     albertel 9345:     sub start_data_table {
1.1018    raeburn  9346: 	my ($add_class,$id) = @_;
1.422     albertel 9347: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  9348:         my $table_id;
                   9349:         if (defined($id)) {
                   9350:             $table_id = ' id="'.$id.'"';
                   9351:         }
1.961     onken    9352: 	&start_data_table_count();
1.1018    raeburn  9353: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 9354:     }
                   9355: 
                   9356:     sub end_data_table {
1.961     onken    9357: 	&end_data_table_count();
1.389     albertel 9358: 	return '</table>'."\n";;
1.347     albertel 9359:     }
                   9360: 
                   9361:     sub start_data_table_row {
1.974     wenzelju 9362: 	my ($add_class, $id) = @_;
1.610     albertel 9363: 	$row_count[0]++;
                   9364: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   9365: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 9366:         $id = (' id="'.$id.'"') unless ($id eq '');
                   9367:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 9368:     }
1.471     banghart 9369:     
                   9370:     sub continue_data_table_row {
1.974     wenzelju 9371: 	my ($add_class, $id) = @_;
1.610     albertel 9372: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 9373: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   9374:         $id = (' id="'.$id.'"') unless ($id eq '');
                   9375:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 9376:     }
1.347     albertel 9377: 
                   9378:     sub end_data_table_row {
1.389     albertel 9379: 	return '</tr>'."\n";;
1.347     albertel 9380:     }
1.367     www      9381: 
1.421     albertel 9382:     sub start_data_table_empty_row {
1.707     bisitz   9383: #	$row_count[0]++;
1.421     albertel 9384: 	return  '<tr class="LC_empty_row" >'."\n";;
                   9385:     }
                   9386: 
                   9387:     sub end_data_table_empty_row {
                   9388: 	return '</tr>'."\n";;
                   9389:     }
                   9390: 
1.367     www      9391:     sub start_data_table_header_row {
1.389     albertel 9392: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      9393:     }
                   9394: 
                   9395:     sub end_data_table_header_row {
1.389     albertel 9396: 	return '</tr>'."\n";;
1.367     www      9397:     }
1.890     droeschl 9398: 
                   9399:     sub data_table_caption {
                   9400:         my $caption = shift;
                   9401:         return "<caption class=\"LC_caption\">$caption</caption>";
                   9402:     }
1.347     albertel 9403: }
                   9404: 
1.548     albertel 9405: =pod
                   9406: 
                   9407: =item * &inhibit_menu_check($arg)
                   9408: 
                   9409: Checks for a inhibitmenu state and generates output to preserve it
                   9410: 
                   9411: Inputs:         $arg - can be any of
                   9412:                      - undef - in which case the return value is a string 
                   9413:                                to add  into arguments list of a uri
                   9414:                      - 'input' - in which case the return value is a HTML
                   9415:                                  <form> <input> field of type hidden to
                   9416:                                  preserve the value
                   9417:                      - a url - in which case the return value is the url with
                   9418:                                the neccesary cgi args added to preserve the
                   9419:                                inhibitmenu state
                   9420:                      - a ref to a url - no return value, but the string is
                   9421:                                         updated to include the neccessary cgi
                   9422:                                         args to preserve the inhibitmenu state
                   9423: 
                   9424: =cut
                   9425: 
                   9426: sub inhibit_menu_check {
                   9427:     my ($arg) = @_;
                   9428:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   9429:     if ($arg eq 'input') {
                   9430: 	if ($env{'form.inhibitmenu'}) {
                   9431: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   9432: 	} else {
                   9433: 	    return
                   9434: 	}
                   9435:     }
                   9436:     if ($env{'form.inhibitmenu'}) {
                   9437: 	if (ref($arg)) {
                   9438: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9439: 	} elsif ($arg eq '') {
                   9440: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   9441: 	} else {
                   9442: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9443: 	}
                   9444:     }
                   9445:     if (!ref($arg)) {
                   9446: 	return $arg;
                   9447:     }
                   9448: }
                   9449: 
1.251     albertel 9450: ###############################################
1.182     matthew  9451: 
                   9452: =pod
                   9453: 
1.549     albertel 9454: =back
                   9455: 
                   9456: =head1 User Information Routines
                   9457: 
                   9458: =over 4
                   9459: 
1.405     albertel 9460: =item * &get_users_function()
1.182     matthew  9461: 
                   9462: Used by &bodytag to determine the current users primary role.
                   9463: Returns either 'student','coordinator','admin', or 'author'.
                   9464: 
                   9465: =cut
                   9466: 
                   9467: ###############################################
                   9468: sub get_users_function {
1.815     tempelho 9469:     my $function = 'norole';
1.818     tempelho 9470:     if ($env{'request.role'}=~/^(st)/) {
                   9471:         $function='student';
                   9472:     }
1.907     raeburn  9473:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  9474:         $function='coordinator';
                   9475:     }
1.258     albertel 9476:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  9477:         $function='admin';
                   9478:     }
1.826     bisitz   9479:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  9480:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  9481:         $function='author';
                   9482:     }
                   9483:     return $function;
1.54      www      9484: }
1.99      www      9485: 
                   9486: ###############################################
                   9487: 
1.233     raeburn  9488: =pod
                   9489: 
1.821     raeburn  9490: =item * &show_course()
                   9491: 
                   9492: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   9493: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   9494: 
                   9495: Inputs:
                   9496: None
                   9497: 
                   9498: Outputs:
                   9499: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   9500: 
                   9501: =cut
                   9502: 
                   9503: ###############################################
                   9504: sub show_course {
                   9505:     my $course = !$env{'user.adv'};
                   9506:     if (!$env{'user.adv'}) {
                   9507:         foreach my $env (keys(%env)) {
                   9508:             next if ($env !~ m/^user\.priv\./);
                   9509:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   9510:                 $course = 0;
                   9511:                 last;
                   9512:             }
                   9513:         }
                   9514:     }
                   9515:     return $course;
                   9516: }
                   9517: 
                   9518: ###############################################
                   9519: 
                   9520: =pod
                   9521: 
1.542     raeburn  9522: =item * &check_user_status()
1.274     raeburn  9523: 
                   9524: Determines current status of supplied role for a
                   9525: specific user. Roles can be active, previous or future.
                   9526: 
                   9527: Inputs: 
                   9528: user's domain, user's username, course's domain,
1.375     raeburn  9529: course's number, optional section ID.
1.274     raeburn  9530: 
                   9531: Outputs:
                   9532: role status: active, previous or future. 
                   9533: 
                   9534: =cut
                   9535: 
                   9536: sub check_user_status {
1.412     raeburn  9537:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  9538:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1075.2.85  raeburn  9539:     my @uroles = keys(%userinfo);
1.274     raeburn  9540:     my $srchstr;
                   9541:     my $active_chk = 'none';
1.412     raeburn  9542:     my $now = time;
1.274     raeburn  9543:     if (@uroles > 0) {
1.908     raeburn  9544:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  9545:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   9546:         } else {
1.412     raeburn  9547:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   9548:         }
                   9549:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  9550:             my $role_end = 0;
                   9551:             my $role_start = 0;
                   9552:             $active_chk = 'active';
1.412     raeburn  9553:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   9554:                 $role_end = $1;
                   9555:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   9556:                     $role_start = $1;
1.274     raeburn  9557:                 }
                   9558:             }
                   9559:             if ($role_start > 0) {
1.412     raeburn  9560:                 if ($now < $role_start) {
1.274     raeburn  9561:                     $active_chk = 'future';
                   9562:                 }
                   9563:             }
                   9564:             if ($role_end > 0) {
1.412     raeburn  9565:                 if ($now > $role_end) {
1.274     raeburn  9566:                     $active_chk = 'previous';
                   9567:                 }
                   9568:             }
                   9569:         }
                   9570:     }
                   9571:     return $active_chk;
                   9572: }
                   9573: 
                   9574: ###############################################
                   9575: 
                   9576: =pod
                   9577: 
1.405     albertel 9578: =item * &get_sections()
1.233     raeburn  9579: 
                   9580: Determines all the sections for a course including
                   9581: sections with students and sections containing other roles.
1.419     raeburn  9582: Incoming parameters: 
                   9583: 
                   9584: 1. domain
                   9585: 2. course number 
                   9586: 3. reference to array containing roles for which sections should 
                   9587: be gathered (optional).
                   9588: 4. reference to array containing status types for which sections 
                   9589: should be gathered (optional).
                   9590: 
                   9591: If the third argument is undefined, sections are gathered for any role. 
                   9592: If the fourth argument is undefined, sections are gathered for any status.
                   9593: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  9594:  
1.374     raeburn  9595: Returns section hash (keys are section IDs, values are
                   9596: number of users in each section), subject to the
1.419     raeburn  9597: optional roles filter, optional status filter 
1.233     raeburn  9598: 
                   9599: =cut
                   9600: 
                   9601: ###############################################
                   9602: sub get_sections {
1.419     raeburn  9603:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 9604:     if (!defined($cdom) || !defined($cnum)) {
                   9605:         my $cid =  $env{'request.course.id'};
                   9606: 
                   9607: 	return if (!defined($cid));
                   9608: 
                   9609:         $cdom = $env{'course.'.$cid.'.domain'};
                   9610:         $cnum = $env{'course.'.$cid.'.num'};
                   9611:     }
                   9612: 
                   9613:     my %sectioncount;
1.419     raeburn  9614:     my $now = time;
1.240     albertel 9615: 
1.1075.2.33  raeburn  9616:     my $check_students = 1;
                   9617:     my $only_students = 0;
                   9618:     if (ref($possible_roles) eq 'ARRAY') {
                   9619:         if (grep(/^st$/,@{$possible_roles})) {
                   9620:             if (@{$possible_roles} == 1) {
                   9621:                 $only_students = 1;
                   9622:             }
                   9623:         } else {
                   9624:             $check_students = 0;
                   9625:         }
                   9626:     }
                   9627: 
                   9628:     if ($check_students) {
1.276     albertel 9629: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 9630: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   9631: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  9632:         my $start_index = &Apache::loncoursedata::CL_START();
                   9633:         my $end_index = &Apache::loncoursedata::CL_END();
                   9634:         my $status;
1.366     albertel 9635: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  9636: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   9637: 				                     $data->[$status_index],
                   9638:                                                      $data->[$start_index],
                   9639:                                                      $data->[$end_index]);
                   9640:             if ($stu_status eq 'Active') {
                   9641:                 $status = 'active';
                   9642:             } elsif ($end < $now) {
                   9643:                 $status = 'previous';
                   9644:             } elsif ($start > $now) {
                   9645:                 $status = 'future';
                   9646:             } 
                   9647: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   9648:                 if ((!defined($possible_status)) || (($status ne '') && 
                   9649:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   9650: 		    $sectioncount{$section}++;
                   9651:                 }
1.240     albertel 9652: 	    }
                   9653: 	}
                   9654:     }
1.1075.2.33  raeburn  9655:     if ($only_students) {
                   9656:         return %sectioncount;
                   9657:     }
1.240     albertel 9658:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9659:     foreach my $user (sort(keys(%courseroles))) {
                   9660: 	if ($user !~ /^(\w{2})/) { next; }
                   9661: 	my ($role) = ($user =~ /^(\w{2})/);
                   9662: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  9663: 	my ($section,$status);
1.240     albertel 9664: 	if ($role eq 'cr' &&
                   9665: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   9666: 	    $section=$1;
                   9667: 	}
                   9668: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   9669: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  9670:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   9671:         if ($end == -1 && $start == -1) {
                   9672:             next; #deleted role
                   9673:         }
                   9674:         if (!defined($possible_status)) { 
                   9675:             $sectioncount{$section}++;
                   9676:         } else {
                   9677:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   9678:                 $status = 'active';
                   9679:             } elsif ($end < $now) {
                   9680:                 $status = 'future';
                   9681:             } elsif ($start > $now) {
                   9682:                 $status = 'previous';
                   9683:             }
                   9684:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   9685:                 $sectioncount{$section}++;
                   9686:             }
                   9687:         }
1.233     raeburn  9688:     }
1.366     albertel 9689:     return %sectioncount;
1.233     raeburn  9690: }
                   9691: 
1.274     raeburn  9692: ###############################################
1.294     raeburn  9693: 
                   9694: =pod
1.405     albertel 9695: 
                   9696: =item * &get_course_users()
                   9697: 
1.275     raeburn  9698: Retrieves usernames:domains for users in the specified course
                   9699: with specific role(s), and access status. 
                   9700: 
                   9701: Incoming parameters:
1.277     albertel 9702: 1. course domain
                   9703: 2. course number
                   9704: 3. access status: users must have - either active, 
1.275     raeburn  9705: previous, future, or all.
1.277     albertel 9706: 4. reference to array of permissible roles
1.288     raeburn  9707: 5. reference to array of section restrictions (optional)
                   9708: 6. reference to results object (hash of hashes).
                   9709: 7. reference to optional userdata hash
1.609     raeburn  9710: 8. reference to optional statushash
1.630     raeburn  9711: 9. flag if privileged users (except those set to unhide in
                   9712:    course settings) should be excluded    
1.609     raeburn  9713: Keys of top level results hash are roles.
1.275     raeburn  9714: Keys of inner hashes are username:domain, with 
                   9715: values set to access type.
1.288     raeburn  9716: Optional userdata hash returns an array with arguments in the 
                   9717: same order as loncoursedata::get_classlist() for student data.
                   9718: 
1.609     raeburn  9719: Optional statushash returns
                   9720: 
1.288     raeburn  9721: Entries for end, start, section and status are blank because
                   9722: of the possibility of multiple values for non-student roles.
                   9723: 
1.275     raeburn  9724: =cut
1.405     albertel 9725: 
1.275     raeburn  9726: ###############################################
1.405     albertel 9727: 
1.275     raeburn  9728: sub get_course_users {
1.630     raeburn  9729:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  9730:     my %idx = ();
1.419     raeburn  9731:     my %seclists;
1.288     raeburn  9732: 
                   9733:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   9734:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   9735:     $idx{end} = &Apache::loncoursedata::CL_END();
                   9736:     $idx{start} = &Apache::loncoursedata::CL_START();
                   9737:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   9738:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   9739:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   9740:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   9741: 
1.290     albertel 9742:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 9743:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  9744:         my $now = time;
1.277     albertel 9745:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  9746:             my $match = 0;
1.412     raeburn  9747:             my $secmatch = 0;
1.419     raeburn  9748:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  9749:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  9750:             if ($section eq '') {
                   9751:                 $section = 'none';
                   9752:             }
1.291     albertel 9753:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9754:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9755:                     $secmatch = 1;
                   9756:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 9757:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9758:                         $secmatch = 1;
                   9759:                     }
                   9760:                 } else {  
1.419     raeburn  9761: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  9762: 		        $secmatch = 1;
                   9763:                     }
1.290     albertel 9764: 		}
1.412     raeburn  9765:                 if (!$secmatch) {
                   9766:                     next;
                   9767:                 }
1.419     raeburn  9768:             }
1.275     raeburn  9769:             if (defined($$types{'active'})) {
1.288     raeburn  9770:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  9771:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  9772:                     $match = 1;
1.275     raeburn  9773:                 }
                   9774:             }
                   9775:             if (defined($$types{'previous'})) {
1.609     raeburn  9776:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  9777:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  9778:                     $match = 1;
1.275     raeburn  9779:                 }
                   9780:             }
                   9781:             if (defined($$types{'future'})) {
1.609     raeburn  9782:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  9783:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  9784:                     $match = 1;
1.275     raeburn  9785:                 }
                   9786:             }
1.609     raeburn  9787:             if ($match) {
                   9788:                 push(@{$seclists{$student}},$section);
                   9789:                 if (ref($userdata) eq 'HASH') {
                   9790:                     $$userdata{$student} = $$classlist{$student};
                   9791:                 }
                   9792:                 if (ref($statushash) eq 'HASH') {
                   9793:                     $statushash->{$student}{'st'}{$section} = $status;
                   9794:                 }
1.288     raeburn  9795:             }
1.275     raeburn  9796:         }
                   9797:     }
1.412     raeburn  9798:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  9799:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9800:         my $now = time;
1.609     raeburn  9801:         my %displaystatus = ( previous => 'Expired',
                   9802:                               active   => 'Active',
                   9803:                               future   => 'Future',
                   9804:                             );
1.1075.2.36  raeburn  9805:         my (%nothide,@possdoms);
1.630     raeburn  9806:         if ($hidepriv) {
                   9807:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   9808:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   9809:                 if ($user !~ /:/) {
                   9810:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   9811:                 } else {
                   9812:                     $nothide{$user} = 1;
                   9813:                 }
                   9814:             }
1.1075.2.36  raeburn  9815:             my @possdoms = ($cdom);
                   9816:             if ($coursehash{'checkforpriv'}) {
                   9817:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   9818:             }
1.630     raeburn  9819:         }
1.439     raeburn  9820:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  9821:             my $match = 0;
1.412     raeburn  9822:             my $secmatch = 0;
1.439     raeburn  9823:             my $status;
1.412     raeburn  9824:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  9825:             $user =~ s/:$//;
1.439     raeburn  9826:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   9827:             if ($end == -1 || $start == -1) {
                   9828:                 next;
                   9829:             }
                   9830:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   9831:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  9832:                 my ($uname,$udom) = split(/:/,$user);
                   9833:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9834:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9835:                         $secmatch = 1;
                   9836:                     } elsif ($usec eq '') {
1.420     albertel 9837:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9838:                             $secmatch = 1;
                   9839:                         }
                   9840:                     } else {
                   9841:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   9842:                             $secmatch = 1;
                   9843:                         }
                   9844:                     }
                   9845:                     if (!$secmatch) {
                   9846:                         next;
                   9847:                     }
1.288     raeburn  9848:                 }
1.419     raeburn  9849:                 if ($usec eq '') {
                   9850:                     $usec = 'none';
                   9851:                 }
1.275     raeburn  9852:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  9853:                     if ($hidepriv) {
1.1075.2.36  raeburn  9854:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  9855:                             (!$nothide{$uname.':'.$udom})) {
                   9856:                             next;
                   9857:                         }
                   9858:                     }
1.503     raeburn  9859:                     if ($end > 0 && $end < $now) {
1.439     raeburn  9860:                         $status = 'previous';
                   9861:                     } elsif ($start > $now) {
                   9862:                         $status = 'future';
                   9863:                     } else {
                   9864:                         $status = 'active';
                   9865:                     }
1.277     albertel 9866:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  9867:                         if ($status eq $type) {
1.420     albertel 9868:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  9869:                                 push(@{$$users{$role}{$user}},$type);
                   9870:                             }
1.288     raeburn  9871:                             $match = 1;
                   9872:                         }
                   9873:                     }
1.419     raeburn  9874:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   9875:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   9876: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   9877:                         }
1.420     albertel 9878:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  9879:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   9880:                         }
1.609     raeburn  9881:                         if (ref($statushash) eq 'HASH') {
                   9882:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   9883:                         }
1.275     raeburn  9884:                     }
                   9885:                 }
                   9886:             }
                   9887:         }
1.290     albertel 9888:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  9889:             if ((defined($cdom)) && (defined($cnum))) {
                   9890:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   9891:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   9892:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  9893:                     next if ($owner eq '');
                   9894:                     my ($ownername,$ownerdom);
                   9895:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   9896:                         $ownername = $1;
                   9897:                         $ownerdom = $2;
                   9898:                     } else {
                   9899:                         $ownername = $owner;
                   9900:                         $ownerdom = $cdom;
                   9901:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  9902:                     }
                   9903:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 9904:                     if (defined($userdata) && 
1.609     raeburn  9905: 			!exists($$userdata{$owner})) {
                   9906: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   9907:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   9908:                             push(@{$seclists{$owner}},'none');
                   9909:                         }
                   9910:                         if (ref($statushash) eq 'HASH') {
                   9911:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  9912:                         }
1.290     albertel 9913: 		    }
1.279     raeburn  9914:                 }
                   9915:             }
                   9916:         }
1.419     raeburn  9917:         foreach my $user (keys(%seclists)) {
                   9918:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   9919:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   9920:         }
1.275     raeburn  9921:     }
                   9922:     return;
                   9923: }
                   9924: 
1.288     raeburn  9925: sub get_user_info {
                   9926:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 9927:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   9928: 	&plainname($uname,$udom,'lastname');
1.291     albertel 9929:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  9930:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  9931:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   9932:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  9933:     return;
                   9934: }
1.275     raeburn  9935: 
1.472     raeburn  9936: ###############################################
                   9937: 
                   9938: =pod
                   9939: 
                   9940: =item * &get_user_quota()
                   9941: 
1.1075.2.41  raeburn  9942: Retrieves quota assigned for storage of user files.
                   9943: Default is to report quota for portfolio files.
1.472     raeburn  9944: 
                   9945: Incoming parameters:
                   9946: 1. user's username
                   9947: 2. user's domain
1.1075.2.41  raeburn  9948: 3. quota name - portfolio, author, or course
                   9949:    (if no quota name provided, defaults to portfolio).
1.1075.2.59  raeburn  9950: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1075.2.42  raeburn  9951:    course
1.472     raeburn  9952: 
                   9953: Returns:
1.1075.2.58  raeburn  9954: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  9955: 2. (Optional) Type of setting: custom or default
                   9956:    (individually assigned or default for user's 
                   9957:    institutional status).
                   9958: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   9959:    or student - types as defined in localenroll::inst_usertypes 
                   9960:    for user's domain, which determines default quota for user.
                   9961: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  9962: 
                   9963: If a value has been stored in the user's environment, 
1.536     raeburn  9964: it will return that, otherwise it returns the maximal default
1.1075.2.41  raeburn  9965: defined for the user's institutional status(es) in the domain.
1.472     raeburn  9966: 
                   9967: =cut
                   9968: 
                   9969: ###############################################
                   9970: 
                   9971: 
                   9972: sub get_user_quota {
1.1075.2.42  raeburn  9973:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  9974:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  9975:     if (!defined($udom)) {
                   9976:         $udom = $env{'user.domain'};
                   9977:     }
                   9978:     if (!defined($uname)) {
                   9979:         $uname = $env{'user.name'};
                   9980:     }
                   9981:     if (($udom eq '' || $uname eq '') ||
                   9982:         ($udom eq 'public') && ($uname eq 'public')) {
                   9983:         $quota = 0;
1.536     raeburn  9984:         $quotatype = 'default';
                   9985:         $defquota = 0; 
1.472     raeburn  9986:     } else {
1.536     raeburn  9987:         my $inststatus;
1.1075.2.41  raeburn  9988:         if ($quotaname eq 'course') {
                   9989:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   9990:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   9991:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   9992:             } else {
                   9993:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   9994:                 $quota = $cenv{'internal.uploadquota'};
                   9995:             }
1.536     raeburn  9996:         } else {
1.1075.2.41  raeburn  9997:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   9998:                 if ($quotaname eq 'author') {
                   9999:                     $quota = $env{'environment.authorquota'};
                   10000:                 } else {
                   10001:                     $quota = $env{'environment.portfolioquota'};
                   10002:                 }
                   10003:                 $inststatus = $env{'environment.inststatus'};
                   10004:             } else {
                   10005:                 my %userenv = 
                   10006:                     &Apache::lonnet::get('environment',['portfolioquota',
                   10007:                                          'authorquota','inststatus'],$udom,$uname);
                   10008:                 my ($tmp) = keys(%userenv);
                   10009:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10010:                     if ($quotaname eq 'author') {
                   10011:                         $quota = $userenv{'authorquota'};
                   10012:                     } else {
                   10013:                         $quota = $userenv{'portfolioquota'};
                   10014:                     }
                   10015:                     $inststatus = $userenv{'inststatus'};
                   10016:                 } else {
                   10017:                     undef(%userenv);
                   10018:                 }
                   10019:             }
                   10020:         }
                   10021:         if ($quota eq '' || wantarray) {
                   10022:             if ($quotaname eq 'course') {
                   10023:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1075.2.59  raeburn  10024:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
                   10025:                     ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1075.2.42  raeburn  10026:                     $defquota = $domdefs{$crstype.'quota'};
                   10027:                 }
                   10028:                 if ($defquota eq '') {
                   10029:                     $defquota = 500;
                   10030:                 }
1.1075.2.41  raeburn  10031:             } else {
                   10032:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   10033:             }
                   10034:             if ($quota eq '') {
                   10035:                 $quota = $defquota;
                   10036:                 $quotatype = 'default';
                   10037:             } else {
                   10038:                 $quotatype = 'custom';
                   10039:             }
1.472     raeburn  10040:         }
                   10041:     }
1.536     raeburn  10042:     if (wantarray) {
                   10043:         return ($quota,$quotatype,$settingstatus,$defquota);
                   10044:     } else {
                   10045:         return $quota;
                   10046:     }
1.472     raeburn  10047: }
                   10048: 
                   10049: ###############################################
                   10050: 
                   10051: =pod
                   10052: 
                   10053: =item * &default_quota()
                   10054: 
1.536     raeburn  10055: Retrieves default quota assigned for storage of user portfolio files,
                   10056: given an (optional) user's institutional status.
1.472     raeburn  10057: 
                   10058: Incoming parameters:
1.1075.2.42  raeburn  10059: 
1.472     raeburn  10060: 1. domain
1.536     raeburn  10061: 2. (Optional) institutional status(es).  This is a : separated list of 
                   10062:    status types (e.g., faculty, staff, student etc.)
                   10063:    which apply to the user for whom the default is being retrieved.
                   10064:    If the institutional status string in undefined, the domain
1.1075.2.41  raeburn  10065:    default quota will be returned.
                   10066: 3.  quota name - portfolio, author, or course
                   10067:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  10068: 
                   10069: Returns:
1.1075.2.42  raeburn  10070: 
1.1075.2.58  raeburn  10071: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  10072: 2. (Optional) institutional type which determined the value of the
                   10073:    default quota.
1.472     raeburn  10074: 
                   10075: If a value has been stored in the domain's configuration db,
                   10076: it will return that, otherwise it returns 20 (for backwards 
                   10077: compatibility with domains which have not set up a configuration
1.1075.2.58  raeburn  10078: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  10079: 
1.536     raeburn  10080: If the user's status includes multiple types (e.g., staff and student),
                   10081: the largest default quota which applies to the user determines the
                   10082: default quota returned.
                   10083: 
1.472     raeburn  10084: =cut
                   10085: 
                   10086: ###############################################
                   10087: 
                   10088: 
                   10089: sub default_quota {
1.1075.2.41  raeburn  10090:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  10091:     my ($defquota,$settingstatus);
                   10092:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  10093:                                             ['quotas'],$udom);
1.1075.2.41  raeburn  10094:     my $key = 'defaultquota';
                   10095:     if ($quotaname eq 'author') {
                   10096:         $key = 'authorquota';
                   10097:     }
1.622     raeburn  10098:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  10099:         if ($inststatus ne '') {
1.765     raeburn  10100:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  10101:             foreach my $item (@statuses) {
1.1075.2.41  raeburn  10102:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   10103:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  10104:                         if ($defquota eq '') {
1.1075.2.41  raeburn  10105:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  10106:                             $settingstatus = $item;
1.1075.2.41  raeburn  10107:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   10108:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  10109:                             $settingstatus = $item;
                   10110:                         }
                   10111:                     }
1.1075.2.41  raeburn  10112:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  10113:                     if ($quotahash{'quotas'}{$item} ne '') {
                   10114:                         if ($defquota eq '') {
                   10115:                             $defquota = $quotahash{'quotas'}{$item};
                   10116:                             $settingstatus = $item;
                   10117:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   10118:                             $defquota = $quotahash{'quotas'}{$item};
                   10119:                             $settingstatus = $item;
                   10120:                         }
1.536     raeburn  10121:                     }
                   10122:                 }
                   10123:             }
                   10124:         }
                   10125:         if ($defquota eq '') {
1.1075.2.41  raeburn  10126:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   10127:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   10128:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  10129:                 $defquota = $quotahash{'quotas'}{'default'};
                   10130:             }
1.536     raeburn  10131:             $settingstatus = 'default';
1.1075.2.42  raeburn  10132:             if ($defquota eq '') {
                   10133:                 if ($quotaname eq 'author') {
                   10134:                     $defquota = 500;
                   10135:                 }
                   10136:             }
1.536     raeburn  10137:         }
                   10138:     } else {
                   10139:         $settingstatus = 'default';
1.1075.2.41  raeburn  10140:         if ($quotaname eq 'author') {
                   10141:             $defquota = 500;
                   10142:         } else {
                   10143:             $defquota = 20;
                   10144:         }
1.536     raeburn  10145:     }
                   10146:     if (wantarray) {
                   10147:         return ($defquota,$settingstatus);
1.472     raeburn  10148:     } else {
1.536     raeburn  10149:         return $defquota;
1.472     raeburn  10150:     }
                   10151: }
                   10152: 
1.1075.2.41  raeburn  10153: ###############################################
                   10154: 
                   10155: =pod
                   10156: 
1.1075.2.42  raeburn  10157: =item * &excess_filesize_warning()
1.1075.2.41  raeburn  10158: 
                   10159: Returns warning message if upload of file to authoring space, or copying
1.1075.2.42  raeburn  10160: of existing file within authoring space will cause quota for the authoring
                   10161: space to be exceeded.
                   10162: 
                   10163: Same, if upload of a file directly to a course/community via Course Editor
                   10164: will cause quota for uploaded content for the course to be exceeded.
1.1075.2.41  raeburn  10165: 
1.1075.2.61  raeburn  10166: Inputs: 7 
1.1075.2.42  raeburn  10167: 1. username or coursenum
1.1075.2.41  raeburn  10168: 2. domain
1.1075.2.42  raeburn  10169: 3. context ('author' or 'course')
1.1075.2.41  raeburn  10170: 4. filename of file for which action is being requested
                   10171: 5. filesize (kB) of file
                   10172: 6. action being taken: copy or upload.
1.1075.2.59  raeburn  10173: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1075.2.41  raeburn  10174: 
                   10175: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
                   10176:          otherwise return null.
                   10177: 
1.1075.2.42  raeburn  10178: =back
                   10179: 
1.1075.2.41  raeburn  10180: =cut
                   10181: 
1.1075.2.42  raeburn  10182: sub excess_filesize_warning {
1.1075.2.59  raeburn  10183:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1075.2.42  raeburn  10184:     my $current_disk_usage = 0;
1.1075.2.59  raeburn  10185:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1075.2.42  raeburn  10186:     if ($context eq 'author') {
                   10187:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   10188:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   10189:     } else {
                   10190:         foreach my $subdir ('docs','supplemental') {
                   10191:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   10192:         }
                   10193:     }
1.1075.2.41  raeburn  10194:     $disk_quota = int($disk_quota * 1000);
                   10195:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1075.2.69  raeburn  10196:         return '<p class="LC_warning">'.
1.1075.2.41  raeburn  10197:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1075.2.69  raeburn  10198:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   10199:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1075.2.41  raeburn  10200:                             $disk_quota,$current_disk_usage).
                   10201:                '</p>';
                   10202:     }
                   10203:     return;
                   10204: }
                   10205: 
                   10206: ###############################################
                   10207: 
                   10208: 
1.384     raeburn  10209: sub get_secgrprole_info {
                   10210:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   10211:     my %sections_count = &get_sections($cdom,$cnum);
                   10212:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   10213:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   10214:     my @groups = sort(keys(%curr_groups));
                   10215:     my $allroles = [];
                   10216:     my $rolehash;
                   10217:     my $accesshash = {
                   10218:                      active => 'Currently has access',
                   10219:                      future => 'Will have future access',
                   10220:                      previous => 'Previously had access',
                   10221:                   };
                   10222:     if ($needroles) {
                   10223:         $rolehash = {'all' => 'all'};
1.385     albertel 10224:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   10225: 	if (&Apache::lonnet::error(%user_roles)) {
                   10226: 	    undef(%user_roles);
                   10227: 	}
                   10228:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  10229:             my ($role)=split(/\:/,$item,2);
                   10230:             if ($role eq 'cr') { next; }
                   10231:             if ($role =~ /^cr/) {
                   10232:                 $$rolehash{$role} = (split('/',$role))[3];
                   10233:             } else {
                   10234:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   10235:             }
                   10236:         }
                   10237:         foreach my $key (sort(keys(%{$rolehash}))) {
                   10238:             push(@{$allroles},$key);
                   10239:         }
                   10240:         push (@{$allroles},'st');
                   10241:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   10242:     }
                   10243:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   10244: }
                   10245: 
1.555     raeburn  10246: sub user_picker {
1.1075.2.127  raeburn  10247:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  10248:     my $currdom = $dom;
1.1075.2.114  raeburn  10249:     my @alldoms = &Apache::lonnet::all_domains();
                   10250:     if (@alldoms == 1) {
                   10251:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   10252:                                                ['directorysrch'],$alldoms[0]);
                   10253:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   10254:         my $showdom = $domdesc;
                   10255:         if ($showdom eq '') {
                   10256:             $showdom = $dom;
                   10257:         }
                   10258:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   10259:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   10260:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   10261:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   10262:             }
                   10263:         }
                   10264:     }
1.555     raeburn  10265:     my %curr_selected = (
                   10266:                         srchin => 'dom',
1.580     raeburn  10267:                         srchby => 'lastname',
1.555     raeburn  10268:                       );
                   10269:     my $srchterm;
1.625     raeburn  10270:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  10271:         if ($srch->{'srchby'} ne '') {
                   10272:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   10273:         }
                   10274:         if ($srch->{'srchin'} ne '') {
                   10275:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   10276:         }
                   10277:         if ($srch->{'srchtype'} ne '') {
                   10278:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   10279:         }
                   10280:         if ($srch->{'srchdomain'} ne '') {
                   10281:             $currdom = $srch->{'srchdomain'};
                   10282:         }
                   10283:         $srchterm = $srch->{'srchterm'};
                   10284:     }
1.1075.2.98  raeburn  10285:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  10286:                     'usr'       => 'Search criteria',
1.563     raeburn  10287:                     'doma'      => 'Domain/institution to search',
1.558     albertel 10288:                     'uname'     => 'username',
                   10289:                     'lastname'  => 'last name',
1.555     raeburn  10290:                     'lastfirst' => 'last name, first name',
1.558     albertel 10291:                     'crs'       => 'in this course',
1.576     raeburn  10292:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 10293:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  10294:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 10295:                     'exact'     => 'is',
                   10296:                     'contains'  => 'contains',
1.569     raeburn  10297:                     'begins'    => 'begins with',
1.1075.2.98  raeburn  10298:                                        );
                   10299:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  10300:                     'youm'      => "You must include some text to search for.",
                   10301:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   10302:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   10303:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   10304:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   10305:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   10306:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   10307:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  10308:                                        );
1.1075.2.98  raeburn  10309:     &html_escape(\%html_lt);
                   10310:     &js_escape(\%js_lt);
1.1075.2.115  raeburn  10311:     my $domform;
1.1075.2.126  raeburn  10312:     my $allow_blank = 1;
1.1075.2.115  raeburn  10313:     if ($fixeddom) {
1.1075.2.126  raeburn  10314:         $allow_blank = 0;
                   10315:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1075.2.115  raeburn  10316:     } else {
1.1075.2.126  raeburn  10317:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1);
1.1075.2.115  raeburn  10318:     }
1.563     raeburn  10319:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  10320: 
                   10321:     my @srchins = ('crs','dom','alc','instd');
                   10322: 
                   10323:     foreach my $option (@srchins) {
                   10324:         # FIXME 'alc' option unavailable until 
                   10325:         #       loncreateuser::print_user_query_page()
                   10326:         #       has been completed.
                   10327:         next if ($option eq 'alc');
1.880     raeburn  10328:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  10329:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1075.2.127  raeburn  10330:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  10331:         if ($curr_selected{'srchin'} eq $option) {
                   10332:             $srchinsel .= ' 
1.1075.2.98  raeburn  10333:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  10334:         } else {
                   10335:             $srchinsel .= '
1.1075.2.98  raeburn  10336:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  10337:         }
1.555     raeburn  10338:     }
1.563     raeburn  10339:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  10340: 
                   10341:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  10342:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  10343:         if ($curr_selected{'srchby'} eq $option) {
                   10344:             $srchbysel .= '
1.1075.2.98  raeburn  10345:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  10346:         } else {
                   10347:             $srchbysel .= '
1.1075.2.98  raeburn  10348:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  10349:          }
                   10350:     }
                   10351:     $srchbysel .= "\n  </select>\n";
                   10352: 
                   10353:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  10354:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  10355:         if ($curr_selected{'srchtype'} eq $option) {
                   10356:             $srchtypesel .= '
1.1075.2.98  raeburn  10357:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  10358:         } else {
                   10359:             $srchtypesel .= '
1.1075.2.98  raeburn  10360:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  10361:         }
                   10362:     }
                   10363:     $srchtypesel .= "\n  </select>\n";
                   10364: 
1.558     albertel 10365:     my ($newuserscript,$new_user_create);
1.994     raeburn  10366:     my $context_dom = $env{'request.role.domain'};
                   10367:     if ($context eq 'requestcrs') {
                   10368:         if ($env{'form.coursedom'} ne '') { 
                   10369:             $context_dom = $env{'form.coursedom'};
                   10370:         }
                   10371:     }
1.556     raeburn  10372:     if ($forcenewuser) {
1.576     raeburn  10373:         if (ref($srch) eq 'HASH') {
1.994     raeburn  10374:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  10375:                 if ($cancreate) {
                   10376:                     $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>';
                   10377:                 } else {
1.799     bisitz   10378:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  10379:                     my %usertypetext = (
                   10380:                         official   => 'institutional',
                   10381:                         unofficial => 'non-institutional',
                   10382:                     );
1.799     bisitz   10383:                     $new_user_create = '<p class="LC_warning">'
                   10384:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   10385:                                       .' '
                   10386:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   10387:                                           ,'<a href="'.$helplink.'">','</a>')
                   10388:                                       .'</p><br />';
1.627     raeburn  10389:                 }
1.576     raeburn  10390:             }
                   10391:         }
                   10392: 
1.556     raeburn  10393:         $newuserscript = <<"ENDSCRIPT";
                   10394: 
1.570     raeburn  10395: function setSearch(createnew,callingForm) {
1.556     raeburn  10396:     if (createnew == 1) {
1.570     raeburn  10397:         for (var i=0; i<callingForm.srchby.length; i++) {
                   10398:             if (callingForm.srchby.options[i].value == 'uname') {
                   10399:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  10400:             }
                   10401:         }
1.570     raeburn  10402:         for (var i=0; i<callingForm.srchin.length; i++) {
                   10403:             if ( callingForm.srchin.options[i].value == 'dom') {
                   10404: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  10405:             }
                   10406:         }
1.570     raeburn  10407:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   10408:             if (callingForm.srchtype.options[i].value == 'exact') {
                   10409:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  10410:             }
                   10411:         }
1.570     raeburn  10412:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  10413:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  10414:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  10415:             }
                   10416:         }
                   10417:     }
                   10418: }
                   10419: ENDSCRIPT
1.558     albertel 10420: 
1.556     raeburn  10421:     }
                   10422: 
1.555     raeburn  10423:     my $output = <<"END_BLOCK";
1.556     raeburn  10424: <script type="text/javascript">
1.824     bisitz   10425: // <![CDATA[
1.570     raeburn  10426: function validateEntry(callingForm) {
1.558     albertel 10427: 
1.556     raeburn  10428:     var checkok = 1;
1.558     albertel 10429:     var srchin;
1.570     raeburn  10430:     for (var i=0; i<callingForm.srchin.length; i++) {
                   10431: 	if ( callingForm.srchin[i].checked ) {
                   10432: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 10433: 	}
                   10434:     }
                   10435: 
1.570     raeburn  10436:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   10437:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   10438:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   10439:     var srchterm =  callingForm.srchterm.value;
                   10440:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  10441:     var msg = "";
                   10442: 
                   10443:     if (srchterm == "") {
                   10444:         checkok = 0;
1.1075.2.98  raeburn  10445:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  10446:     }
                   10447: 
1.569     raeburn  10448:     if (srchtype== 'begins') {
                   10449:         if (srchterm.length < 2) {
                   10450:             checkok = 0;
1.1075.2.98  raeburn  10451:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  10452:         }
                   10453:     }
                   10454: 
1.556     raeburn  10455:     if (srchtype== 'contains') {
                   10456:         if (srchterm.length < 3) {
                   10457:             checkok = 0;
1.1075.2.98  raeburn  10458:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  10459:         }
                   10460:     }
                   10461:     if (srchin == 'instd') {
                   10462:         if (srchdomain == '') {
                   10463:             checkok = 0;
1.1075.2.98  raeburn  10464:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  10465:         }
                   10466:     }
                   10467:     if (srchin == 'dom') {
                   10468:         if (srchdomain == '') {
                   10469:             checkok = 0;
1.1075.2.98  raeburn  10470:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  10471:         }
                   10472:     }
                   10473:     if (srchby == 'lastfirst') {
                   10474:         if (srchterm.indexOf(",") == -1) {
                   10475:             checkok = 0;
1.1075.2.98  raeburn  10476:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  10477:         }
                   10478:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   10479:             checkok = 0;
1.1075.2.98  raeburn  10480:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  10481:         }
                   10482:     }
                   10483:     if (checkok == 0) {
1.1075.2.98  raeburn  10484:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  10485:         return;
                   10486:     }
                   10487:     if (checkok == 1) {
1.570     raeburn  10488:         callingForm.submit();
1.556     raeburn  10489:     }
                   10490: }
                   10491: 
                   10492: $newuserscript
                   10493: 
1.824     bisitz   10494: // ]]>
1.556     raeburn  10495: </script>
1.558     albertel 10496: 
                   10497: $new_user_create
                   10498: 
1.555     raeburn  10499: END_BLOCK
1.558     albertel 10500: 
1.876     raeburn  10501:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1075.2.98  raeburn  10502:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  10503:                $domform.
                   10504:                &Apache::lonhtmlcommon::row_closure().
1.1075.2.98  raeburn  10505:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  10506:                $srchbysel.
                   10507:                $srchtypesel. 
                   10508:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   10509:                $srchinsel.
                   10510:                &Apache::lonhtmlcommon::row_closure(1). 
                   10511:                &Apache::lonhtmlcommon::end_pick_box().
                   10512:                '<br />';
1.1075.2.114  raeburn  10513:     return ($output,1);
1.555     raeburn  10514: }
                   10515: 
1.612     raeburn  10516: sub user_rule_check {
1.615     raeburn  10517:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1075.2.99  raeburn  10518:     my ($response,%inst_response);
1.612     raeburn  10519:     if (ref($usershash) eq 'HASH') {
1.1075.2.99  raeburn  10520:         if (keys(%{$usershash}) > 1) {
                   10521:             my (%by_username,%by_id,%userdoms);
                   10522:             my $checkid;
1.612     raeburn  10523:             if (ref($checks) eq 'HASH') {
1.1075.2.99  raeburn  10524:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   10525:                     $checkid = 1;
                   10526:                 }
                   10527:             }
                   10528:             foreach my $user (keys(%{$usershash})) {
                   10529:                 my ($uname,$udom) = split(/:/,$user);
                   10530:                 if ($checkid) {
                   10531:                     if (ref($usershash->{$user}) eq 'HASH') {
                   10532:                         if ($usershash->{$user}->{'id'} ne '') {
                   10533:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
                   10534:                             $userdoms{$udom} = 1;
                   10535:                             if (ref($inst_results) eq 'HASH') {
                   10536:                                 $inst_results->{$uname.':'.$udom} = {};
                   10537:                             }
                   10538:                         }
                   10539:                     }
                   10540:                 } else {
                   10541:                     $by_username{$udom}{$uname} = 1;
                   10542:                     $userdoms{$udom} = 1;
                   10543:                     if (ref($inst_results) eq 'HASH') {
                   10544:                         $inst_results->{$uname.':'.$udom} = {};
                   10545:                     }
                   10546:                 }
                   10547:             }
                   10548:             foreach my $udom (keys(%userdoms)) {
                   10549:                 if (!$got_rules->{$udom}) {
                   10550:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10551:                                                              ['usercreation'],$udom);
                   10552:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10553:                         foreach my $item ('username','id') {
                   10554:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10555:                                 $$curr_rules{$udom}{$item} =
                   10556:                                     $domconfig{'usercreation'}{$item.'_rule'};
                   10557:                             }
                   10558:                         }
                   10559:                     }
                   10560:                     $got_rules->{$udom} = 1;
                   10561:                 }
                   10562:             }
                   10563:             if ($checkid) {
                   10564:                 foreach my $udom (keys(%by_id)) {
                   10565:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   10566:                     if ($outcome eq 'ok') {
                   10567:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   10568:                             my $uname = $by_id{$udom}{$id};
                   10569:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10570:                         }
                   10571:                         if (ref($results) eq 'HASH') {
                   10572:                             foreach my $uname (keys(%{$results})) {
                   10573:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   10574:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   10575:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10576:                                 }
                   10577:                             }
                   10578:                         }
                   10579:                     }
1.612     raeburn  10580:                 }
1.615     raeburn  10581:             } else {
1.1075.2.99  raeburn  10582:                 foreach my $udom (keys(%by_username)) {
                   10583:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   10584:                     if ($outcome eq 'ok') {
                   10585:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   10586:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10587:                         }
                   10588:                         if (ref($results) eq 'HASH') {
                   10589:                             foreach my $uname (keys(%{$results})) {
                   10590:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10591:                             }
                   10592:                         }
                   10593:                     }
                   10594:                 }
1.612     raeburn  10595:             }
1.1075.2.99  raeburn  10596:         } elsif (keys(%{$usershash}) == 1) {
                   10597:             my $user = (keys(%{$usershash}))[0];
                   10598:             my ($uname,$udom) = split(/:/,$user);
                   10599:             if (($udom ne '') && ($uname ne '')) {
                   10600:                 if (ref($usershash->{$user}) eq 'HASH') {
                   10601:                     if (ref($checks) eq 'HASH') {
                   10602:                         if (defined($checks->{'username'})) {
                   10603:                             ($inst_response{$user},%{$inst_results->{$user}}) =
                   10604:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   10605:                         } elsif (defined($checks->{'id'})) {
                   10606:                             if ($usershash->{$user}->{'id'} ne '') {
                   10607:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10608:                                     &Apache::lonnet::get_instuser($udom,undef,
                   10609:                                                                   $usershash->{$user}->{'id'});
                   10610:                             } else {
                   10611:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10612:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   10613:                             }
                   10614:                         }
                   10615:                     } else {
                   10616:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   10617:                             &Apache::lonnet::get_instuser($udom,$uname);
                   10618:                        return;
                   10619:                     }
                   10620:                     if (!$got_rules->{$udom}) {
                   10621:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10622:                                                                  ['usercreation'],$udom);
                   10623:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10624:                             foreach my $item ('username','id') {
                   10625:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10626:                                    $$curr_rules{$udom}{$item} =
                   10627:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   10628:                                 }
                   10629:                             }
1.585     raeburn  10630:                         }
1.1075.2.99  raeburn  10631:                         $got_rules->{$udom} = 1;
1.585     raeburn  10632:                     }
                   10633:                 }
1.1075.2.99  raeburn  10634:             } else {
                   10635:                 return;
                   10636:             }
                   10637:         } else {
                   10638:             return;
                   10639:         }
                   10640:         foreach my $user (keys(%{$usershash})) {
                   10641:             my ($uname,$udom) = split(/:/,$user);
                   10642:             next if (($udom eq '') || ($uname eq ''));
                   10643:             my $id;
                   10644:             if (ref($inst_results) eq 'HASH') {
                   10645:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   10646:                     $id = $inst_results->{$user}->{'id'};
                   10647:                 }
                   10648:             }
                   10649:             if ($id eq '') {
                   10650:                 if (ref($usershash->{$user})) {
                   10651:                     $id = $usershash->{$user}->{'id'};
                   10652:                 }
1.585     raeburn  10653:             }
1.612     raeburn  10654:             foreach my $item (keys(%{$checks})) {
                   10655:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   10656:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   10657:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1075.2.99  raeburn  10658:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   10659:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  10660:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   10661:                                 if ($rule_check{$rule}) {
                   10662:                                     $$rulematch{$user}{$item} = $rule;
1.1075.2.99  raeburn  10663:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  10664:                                         if (ref($inst_results) eq 'HASH') {
                   10665:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   10666:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   10667:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1075.2.99  raeburn  10668:                                                 } elsif ($item eq 'id') {
                   10669:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   10670:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   10671:                                                     }
1.615     raeburn  10672:                                                 }
1.612     raeburn  10673:                                             }
                   10674:                                         }
1.615     raeburn  10675:                                     }
                   10676:                                     last;
1.585     raeburn  10677:                                 }
                   10678:                             }
                   10679:                         }
                   10680:                     }
                   10681:                 }
                   10682:             }
                   10683:         }
                   10684:     }
1.612     raeburn  10685:     return;
                   10686: }
                   10687: 
                   10688: sub user_rule_formats {
                   10689:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   10690:     my %text = ( 
                   10691:                  'username' => 'Usernames',
                   10692:                  'id'       => 'IDs',
                   10693:                );
                   10694:     my $output;
                   10695:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   10696:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   10697:         if (@{$ruleorder} > 0) {
1.1075.2.20  raeburn  10698:             $output = '<br />'.
                   10699:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   10700:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   10701:                       ' <ul>';
1.612     raeburn  10702:             foreach my $rule (@{$ruleorder}) {
                   10703:                 if (ref($curr_rules) eq 'ARRAY') {
                   10704:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   10705:                         if (ref($rules->{$rule}) eq 'HASH') {
                   10706:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   10707:                                         $rules->{$rule}{'desc'}.'</li>';
                   10708:                         }
                   10709:                     }
                   10710:                 }
                   10711:             }
                   10712:             $output .= '</ul>';
                   10713:         }
                   10714:     }
                   10715:     return $output;
                   10716: }
                   10717: 
                   10718: sub instrule_disallow_msg {
1.615     raeburn  10719:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  10720:     my $response;
                   10721:     my %text = (
                   10722:                   item   => 'username',
                   10723:                   items  => 'usernames',
                   10724:                   match  => 'matches',
                   10725:                   do     => 'does',
                   10726:                   action => 'a username',
                   10727:                   one    => 'one',
                   10728:                );
                   10729:     if ($count > 1) {
                   10730:         $text{'item'} = 'usernames';
                   10731:         $text{'match'} ='match';
                   10732:         $text{'do'} = 'do';
                   10733:         $text{'action'} = 'usernames',
                   10734:         $text{'one'} = 'ones';
                   10735:     }
                   10736:     if ($checkitem eq 'id') {
                   10737:         $text{'items'} = 'IDs';
                   10738:         $text{'item'} = 'ID';
                   10739:         $text{'action'} = 'an ID';
1.615     raeburn  10740:         if ($count > 1) {
                   10741:             $text{'item'} = 'IDs';
                   10742:             $text{'action'} = 'IDs';
                   10743:         }
1.612     raeburn  10744:     }
1.674     bisitz   10745:     $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  10746:     if ($mode eq 'upload') {
                   10747:         if ($checkitem eq 'username') {
                   10748:             $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'}.");
                   10749:         } elsif ($checkitem eq 'id') {
1.674     bisitz   10750:             $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  10751:         }
1.669     raeburn  10752:     } elsif ($mode eq 'selfcreate') {
                   10753:         if ($checkitem eq 'id') {
                   10754:             $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.");
                   10755:         }
1.615     raeburn  10756:     } else {
                   10757:         if ($checkitem eq 'username') {
                   10758:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   10759:         } elsif ($checkitem eq 'id') {
                   10760:             $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.");
                   10761:         }
1.612     raeburn  10762:     }
                   10763:     return $response;
1.585     raeburn  10764: }
                   10765: 
1.624     raeburn  10766: sub personal_data_fieldtitles {
                   10767:     my %fieldtitles = &Apache::lonlocal::texthash (
                   10768:                         id => 'Student/Employee ID',
                   10769:                         permanentemail => 'E-mail address',
                   10770:                         lastname => 'Last Name',
                   10771:                         firstname => 'First Name',
                   10772:                         middlename => 'Middle Name',
                   10773:                         generation => 'Generation',
                   10774:                         gen => 'Generation',
1.765     raeburn  10775:                         inststatus => 'Affiliation',
1.624     raeburn  10776:                    );
                   10777:     return %fieldtitles;
                   10778: }
                   10779: 
1.642     raeburn  10780: sub sorted_inst_types {
                   10781:     my ($dom) = @_;
1.1075.2.70  raeburn  10782:     my ($usertypes,$order);
                   10783:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   10784:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   10785:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   10786:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   10787:     } else {
                   10788:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   10789:     }
1.642     raeburn  10790:     my $othertitle = &mt('All users');
                   10791:     if ($env{'request.course.id'}) {
1.668     raeburn  10792:         $othertitle  = &mt('Any users');
1.642     raeburn  10793:     }
                   10794:     my @types;
                   10795:     if (ref($order) eq 'ARRAY') {
                   10796:         @types = @{$order};
                   10797:     }
                   10798:     if (@types == 0) {
                   10799:         if (ref($usertypes) eq 'HASH') {
                   10800:             @types = sort(keys(%{$usertypes}));
                   10801:         }
                   10802:     }
                   10803:     if (keys(%{$usertypes}) > 0) {
                   10804:         $othertitle = &mt('Other users');
                   10805:     }
                   10806:     return ($othertitle,$usertypes,\@types);
                   10807: }
                   10808: 
1.645     raeburn  10809: sub get_institutional_codes {
1.1075.2.157  raeburn  10810:     my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645     raeburn  10811: # Get complete list of course sections to update
                   10812:     my @currsections = ();
                   10813:     my @currxlists = ();
1.1075.2.157  raeburn  10814:     my (%unclutteredsec,%unclutteredlcsec);
1.645     raeburn  10815:     my $coursecode = $$settings{'internal.coursecode'};
1.1075.2.157  raeburn  10816:     my $crskey = $crs.':'.$coursecode;
                   10817:     @{$unclutteredsec{$crskey}} = ();
                   10818:     @{$unclutteredlcsec{$crskey}} = ();
1.645     raeburn  10819: 
                   10820:     if ($$settings{'internal.sectionnums'} ne '') {
                   10821:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   10822:     }
                   10823: 
                   10824:     if ($$settings{'internal.crosslistings'} ne '') {
                   10825:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   10826:     }
                   10827: 
                   10828:     if (@currxlists > 0) {
1.1075.2.157  raeburn  10829:         foreach my $xl (@currxlists) {
                   10830:             if ($xl =~ /^([^:]+):(\w*)$/) {
1.645     raeburn  10831:                 unless (grep/^$1$/,@{$allcourses}) {
1.1075.2.119  raeburn  10832:                     push(@{$allcourses},$1);
1.645     raeburn  10833:                     $$LC_code{$1} = $2;
                   10834:                 }
                   10835:             }
                   10836:         }
                   10837:     }
1.1075.2.157  raeburn  10838: 
1.645     raeburn  10839:     if (@currsections > 0) {
1.1075.2.157  raeburn  10840:         foreach my $sec (@currsections) {
                   10841:             if ($sec =~ m/^(\w+):(\w*)$/ ) {
                   10842:                 my $instsec = $1;
1.645     raeburn  10843:                 my $lc_sec = $2;
1.1075.2.157  raeburn  10844:                 unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
                   10845:                     push(@{$unclutteredsec{$crskey}},$instsec);
                   10846:                     push(@{$unclutteredlcsec{$crskey}},$lc_sec);
                   10847:                 }
                   10848:             }
                   10849:         }
                   10850:     }
                   10851: 
                   10852:     if (@{$unclutteredsec{$crskey}} > 0) {
                   10853:         my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
                   10854:         if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
                   10855:             for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
                   10856:                 my $sec = $coursecode.$formattedsec{$crskey}[$i];
                   10857:                 unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1075.2.119  raeburn  10858:                     push(@{$allcourses},$sec);
1.1075.2.157  raeburn  10859:                     $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645     raeburn  10860:                 }
                   10861:             }
                   10862:         }
                   10863:     }
                   10864:     return;
                   10865: }
                   10866: 
1.971     raeburn  10867: sub get_standard_codeitems {
                   10868:     return ('Year','Semester','Department','Number','Section');
                   10869: }
                   10870: 
1.112     bowersj2 10871: =pod
                   10872: 
1.780     raeburn  10873: =head1 Slot Helpers
                   10874: 
                   10875: =over 4
                   10876: 
                   10877: =item * sorted_slots()
                   10878: 
1.1040    raeburn  10879: Sorts an array of slot names in order of an optional sort key,
                   10880: default sort is by slot start time (earliest first). 
1.780     raeburn  10881: 
                   10882: Inputs:
                   10883: 
                   10884: =over 4
                   10885: 
                   10886: slotsarr  - Reference to array of unsorted slot names.
                   10887: 
                   10888: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   10889: 
1.1040    raeburn  10890: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   10891: 
1.549     albertel 10892: =back
                   10893: 
1.780     raeburn  10894: Returns:
                   10895: 
                   10896: =over 4
                   10897: 
1.1040    raeburn  10898: sorted   - An array of slot names sorted by a specified sort key 
                   10899:            (default sort key is start time of the slot).
1.780     raeburn  10900: 
                   10901: =back
                   10902: 
                   10903: =cut
                   10904: 
                   10905: 
                   10906: sub sorted_slots {
1.1040    raeburn  10907:     my ($slotsarr,$slots,$sortkey) = @_;
                   10908:     if ($sortkey eq '') {
                   10909:         $sortkey = 'starttime';
                   10910:     }
1.780     raeburn  10911:     my @sorted;
                   10912:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   10913:         @sorted =
                   10914:             sort {
                   10915:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  10916:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  10917:                      }
                   10918:                      if (ref($slots->{$a})) { return -1;}
                   10919:                      if (ref($slots->{$b})) { return 1;}
                   10920:                      return 0;
                   10921:                  } @{$slotsarr};
                   10922:     }
                   10923:     return @sorted;
                   10924: }
                   10925: 
1.1040    raeburn  10926: =pod
                   10927: 
                   10928: =item * get_future_slots()
                   10929: 
                   10930: Inputs:
                   10931: 
                   10932: =over 4
                   10933: 
                   10934: cnum - course number
                   10935: 
                   10936: cdom - course domain
                   10937: 
                   10938: now - current UNIX time
                   10939: 
                   10940: symb - optional symb
                   10941: 
                   10942: =back
                   10943: 
                   10944: Returns:
                   10945: 
                   10946: =over 4
                   10947: 
                   10948: sorted_reservable - ref to array of student_schedulable slots currently 
                   10949:                     reservable, ordered by end date of reservation period.
                   10950: 
                   10951: reservable_now - ref to hash of student_schedulable slots currently
                   10952:                  reservable.
                   10953: 
                   10954:     Keys in inner hash are:
                   10955:     (a) symb: either blank or symb to which slot use is restricted.
1.1075.2.104  raeburn  10956:     (b) endreserve: end date of reservation period.
                   10957:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10958:         selected.
1.1040    raeburn  10959: 
                   10960: sorted_future - ref to array of student_schedulable slots reservable in
                   10961:                 the future, ordered by start date of reservation period.
                   10962: 
                   10963: future_reservable - ref to hash of student_schedulable slots reservable
                   10964:                     in the future.
                   10965: 
                   10966:     Keys in inner hash are:
                   10967:     (a) symb: either blank or symb to which slot use is restricted.
                   10968:     (b) startreserve:  start date of reservation period.
1.1075.2.104  raeburn  10969:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10970:         selected.
1.1040    raeburn  10971: 
                   10972: =back
                   10973: 
                   10974: =cut
                   10975: 
                   10976: sub get_future_slots {
                   10977:     my ($cnum,$cdom,$now,$symb) = @_;
                   10978:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   10979:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   10980:     foreach my $slot (keys(%slots)) {
                   10981:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   10982:         if ($symb) {
                   10983:             next if (($slots{$slot}->{'symb'} ne '') && 
                   10984:                      ($slots{$slot}->{'symb'} ne $symb));
                   10985:         }
                   10986:         if (($slots{$slot}->{'starttime'} > $now) &&
                   10987:             ($slots{$slot}->{'endtime'} > $now)) {
                   10988:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   10989:                 my $userallowed = 0;
                   10990:                 if ($slots{$slot}->{'allowedsections'}) {
                   10991:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   10992:                     if (!defined($env{'request.role.sec'})
                   10993:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   10994:                         $userallowed=1;
                   10995:                     } else {
                   10996:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   10997:                             $userallowed=1;
                   10998:                         }
                   10999:                     }
                   11000:                     unless ($userallowed) {
                   11001:                         if (defined($env{'request.course.groups'})) {
                   11002:                             my @groups = split(/:/,$env{'request.course.groups'});
                   11003:                             foreach my $group (@groups) {
                   11004:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   11005:                                     $userallowed=1;
                   11006:                                     last;
                   11007:                                 }
                   11008:                             }
                   11009:                         }
                   11010:                     }
                   11011:                 }
                   11012:                 if ($slots{$slot}->{'allowedusers'}) {
                   11013:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   11014:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   11015:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   11016:                         $userallowed = 1;
                   11017:                     }
                   11018:                 }
                   11019:                 next unless($userallowed);
                   11020:             }
                   11021:             my $startreserve = $slots{$slot}->{'startreserve'};
                   11022:             my $endreserve = $slots{$slot}->{'endreserve'};
                   11023:             my $symb = $slots{$slot}->{'symb'};
1.1075.2.104  raeburn  11024:             my $uniqueperiod;
                   11025:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   11026:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   11027:             }
1.1040    raeburn  11028:             if (($startreserve < $now) &&
                   11029:                 (!$endreserve || $endreserve > $now)) {
                   11030:                 my $lastres = $endreserve;
                   11031:                 if (!$lastres) {
                   11032:                     $lastres = $slots{$slot}->{'starttime'};
                   11033:                 }
                   11034:                 $reservable_now{$slot} = {
                   11035:                                            symb       => $symb,
1.1075.2.104  raeburn  11036:                                            endreserve => $lastres,
                   11037:                                            uniqueperiod => $uniqueperiod,   
1.1040    raeburn  11038:                                          };
                   11039:             } elsif (($startreserve > $now) &&
                   11040:                      (!$endreserve || $endreserve > $startreserve)) {
                   11041:                 $future_reservable{$slot} = {
                   11042:                                               symb         => $symb,
1.1075.2.104  raeburn  11043:                                               startreserve => $startreserve,
                   11044:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  11045:                                             };
                   11046:             }
                   11047:         }
                   11048:     }
                   11049:     my @unsorted_reservable = keys(%reservable_now);
                   11050:     if (@unsorted_reservable > 0) {
                   11051:         @sorted_reservable = 
                   11052:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   11053:     }
                   11054:     my @unsorted_future = keys(%future_reservable);
                   11055:     if (@unsorted_future > 0) {
                   11056:         @sorted_future =
                   11057:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   11058:     }
                   11059:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   11060: }
1.780     raeburn  11061: 
                   11062: =pod
                   11063: 
1.1057    foxr     11064: =back
                   11065: 
1.549     albertel 11066: =head1 HTTP Helpers
                   11067: 
                   11068: =over 4
                   11069: 
1.648     raeburn  11070: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 11071: 
1.258     albertel 11072: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 11073: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 11074: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 11075: 
                   11076: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   11077: $possible_names is an ref to an array of form element names.  As an example:
                   11078: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 11079: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 11080: 
                   11081: =cut
1.1       albertel 11082: 
1.6       albertel 11083: sub get_unprocessed_cgi {
1.25      albertel 11084:   my ($query,$possible_names)= @_;
1.26      matthew  11085:   # $Apache::lonxml::debug=1;
1.356     albertel 11086:   foreach my $pair (split(/&/,$query)) {
                   11087:     my ($name, $value) = split(/=/,$pair);
1.369     www      11088:     $name = &unescape($name);
1.25      albertel 11089:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   11090:       $value =~ tr/+/ /;
                   11091:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 11092:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 11093:     }
1.16      harris41 11094:   }
1.6       albertel 11095: }
                   11096: 
1.112     bowersj2 11097: =pod
                   11098: 
1.648     raeburn  11099: =item * &cacheheader() 
1.112     bowersj2 11100: 
                   11101: returns cache-controlling header code
                   11102: 
                   11103: =cut
                   11104: 
1.7       albertel 11105: sub cacheheader {
1.258     albertel 11106:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 11107:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   11108:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 11109:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   11110:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 11111:     return $output;
1.7       albertel 11112: }
                   11113: 
1.112     bowersj2 11114: =pod
                   11115: 
1.648     raeburn  11116: =item * &no_cache($r) 
1.112     bowersj2 11117: 
                   11118: specifies header code to not have cache
                   11119: 
                   11120: =cut
                   11121: 
1.9       albertel 11122: sub no_cache {
1.216     albertel 11123:     my ($r) = @_;
                   11124:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 11125: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 11126:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   11127:     $r->no_cache(1);
                   11128:     $r->header_out("Expires" => $date);
                   11129:     $r->header_out("Pragma" => "no-cache");
1.123     www      11130: }
                   11131: 
                   11132: sub content_type {
1.181     albertel 11133:     my ($r,$type,$charset) = @_;
1.299     foxr     11134:     if ($r) {
                   11135: 	#  Note that printout.pl calls this with undef for $r.
                   11136: 	&no_cache($r);
                   11137:     }
1.258     albertel 11138:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 11139:     unless ($charset) {
                   11140: 	$charset=&Apache::lonlocal::current_encoding;
                   11141:     }
                   11142:     if ($charset) { $type.='; charset='.$charset; }
                   11143:     if ($r) {
                   11144: 	$r->content_type($type);
                   11145:     } else {
                   11146: 	print("Content-type: $type\n\n");
                   11147:     }
1.9       albertel 11148: }
1.25      albertel 11149: 
1.112     bowersj2 11150: =pod
                   11151: 
1.648     raeburn  11152: =item * &add_to_env($name,$value) 
1.112     bowersj2 11153: 
1.258     albertel 11154: adds $name to the %env hash with value
1.112     bowersj2 11155: $value, if $name already exists, the entry is converted to an array
                   11156: reference and $value is added to the array.
                   11157: 
                   11158: =cut
                   11159: 
1.25      albertel 11160: sub add_to_env {
                   11161:   my ($name,$value)=@_;
1.258     albertel 11162:   if (defined($env{$name})) {
                   11163:     if (ref($env{$name})) {
1.25      albertel 11164:       #already have multiple values
1.258     albertel 11165:       push(@{ $env{$name} },$value);
1.25      albertel 11166:     } else {
                   11167:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 11168:       my $first=$env{$name};
                   11169:       undef($env{$name});
                   11170:       push(@{ $env{$name} },$first,$value);
1.25      albertel 11171:     }
                   11172:   } else {
1.258     albertel 11173:     $env{$name}=$value;
1.25      albertel 11174:   }
1.31      albertel 11175: }
1.149     albertel 11176: 
                   11177: =pod
                   11178: 
1.648     raeburn  11179: =item * &get_env_multiple($name) 
1.149     albertel 11180: 
1.258     albertel 11181: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 11182: values may be defined and end up as an array ref.
                   11183: 
                   11184: returns an array of values
                   11185: 
                   11186: =cut
                   11187: 
                   11188: sub get_env_multiple {
                   11189:     my ($name) = @_;
                   11190:     my @values;
1.258     albertel 11191:     if (defined($env{$name})) {
1.149     albertel 11192:         # exists is it an array
1.258     albertel 11193:         if (ref($env{$name})) {
                   11194:             @values=@{ $env{$name} };
1.149     albertel 11195:         } else {
1.258     albertel 11196:             $values[0]=$env{$name};
1.149     albertel 11197:         }
                   11198:     }
                   11199:     return(@values);
                   11200: }
                   11201: 
1.660     raeburn  11202: sub ask_for_embedded_content {
                   11203:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  11204:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11  raeburn  11205:         %currsubfile,%unused,$rem);
1.1071    raeburn  11206:     my $counter = 0;
                   11207:     my $numnew = 0;
1.987     raeburn  11208:     my $numremref = 0;
                   11209:     my $numinvalid = 0;
                   11210:     my $numpathchg = 0;
                   11211:     my $numexisting = 0;
1.1071    raeburn  11212:     my $numunused = 0;
                   11213:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1075.2.53  raeburn  11214:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  11215:     my $heading = &mt('Upload embedded files');
                   11216:     my $buttontext = &mt('Upload');
                   11217: 
1.1075.2.11  raeburn  11218:     if ($env{'request.course.id'}) {
1.1075.2.35  raeburn  11219:         if ($actionurl eq '/adm/dependencies') {
                   11220:             $navmap = Apache::lonnavmaps::navmap->new();
                   11221:         }
                   11222:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   11223:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11  raeburn  11224:     }
1.1075.2.35  raeburn  11225:     if (($actionurl eq '/adm/portfolio') ||
                   11226:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  11227:         my $current_path='/';
                   11228:         if ($env{'form.currentpath'}) {
                   11229:             $current_path = $env{'form.currentpath'};
                   11230:         }
                   11231:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35  raeburn  11232:             $udom = $cdom;
                   11233:             $uname = $cnum;
1.984     raeburn  11234:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   11235:         } else {
                   11236:             $udom = $env{'user.domain'};
                   11237:             $uname = $env{'user.name'};
                   11238:             $url = '/userfiles/portfolio';
                   11239:         }
1.987     raeburn  11240:         $toplevel = $url.'/';
1.984     raeburn  11241:         $url .= $current_path;
                   11242:         $getpropath = 1;
1.987     raeburn  11243:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   11244:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      11245:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  11246:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  11247:         $toplevel = $url;
1.984     raeburn  11248:         if ($rest ne '') {
1.987     raeburn  11249:             $url .= $rest;
                   11250:         }
                   11251:     } elsif ($actionurl eq '/adm/coursedocs') {
                   11252:         if (ref($args) eq 'HASH') {
1.1071    raeburn  11253:             $url = $args->{'docs_url'};
                   11254:             $toplevel = $url;
1.1075.2.11  raeburn  11255:             if ($args->{'context'} eq 'paste') {
                   11256:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   11257:                 ($path) =
                   11258:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   11259:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   11260:                 $fileloc =~ s{^/}{};
                   11261:             }
1.1071    raeburn  11262:         }
                   11263:     } elsif ($actionurl eq '/adm/dependencies') {
                   11264:         if ($env{'request.course.id'} ne '') {
                   11265:             if (ref($args) eq 'HASH') {
                   11266:                 $url = $args->{'docs_url'};
                   11267:                 $title = $args->{'docs_title'};
1.1075.2.35  raeburn  11268:                 $toplevel = $url;
                   11269:                 unless ($toplevel =~ m{^/}) {
                   11270:                     $toplevel = "/$url";
                   11271:                 }
1.1075.2.11  raeburn  11272:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35  raeburn  11273:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   11274:                     $path = $1;
                   11275:                 } else {
                   11276:                     ($path) =
                   11277:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   11278:                 }
1.1075.2.79  raeburn  11279:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   11280:                     $fileloc = $toplevel;
                   11281:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   11282:                     my ($udom,$uname,$fname) =
                   11283:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   11284:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   11285:                 } else {
                   11286:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   11287:                 }
1.1071    raeburn  11288:                 $fileloc =~ s{^/}{};
                   11289:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   11290:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   11291:             }
1.987     raeburn  11292:         }
1.1075.2.35  raeburn  11293:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   11294:         $udom = $cdom;
                   11295:         $uname = $cnum;
                   11296:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   11297:         $toplevel = $url;
                   11298:         $path = $url;
                   11299:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   11300:         $fileloc =~ s{^/}{};
                   11301:     }
                   11302:     foreach my $file (keys(%{$allfiles})) {
                   11303:         my $embed_file;
                   11304:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   11305:             $embed_file = $1;
                   11306:         } else {
                   11307:             $embed_file = $file;
                   11308:         }
1.1075.2.55  raeburn  11309:         my ($absolutepath,$cleaned_file);
                   11310:         if ($embed_file =~ m{^\w+://}) {
                   11311:             $cleaned_file = $embed_file;
1.1075.2.47  raeburn  11312:             $newfiles{$cleaned_file} = 1;
                   11313:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  11314:         } else {
1.1075.2.55  raeburn  11315:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  11316:             if ($embed_file =~ m{^/}) {
                   11317:                 $absolutepath = $embed_file;
                   11318:             }
1.1075.2.47  raeburn  11319:             if ($cleaned_file =~ m{/}) {
                   11320:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  11321:                 $path = &check_for_traversal($path,$url,$toplevel);
                   11322:                 my $item = $fname;
                   11323:                 if ($path ne '') {
                   11324:                     $item = $path.'/'.$fname;
                   11325:                     $subdependencies{$path}{$fname} = 1;
                   11326:                 } else {
                   11327:                     $dependencies{$item} = 1;
                   11328:                 }
                   11329:                 if ($absolutepath) {
                   11330:                     $mapping{$item} = $absolutepath;
                   11331:                 } else {
                   11332:                     $mapping{$item} = $embed_file;
                   11333:                 }
                   11334:             } else {
                   11335:                 $dependencies{$embed_file} = 1;
                   11336:                 if ($absolutepath) {
1.1075.2.47  raeburn  11337:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  11338:                 } else {
1.1075.2.47  raeburn  11339:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  11340:                 }
                   11341:             }
1.984     raeburn  11342:         }
                   11343:     }
1.1071    raeburn  11344:     my $dirptr = 16384;
1.984     raeburn  11345:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  11346:         $currsubfile{$path} = {};
1.1075.2.35  raeburn  11347:         if (($actionurl eq '/adm/portfolio') ||
                   11348:             ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  11349:             my ($sublistref,$listerror) =
                   11350:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   11351:             if (ref($sublistref) eq 'ARRAY') {
                   11352:                 foreach my $line (@{$sublistref}) {
                   11353:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  11354:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  11355:                 }
1.984     raeburn  11356:             }
1.987     raeburn  11357:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11358:             if (opendir(my $dir,$url.'/'.$path)) {
                   11359:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  11360:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   11361:             }
1.1075.2.11  raeburn  11362:         } elsif (($actionurl eq '/adm/dependencies') ||
                   11363:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11364:                   ($args->{'context'} eq 'paste')) ||
                   11365:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11366:             if ($env{'request.course.id'} ne '') {
1.1075.2.35  raeburn  11367:                 my $dir;
                   11368:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   11369:                     $dir = $fileloc;
                   11370:                 } else {
                   11371:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11372:                 }
1.1071    raeburn  11373:                 if ($dir ne '') {
                   11374:                     my ($sublistref,$listerror) =
                   11375:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   11376:                     if (ref($sublistref) eq 'ARRAY') {
                   11377:                         foreach my $line (@{$sublistref}) {
                   11378:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   11379:                                 undef,$mtime)=split(/\&/,$line,12);
                   11380:                             unless (($testdir&$dirptr) ||
                   11381:                                     ($file_name =~ /^\.\.?$/)) {
                   11382:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   11383:                             }
                   11384:                         }
                   11385:                     }
                   11386:                 }
1.984     raeburn  11387:             }
                   11388:         }
                   11389:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  11390:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  11391:                 my $item = $path.'/'.$file;
                   11392:                 unless ($mapping{$item} eq $item) {
                   11393:                     $pathchanges{$item} = 1;
                   11394:                 }
                   11395:                 $existing{$item} = 1;
                   11396:                 $numexisting ++;
                   11397:             } else {
                   11398:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  11399:             }
                   11400:         }
1.1071    raeburn  11401:         if ($actionurl eq '/adm/dependencies') {
                   11402:             foreach my $path (keys(%currsubfile)) {
                   11403:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   11404:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   11405:                          unless ($subdependencies{$path}{$file}) {
1.1075.2.11  raeburn  11406:                              next if (($rem ne '') &&
                   11407:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   11408:                                        (ref($navmap) &&
                   11409:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   11410:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11411:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  11412:                              $unused{$path.'/'.$file} = 1; 
                   11413:                          }
                   11414:                     }
                   11415:                 }
                   11416:             }
                   11417:         }
1.984     raeburn  11418:     }
1.987     raeburn  11419:     my %currfile;
1.1075.2.35  raeburn  11420:     if (($actionurl eq '/adm/portfolio') ||
                   11421:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  11422:         my ($dirlistref,$listerror) =
                   11423:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   11424:         if (ref($dirlistref) eq 'ARRAY') {
                   11425:             foreach my $line (@{$dirlistref}) {
                   11426:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   11427:                 $currfile{$file_name} = 1;
                   11428:             }
1.984     raeburn  11429:         }
1.987     raeburn  11430:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11431:         if (opendir(my $dir,$url)) {
1.987     raeburn  11432:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  11433:             map {$currfile{$_} = 1;} @dir_list;
                   11434:         }
1.1075.2.11  raeburn  11435:     } elsif (($actionurl eq '/adm/dependencies') ||
                   11436:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11437:               ($args->{'context'} eq 'paste')) ||
                   11438:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11439:         if ($env{'request.course.id'} ne '') {
                   11440:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11441:             if ($dir ne '') {
                   11442:                 my ($dirlistref,$listerror) =
                   11443:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   11444:                 if (ref($dirlistref) eq 'ARRAY') {
                   11445:                     foreach my $line (@{$dirlistref}) {
                   11446:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   11447:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   11448:                         unless (($testdir&$dirptr) ||
                   11449:                                 ($file_name =~ /^\.\.?$/)) {
                   11450:                             $currfile{$file_name} = [$size,$mtime];
                   11451:                         }
                   11452:                     }
                   11453:                 }
                   11454:             }
                   11455:         }
1.984     raeburn  11456:     }
                   11457:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  11458:         if (exists($currfile{$file})) {
1.987     raeburn  11459:             unless ($mapping{$file} eq $file) {
                   11460:                 $pathchanges{$file} = 1;
                   11461:             }
                   11462:             $existing{$file} = 1;
                   11463:             $numexisting ++;
                   11464:         } else {
1.984     raeburn  11465:             $newfiles{$file} = 1;
                   11466:         }
                   11467:     }
1.1071    raeburn  11468:     foreach my $file (keys(%currfile)) {
                   11469:         unless (($file eq $filename) ||
                   11470:                 ($file eq $filename.'.bak') ||
                   11471:                 ($dependencies{$file})) {
1.1075.2.11  raeburn  11472:             if ($actionurl eq '/adm/dependencies') {
1.1075.2.35  raeburn  11473:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   11474:                     next if (($rem ne '') &&
                   11475:                              (($env{"httpref.$rem".$file} ne '') ||
                   11476:                               (ref($navmap) &&
                   11477:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   11478:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11479:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   11480:                 }
1.1075.2.11  raeburn  11481:             }
1.1071    raeburn  11482:             $unused{$file} = 1;
                   11483:         }
                   11484:     }
1.1075.2.11  raeburn  11485:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   11486:         ($args->{'context'} eq 'paste')) {
                   11487:         $counter = scalar(keys(%existing));
                   11488:         $numpathchg = scalar(keys(%pathchanges));
                   11489:         return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35  raeburn  11490:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
                   11491:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   11492:         $counter = scalar(keys(%existing));
                   11493:         $numpathchg = scalar(keys(%pathchanges));
                   11494:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11  raeburn  11495:     }
1.984     raeburn  11496:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  11497:         if ($actionurl eq '/adm/dependencies') {
                   11498:             next if ($embed_file =~ m{^\w+://});
                   11499:         }
1.660     raeburn  11500:         $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11501:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  11502:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  11503:         unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35  raeburn  11504:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   11505:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  11506:         }
1.1075.2.35  raeburn  11507:         $upload_output .= '</td>';
1.1071    raeburn  11508:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1075.2.35  raeburn  11509:             $upload_output.='<td align="right">'.
                   11510:                             '<span class="LC_info LC_fontsize_medium">'.
                   11511:                             &mt("URL points to web address").'</span>';
1.987     raeburn  11512:             $numremref++;
1.660     raeburn  11513:         } elsif ($args->{'error_on_invalid_names'}
                   11514:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35  raeburn  11515:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   11516:                             &mt('Invalid characters').'</span>';
1.987     raeburn  11517:             $numinvalid++;
1.660     raeburn  11518:         } else {
1.1075.2.35  raeburn  11519:             $upload_output .= '<td>'.
                   11520:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  11521:                                                      $embed_file,\%mapping,
1.1071    raeburn  11522:                                                      $allfiles,$codebase,'upload');
                   11523:             $counter ++;
                   11524:             $numnew ++;
1.987     raeburn  11525:         }
                   11526:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   11527:     }
                   11528:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  11529:         if ($actionurl eq '/adm/dependencies') {
                   11530:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   11531:             $modify_output .= &start_data_table_row().
                   11532:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   11533:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   11534:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   11535:                               '<td>'.$size.'</td>'.
                   11536:                               '<td>'.$mtime.'</td>'.
                   11537:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   11538:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   11539:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   11540:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   11541:                               &embedded_file_element('upload_embedded',$counter,
                   11542:                                                      $embed_file,\%mapping,
                   11543:                                                      $allfiles,$codebase,'modify').
                   11544:                               '</div></td>'.
                   11545:                               &end_data_table_row()."\n";
                   11546:             $counter ++;
                   11547:         } else {
                   11548:             $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11549:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   11550:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   11551:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  11552:                               &Apache::loncommon::end_data_table_row()."\n";
                   11553:         }
                   11554:     }
                   11555:     my $delidx = $counter;
                   11556:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   11557:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   11558:         $delete_output .= &start_data_table_row().
                   11559:                           '<td><img src="'.&icon($oldfile).'" />'.
                   11560:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   11561:                           '<td>'.$size.'</td>'.
                   11562:                           '<td>'.$mtime.'</td>'.
                   11563:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   11564:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   11565:                           &embedded_file_element('upload_embedded',$delidx,
                   11566:                                                  $oldfile,\%mapping,$allfiles,
                   11567:                                                  $codebase,'delete').'</td>'.
                   11568:                           &end_data_table_row()."\n"; 
                   11569:         $numunused ++;
                   11570:         $delidx ++;
1.987     raeburn  11571:     }
                   11572:     if ($upload_output) {
                   11573:         $upload_output = &start_data_table().
                   11574:                          $upload_output.
                   11575:                          &end_data_table()."\n";
                   11576:     }
1.1071    raeburn  11577:     if ($modify_output) {
                   11578:         $modify_output = &start_data_table().
                   11579:                          &start_data_table_header_row().
                   11580:                          '<th>'.&mt('File').'</th>'.
                   11581:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11582:                          '<th>'.&mt('Modified').'</th>'.
                   11583:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   11584:                          &end_data_table_header_row().
                   11585:                          $modify_output.
                   11586:                          &end_data_table()."\n";
                   11587:     }
                   11588:     if ($delete_output) {
                   11589:         $delete_output = &start_data_table().
                   11590:                          &start_data_table_header_row().
                   11591:                          '<th>'.&mt('File').'</th>'.
                   11592:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11593:                          '<th>'.&mt('Modified').'</th>'.
                   11594:                          '<th>'.&mt('Delete?').'</th>'.
                   11595:                          &end_data_table_header_row().
                   11596:                          $delete_output.
                   11597:                          &end_data_table()."\n";
                   11598:     }
1.987     raeburn  11599:     my $applies = 0;
                   11600:     if ($numremref) {
                   11601:         $applies ++;
                   11602:     }
                   11603:     if ($numinvalid) {
                   11604:         $applies ++;
                   11605:     }
                   11606:     if ($numexisting) {
                   11607:         $applies ++;
                   11608:     }
1.1071    raeburn  11609:     if ($counter || $numunused) {
1.987     raeburn  11610:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   11611:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  11612:                   $state.'<h3>'.$heading.'</h3>'; 
                   11613:         if ($actionurl eq '/adm/dependencies') {
                   11614:             if ($numnew) {
                   11615:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   11616:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   11617:                            $upload_output.'<br />'."\n";
                   11618:             }
                   11619:             if ($numexisting) {
                   11620:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   11621:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   11622:                            $modify_output.'<br />'."\n";
                   11623:                            $buttontext = &mt('Save changes');
                   11624:             }
                   11625:             if ($numunused) {
                   11626:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   11627:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   11628:                            $delete_output.'<br />'."\n";
                   11629:                            $buttontext = &mt('Save changes');
                   11630:             }
                   11631:         } else {
                   11632:             $output .= $upload_output.'<br />'."\n";
                   11633:         }
                   11634:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   11635:                    $counter.'" />'."\n";
                   11636:         if ($actionurl eq '/adm/dependencies') { 
                   11637:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   11638:                        $numnew.'" />'."\n";
                   11639:         } elsif ($actionurl eq '') {
1.987     raeburn  11640:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   11641:         }
                   11642:     } elsif ($applies) {
                   11643:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   11644:         if ($applies > 1) {
                   11645:             $output .=  
1.1075.2.35  raeburn  11646:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  11647:             if ($numremref) {
                   11648:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   11649:             }
                   11650:             if ($numinvalid) {
                   11651:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   11652:             }
                   11653:             if ($numexisting) {
                   11654:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   11655:             }
                   11656:             $output .= '</ul><br />';
                   11657:         } elsif ($numremref) {
                   11658:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   11659:         } elsif ($numinvalid) {
                   11660:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   11661:         } elsif ($numexisting) {
                   11662:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   11663:         }
                   11664:         $output .= $upload_output.'<br />';
                   11665:     }
                   11666:     my ($pathchange_output,$chgcount);
1.1071    raeburn  11667:     $chgcount = $counter;
1.987     raeburn  11668:     if (keys(%pathchanges) > 0) {
                   11669:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  11670:             if ($counter) {
1.987     raeburn  11671:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   11672:                                                   $embed_file,\%mapping,
1.1071    raeburn  11673:                                                   $allfiles,$codebase,'change');
1.987     raeburn  11674:             } else {
                   11675:                 $pathchange_output .= 
                   11676:                     &start_data_table_row().
                   11677:                     '<td><input type ="checkbox" name="namechange" value="'.
                   11678:                     $chgcount.'" checked="checked" /></td>'.
                   11679:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   11680:                     '<td>'.$embed_file.
                   11681:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  11682:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  11683:                     '</td>'.&end_data_table_row();
1.660     raeburn  11684:             }
1.987     raeburn  11685:             $numpathchg ++;
                   11686:             $chgcount ++;
1.660     raeburn  11687:         }
                   11688:     }
1.1075.2.35  raeburn  11689:     if (($counter) || ($numunused)) {
1.987     raeburn  11690:         if ($numpathchg) {
                   11691:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   11692:                        $numpathchg.'" />'."\n";
                   11693:         }
                   11694:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   11695:             ($actionurl eq '/adm/imsimport')) {
                   11696:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   11697:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   11698:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  11699:         } elsif ($actionurl eq '/adm/dependencies') {
                   11700:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  11701:         }
1.1075.2.35  raeburn  11702:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  11703:     } elsif ($numpathchg) {
                   11704:         my %pathchange = ();
                   11705:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   11706:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11707:             $output .= '<p>'.&mt('or').'</p>'; 
1.1075.2.35  raeburn  11708:         }
1.987     raeburn  11709:     }
1.1071    raeburn  11710:     return ($output,$counter,$numpathchg);
1.987     raeburn  11711: }
                   11712: 
1.1075.2.47  raeburn  11713: =pod
                   11714: 
                   11715: =item * clean_path($name)
                   11716: 
                   11717: Performs clean-up of directories, subdirectories and filename in an
                   11718: embedded object, referenced in an HTML file which is being uploaded
                   11719: to a course or portfolio, where
                   11720: "Upload embedded images/multimedia files if HTML file" checkbox was
                   11721: checked.
                   11722: 
                   11723: Clean-up is similar to replacements in lonnet::clean_filename()
                   11724: except each / between sub-directory and next level is preserved.
                   11725: 
                   11726: =cut
                   11727: 
                   11728: sub clean_path {
                   11729:     my ($embed_file) = @_;
                   11730:     $embed_file =~s{^/+}{};
                   11731:     my @contents;
                   11732:     if ($embed_file =~ m{/}) {
                   11733:         @contents = split(/\//,$embed_file);
                   11734:     } else {
                   11735:         @contents = ($embed_file);
                   11736:     }
                   11737:     my $lastidx = scalar(@contents)-1;
                   11738:     for (my $i=0; $i<=$lastidx; $i++) {
                   11739:         $contents[$i]=~s{\\}{/}g;
                   11740:         $contents[$i]=~s/\s+/\_/g;
                   11741:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   11742:         if ($i == $lastidx) {
                   11743:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   11744:         }
                   11745:     }
                   11746:     if ($lastidx > 0) {
                   11747:         return join('/',@contents);
                   11748:     } else {
                   11749:         return $contents[0];
                   11750:     }
                   11751: }
                   11752: 
1.987     raeburn  11753: sub embedded_file_element {
1.1071    raeburn  11754:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  11755:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   11756:                    (ref($codebase) eq 'HASH'));
                   11757:     my $output;
1.1071    raeburn  11758:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  11759:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   11760:     }
                   11761:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   11762:                &escape($embed_file).'" />';
                   11763:     unless (($context eq 'upload_embedded') && 
                   11764:             ($mapping->{$embed_file} eq $embed_file)) {
                   11765:         $output .='
                   11766:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   11767:     }
                   11768:     my $attrib;
                   11769:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   11770:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   11771:     }
                   11772:     $output .=
                   11773:         "\n\t\t".
                   11774:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   11775:         $attrib.'" />';
                   11776:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   11777:         $output .=
                   11778:             "\n\t\t".
                   11779:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   11780:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  11781:     }
1.987     raeburn  11782:     return $output;
1.660     raeburn  11783: }
                   11784: 
1.1071    raeburn  11785: sub get_dependency_details {
                   11786:     my ($currfile,$currsubfile,$embed_file) = @_;
                   11787:     my ($size,$mtime,$showsize,$showmtime);
                   11788:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   11789:         if ($embed_file =~ m{/}) {
                   11790:             my ($path,$fname) = split(/\//,$embed_file);
                   11791:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   11792:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   11793:             }
                   11794:         } else {
                   11795:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   11796:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   11797:             }
                   11798:         }
                   11799:         $showsize = $size/1024.0;
                   11800:         $showsize = sprintf("%.1f",$showsize);
                   11801:         if ($mtime > 0) {
                   11802:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   11803:         }
                   11804:     }
                   11805:     return ($showsize,$showmtime);
                   11806: }
                   11807: 
                   11808: sub ask_embedded_js {
                   11809:     return <<"END";
                   11810: <script type="text/javascript"">
                   11811: // <![CDATA[
                   11812: function toggleBrowse(counter) {
                   11813:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   11814:     var fileid = document.getElementById('embedded_item_'+counter);
                   11815:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   11816:     if (chkboxid.checked == true) {
                   11817:         uploaddivid.style.display='block';
                   11818:     } else {
                   11819:         uploaddivid.style.display='none';
                   11820:         fileid.value = '';
                   11821:     }
                   11822: }
                   11823: // ]]>
                   11824: </script>
                   11825: 
                   11826: END
                   11827: }
                   11828: 
1.661     raeburn  11829: sub upload_embedded {
                   11830:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  11831:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   11832:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  11833:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   11834:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   11835:         my $orig_uploaded_filename =
                   11836:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  11837:         foreach my $type ('orig','ref','attrib','codebase') {
                   11838:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   11839:                 $env{'form.embedded_'.$type.'_'.$i} =
                   11840:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   11841:             }
                   11842:         }
1.661     raeburn  11843:         my ($path,$fname) =
                   11844:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   11845:         # no path, whole string is fname
                   11846:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   11847:         $fname = &Apache::lonnet::clean_filename($fname);
                   11848:         # See if there is anything left
                   11849:         next if ($fname eq '');
                   11850: 
                   11851:         # Check if file already exists as a file or directory.
                   11852:         my ($state,$msg);
                   11853:         if ($context eq 'portfolio') {
                   11854:             my $port_path = $dirpath;
                   11855:             if ($group ne '') {
                   11856:                 $port_path = "groups/$group/$port_path";
                   11857:             }
1.987     raeburn  11858:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   11859:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  11860:                                               $dir_root,$port_path,$disk_quota,
                   11861:                                               $current_disk_usage,$uname,$udom);
                   11862:             if ($state eq 'will_exceed_quota'
1.984     raeburn  11863:                 || $state eq 'file_locked') {
1.661     raeburn  11864:                 $output .= $msg;
                   11865:                 next;
                   11866:             }
                   11867:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   11868:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   11869:             if ($state eq 'exists') {
                   11870:                 $output .= $msg;
                   11871:                 next;
                   11872:             }
                   11873:         }
                   11874:         # Check if extension is valid
                   11875:         if (($fname =~ /\.(\w+)$/) &&
                   11876:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1075.2.53  raeburn  11877:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   11878:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  11879:             next;
                   11880:         } elsif (($fname =~ /\.(\w+)$/) &&
                   11881:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  11882:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  11883:             next;
                   11884:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34  raeburn  11885:             $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  11886:             next;
                   11887:         }
                   11888:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35  raeburn  11889:         my $subdir = $path;
                   11890:         $subdir =~ s{/+$}{};
1.661     raeburn  11891:         if ($context eq 'portfolio') {
1.984     raeburn  11892:             my $result;
                   11893:             if ($state eq 'existingfile') {
                   11894:                 $result=
                   11895:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35  raeburn  11896:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  11897:             } else {
1.984     raeburn  11898:                 $result=
                   11899:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  11900:                                                     $dirpath.
1.1075.2.35  raeburn  11901:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  11902:                 if ($result !~ m|^/uploaded/|) {
                   11903:                     $output .= '<span class="LC_error">'
                   11904:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11905:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11906:                                .'</span><br />';
                   11907:                     next;
                   11908:                 } else {
1.987     raeburn  11909:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11910:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  11911:                 }
1.661     raeburn  11912:             }
1.1075.2.35  raeburn  11913:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
                   11914:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   11915:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  11916:             my $result =
1.1075.2.35  raeburn  11917:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  11918:             if ($result !~ m|^/uploaded/|) {
                   11919:                 $output .= '<span class="LC_error">'
                   11920:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11921:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11922:                            .'</span><br />';
                   11923:                     next;
                   11924:             } else {
                   11925:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11926:                            $path.$fname.'</span>').'<br />';
1.1075.2.35  raeburn  11927:                 if ($context eq 'syllabus') {
                   11928:                     &Apache::lonnet::make_public_indefinitely($result);
                   11929:                 }
1.987     raeburn  11930:             }
1.661     raeburn  11931:         } else {
                   11932: # Save the file
                   11933:             my $target = $env{'form.embedded_item_'.$i};
                   11934:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   11935:             my $dest = $fullpath.$fname;
                   11936:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  11937:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  11938:             my $count;
                   11939:             my $filepath = $dir_root;
1.1027    raeburn  11940:             foreach my $subdir (@parts) {
                   11941:                 $filepath .= "/$subdir";
                   11942:                 if (!-e $filepath) {
1.661     raeburn  11943:                     mkdir($filepath,0770);
                   11944:                 }
                   11945:             }
                   11946:             my $fh;
                   11947:             if (!open($fh,'>'.$dest)) {
                   11948:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   11949:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  11950:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   11951:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11952:                            '</span><br />';
                   11953:             } else {
                   11954:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   11955:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   11956:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  11957:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   11958:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11959:                               '</span><br />';
                   11960:                 } else {
1.987     raeburn  11961:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11962:                                $url.'</span>').'<br />';
                   11963:                     unless ($context eq 'testbank') {
                   11964:                         $footer .= &mt('View embedded file: [_1]',
                   11965:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   11966:                     }
                   11967:                 }
                   11968:                 close($fh);
                   11969:             }
                   11970:         }
                   11971:         if ($env{'form.embedded_ref_'.$i}) {
                   11972:             $pathchange{$i} = 1;
                   11973:         }
                   11974:     }
                   11975:     if ($output) {
                   11976:         $output = '<p>'.$output.'</p>';
                   11977:     }
                   11978:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   11979:     $returnflag = 'ok';
1.1071    raeburn  11980:     my $numpathchgs = scalar(keys(%pathchange));
                   11981:     if ($numpathchgs > 0) {
1.987     raeburn  11982:         if ($context eq 'portfolio') {
                   11983:             $output .= '<p>'.&mt('or').'</p>';
                   11984:         } elsif ($context eq 'testbank') {
1.1071    raeburn  11985:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   11986:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  11987:             $returnflag = 'modify_orightml';
                   11988:         }
                   11989:     }
1.1071    raeburn  11990:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  11991: }
                   11992: 
                   11993: sub modify_html_form {
                   11994:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   11995:     my $end = 0;
                   11996:     my $modifyform;
                   11997:     if ($context eq 'upload_embedded') {
                   11998:         return unless (ref($pathchange) eq 'HASH');
                   11999:         if ($env{'form.number_embedded_items'}) {
                   12000:             $end += $env{'form.number_embedded_items'};
                   12001:         }
                   12002:         if ($env{'form.number_pathchange_items'}) {
                   12003:             $end += $env{'form.number_pathchange_items'};
                   12004:         }
                   12005:         if ($end) {
                   12006:             for (my $i=0; $i<$end; $i++) {
                   12007:                 if ($i < $env{'form.number_embedded_items'}) {
                   12008:                     next unless($pathchange->{$i});
                   12009:                 }
                   12010:                 $modifyform .=
                   12011:                     &start_data_table_row().
                   12012:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   12013:                     'checked="checked" /></td>'.
                   12014:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   12015:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   12016:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   12017:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   12018:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   12019:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   12020:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   12021:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   12022:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   12023:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   12024:                     &end_data_table_row();
1.1071    raeburn  12025:             }
1.987     raeburn  12026:         }
                   12027:     } else {
                   12028:         $modifyform = $pathchgtable;
                   12029:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   12030:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   12031:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   12032:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   12033:         }
                   12034:     }
                   12035:     if ($modifyform) {
1.1071    raeburn  12036:         if ($actionurl eq '/adm/dependencies') {
                   12037:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   12038:         }
1.987     raeburn  12039:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   12040:                '<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".
                   12041:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   12042:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   12043:                '</ol></p>'."\n".'<p>'.
                   12044:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   12045:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   12046:                &start_data_table()."\n".
                   12047:                &start_data_table_header_row().
                   12048:                '<th>'.&mt('Change?').'</th>'.
                   12049:                '<th>'.&mt('Current reference').'</th>'.
                   12050:                '<th>'.&mt('Required reference').'</th>'.
                   12051:                &end_data_table_header_row()."\n".
                   12052:                $modifyform.
                   12053:                &end_data_table().'<br />'."\n".$hiddenstate.
                   12054:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   12055:                '</form>'."\n";
                   12056:     }
                   12057:     return;
                   12058: }
                   12059: 
                   12060: sub modify_html_refs {
1.1075.2.35  raeburn  12061:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  12062:     my $container;
                   12063:     if ($context eq 'portfolio') {
                   12064:         $container = $env{'form.container'};
                   12065:     } elsif ($context eq 'coursedoc') {
                   12066:         $container = $env{'form.primaryurl'};
1.1071    raeburn  12067:     } elsif ($context eq 'manage_dependencies') {
                   12068:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   12069:         $container = "/$container";
1.1075.2.35  raeburn  12070:     } elsif ($context eq 'syllabus') {
                   12071:         $container = $url;
1.987     raeburn  12072:     } else {
1.1027    raeburn  12073:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  12074:     }
                   12075:     my (%allfiles,%codebase,$output,$content);
                   12076:     my @changes = &get_env_multiple('form.namechange');
1.1075.2.35  raeburn  12077:     unless ((@changes > 0)  || ($context eq 'syllabus')) {
1.1071    raeburn  12078:         if (wantarray) {
                   12079:             return ('',0,0); 
                   12080:         } else {
                   12081:             return;
                   12082:         }
                   12083:     }
                   12084:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  12085:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  12086:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   12087:             if (wantarray) {
                   12088:                 return ('',0,0);
                   12089:             } else {
                   12090:                 return;
                   12091:             }
                   12092:         } 
1.987     raeburn  12093:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  12094:         if ($content eq '-1') {
                   12095:             if (wantarray) {
                   12096:                 return ('',0,0);
                   12097:             } else {
                   12098:                 return;
                   12099:             }
                   12100:         }
1.987     raeburn  12101:     } else {
1.1071    raeburn  12102:         unless ($container =~ /^\Q$dir_root\E/) {
                   12103:             if (wantarray) {
                   12104:                 return ('',0,0);
                   12105:             } else {
                   12106:                 return;
                   12107:             }
                   12108:         } 
1.1075.2.128  raeburn  12109:         if (open(my $fh,'<',$container)) {
1.987     raeburn  12110:             $content = join('', <$fh>);
                   12111:             close($fh);
                   12112:         } else {
1.1071    raeburn  12113:             if (wantarray) {
                   12114:                 return ('',0,0);
                   12115:             } else {
                   12116:                 return;
                   12117:             }
1.987     raeburn  12118:         }
                   12119:     }
                   12120:     my ($count,$codebasecount) = (0,0);
                   12121:     my $mm = new File::MMagic;
                   12122:     my $mime_type = $mm->checktype_contents($content);
                   12123:     if ($mime_type eq 'text/html') {
                   12124:         my $parse_result = 
                   12125:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   12126:                                                     \%codebase,\$content);
                   12127:         if ($parse_result eq 'ok') {
                   12128:             foreach my $i (@changes) {
                   12129:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   12130:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   12131:                 if ($allfiles{$ref}) {
                   12132:                     my $newname =  $orig;
                   12133:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  12134:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  12135:                     if ($attrib_regexp =~ /:/) {
                   12136:                         $attrib_regexp =~ s/\:/|/g;
                   12137:                     }
                   12138:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   12139:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   12140:                         $count += $numchg;
1.1075.2.35  raeburn  12141:                         $allfiles{$newname} = $allfiles{$ref};
1.1075.2.48  raeburn  12142:                         delete($allfiles{$ref});
1.987     raeburn  12143:                     }
                   12144:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  12145:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  12146:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   12147:                         $codebasecount ++;
                   12148:                     }
                   12149:                 }
                   12150:             }
1.1075.2.35  raeburn  12151:             my $skiprewrites;
1.987     raeburn  12152:             if ($count || $codebasecount) {
                   12153:                 my $saveresult;
1.1071    raeburn  12154:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  12155:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  12156:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   12157:                     if ($url eq $container) {
                   12158:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   12159:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   12160:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  12161:                                             $fname.'</span>').'</p>';
1.987     raeburn  12162:                     } else {
                   12163:                          $output = '<p class="LC_error">'.
                   12164:                                    &mt('Error: update failed for: [_1].',
                   12165:                                    '<span class="LC_filename">'.
                   12166:                                    $container.'</span>').'</p>';
                   12167:                     }
1.1075.2.35  raeburn  12168:                     if ($context eq 'syllabus') {
                   12169:                         unless ($saveresult eq 'ok') {
                   12170:                             $skiprewrites = 1;
                   12171:                         }
                   12172:                     }
1.987     raeburn  12173:                 } else {
1.1075.2.128  raeburn  12174:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  12175:                         print $fh $content;
                   12176:                         close($fh);
                   12177:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   12178:                                   $count,'<span class="LC_filename">'.
                   12179:                                   $container.'</span>').'</p>';
1.661     raeburn  12180:                     } else {
1.987     raeburn  12181:                          $output = '<p class="LC_error">'.
                   12182:                                    &mt('Error: could not update [_1].',
                   12183:                                    '<span class="LC_filename">'.
                   12184:                                    $container.'</span>').'</p>';
1.661     raeburn  12185:                     }
                   12186:                 }
                   12187:             }
1.1075.2.35  raeburn  12188:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   12189:                 my ($actionurl,$state);
                   12190:                 $actionurl = "/public/$udom/$uname/syllabus";
                   12191:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   12192:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   12193:                                               \%codebase,
                   12194:                                               {'context' => 'rewrites',
                   12195:                                                'ignore_remote_references' => 1,});
                   12196:                 if (ref($mapping) eq 'HASH') {
                   12197:                     my $rewrites = 0;
                   12198:                     foreach my $key (keys(%{$mapping})) {
                   12199:                         next if ($key =~ m{^https?://});
                   12200:                         my $ref = $mapping->{$key};
                   12201:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   12202:                         my $attrib;
                   12203:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   12204:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   12205:                         }
                   12206:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   12207:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   12208:                             $rewrites += $numchg;
                   12209:                         }
                   12210:                     }
                   12211:                     if ($rewrites) {
                   12212:                         my $saveresult;
                   12213:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   12214:                         if ($url eq $container) {
                   12215:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   12216:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   12217:                                             $count,'<span class="LC_filename">'.
                   12218:                                             $fname.'</span>').'</p>';
                   12219:                         } else {
                   12220:                             $output .= '<p class="LC_error">'.
                   12221:                                        &mt('Error: could not update links in [_1].',
                   12222:                                        '<span class="LC_filename">'.
                   12223:                                        $container.'</span>').'</p>';
                   12224: 
                   12225:                         }
                   12226:                     }
                   12227:                 }
                   12228:             }
1.987     raeburn  12229:         } else {
                   12230:             &logthis('Failed to parse '.$container.
                   12231:                      ' to modify references: '.$parse_result);
1.661     raeburn  12232:         }
                   12233:     }
1.1071    raeburn  12234:     if (wantarray) {
                   12235:         return ($output,$count,$codebasecount);
                   12236:     } else {
                   12237:         return $output;
                   12238:     }
1.661     raeburn  12239: }
                   12240: 
                   12241: sub check_for_existing {
                   12242:     my ($path,$fname,$element) = @_;
                   12243:     my ($state,$msg);
                   12244:     if (-d $path.'/'.$fname) {
                   12245:         $state = 'exists';
                   12246:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   12247:     } elsif (-e $path.'/'.$fname) {
                   12248:         $state = 'exists';
                   12249:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   12250:     }
                   12251:     if ($state eq 'exists') {
                   12252:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   12253:     }
                   12254:     return ($state,$msg);
                   12255: }
                   12256: 
                   12257: sub check_for_upload {
                   12258:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   12259:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  12260:     my $filesize = length($env{'form.'.$element});
                   12261:     if (!$filesize) {
                   12262:         my $msg = '<span class="LC_error">'.
                   12263:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   12264:                       '<span class="LC_filename">'.$fname.'</span>',
                   12265:                       $filesize).'<br />'.
1.1007    raeburn  12266:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  12267:                   '</span>';
                   12268:         return ('zero_bytes',$msg);
                   12269:     }
                   12270:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  12271:     my $getpropath = 1;
1.1021    raeburn  12272:     my ($dirlistref,$listerror) =
                   12273:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  12274:     my $found_file = 0;
                   12275:     my $locked_file = 0;
1.991     raeburn  12276:     my @lockers;
                   12277:     my $navmap;
                   12278:     if ($env{'request.course.id'}) {
                   12279:         $navmap = Apache::lonnavmaps::navmap->new();
                   12280:     }
1.1021    raeburn  12281:     if (ref($dirlistref) eq 'ARRAY') {
                   12282:         foreach my $line (@{$dirlistref}) {
                   12283:             my ($file_name,$rest)=split(/\&/,$line,2);
                   12284:             if ($file_name eq $fname){
                   12285:                 $file_name = $path.$file_name;
                   12286:                 if ($group ne '') {
                   12287:                     $file_name = $group.$file_name;
                   12288:                 }
                   12289:                 $found_file = 1;
                   12290:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   12291:                     foreach my $lock (@lockers) {
                   12292:                         if (ref($lock) eq 'ARRAY') {
                   12293:                             my ($symb,$crsid) = @{$lock};
                   12294:                             if ($crsid eq $env{'request.course.id'}) {
                   12295:                                 if (ref($navmap)) {
                   12296:                                     my $res = $navmap->getBySymb($symb);
                   12297:                                     foreach my $part (@{$res->parts()}) { 
                   12298:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   12299:                                         unless (($slot_status == $res->RESERVED) ||
                   12300:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   12301:                                             $locked_file = 1;
                   12302:                                         }
1.991     raeburn  12303:                                     }
1.1021    raeburn  12304:                                 } else {
                   12305:                                     $locked_file = 1;
1.991     raeburn  12306:                                 }
                   12307:                             } else {
                   12308:                                 $locked_file = 1;
                   12309:                             }
                   12310:                         }
1.1021    raeburn  12311:                    }
                   12312:                 } else {
                   12313:                     my @info = split(/\&/,$rest);
                   12314:                     my $currsize = $info[6]/1000;
                   12315:                     if ($currsize < $filesize) {
                   12316:                         my $extra = $filesize - $currsize;
                   12317:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1075.2.69  raeburn  12318:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  12319:                                       &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  12320:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   12321:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   12322:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  12323:                             return ('will_exceed_quota',$msg);
                   12324:                         }
1.984     raeburn  12325:                     }
                   12326:                 }
1.661     raeburn  12327:             }
                   12328:         }
                   12329:     }
                   12330:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1075.2.69  raeburn  12331:         my $msg = '<p class="LC_warning">'.
                   12332:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
                   12333:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  12334:         return ('will_exceed_quota',$msg);
                   12335:     } elsif ($found_file) {
                   12336:         if ($locked_file) {
1.1075.2.69  raeburn  12337:             my $msg = '<p class="LC_warning">';
1.661     raeburn  12338:             $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  12339:             $msg .= '</p>';
1.661     raeburn  12340:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   12341:             return ('file_locked',$msg);
                   12342:         } else {
1.1075.2.69  raeburn  12343:             my $msg = '<p class="LC_error">';
1.984     raeburn  12344:             $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  12345:             $msg .= '</p>';
1.984     raeburn  12346:             return ('existingfile',$msg);
1.661     raeburn  12347:         }
                   12348:     }
                   12349: }
                   12350: 
1.987     raeburn  12351: sub check_for_traversal {
                   12352:     my ($path,$url,$toplevel) = @_;
                   12353:     my @parts=split(/\//,$path);
                   12354:     my $cleanpath;
                   12355:     my $fullpath = $url;
                   12356:     for (my $i=0;$i<@parts;$i++) {
                   12357:         next if ($parts[$i] eq '.');
                   12358:         if ($parts[$i] eq '..') {
                   12359:             $fullpath =~ s{([^/]+/)$}{};
                   12360:         } else {
                   12361:             $fullpath .= $parts[$i].'/';
                   12362:         }
                   12363:     }
                   12364:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   12365:         $cleanpath = $1;
                   12366:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   12367:         my $curr_toprel = $1;
                   12368:         my @parts = split(/\//,$curr_toprel);
                   12369:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   12370:         my @urlparts = split(/\//,$url_toprel);
                   12371:         my $doubledots;
                   12372:         my $startdiff = -1;
                   12373:         for (my $i=0; $i<@urlparts; $i++) {
                   12374:             if ($startdiff == -1) {
                   12375:                 unless ($urlparts[$i] eq $parts[$i]) {
                   12376:                     $startdiff = $i;
                   12377:                     $doubledots .= '../';
                   12378:                 }
                   12379:             } else {
                   12380:                 $doubledots .= '../';
                   12381:             }
                   12382:         }
                   12383:         if ($startdiff > -1) {
                   12384:             $cleanpath = $doubledots;
                   12385:             for (my $i=$startdiff; $i<@parts; $i++) {
                   12386:                 $cleanpath .= $parts[$i].'/';
                   12387:             }
                   12388:         }
                   12389:     }
                   12390:     $cleanpath =~ s{(/)$}{};
                   12391:     return $cleanpath;
                   12392: }
1.31      albertel 12393: 
1.1053    raeburn  12394: sub is_archive_file {
                   12395:     my ($mimetype) = @_;
                   12396:     if (($mimetype eq 'application/octet-stream') ||
                   12397:         ($mimetype eq 'application/x-stuffit') ||
                   12398:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   12399:         return 1;
                   12400:     }
                   12401:     return;
                   12402: }
                   12403: 
                   12404: sub decompress_form {
1.1065    raeburn  12405:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  12406:     my %lt = &Apache::lonlocal::texthash (
                   12407:         this => 'This file is an archive file.',
1.1067    raeburn  12408:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  12409:         itsc => 'Its contents are as follows:',
1.1053    raeburn  12410:         youm => 'You may wish to extract its contents.',
                   12411:         extr => 'Extract contents',
1.1067    raeburn  12412:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   12413:         proa => 'Process automatically?',
1.1053    raeburn  12414:         yes  => 'Yes',
                   12415:         no   => 'No',
1.1067    raeburn  12416:         fold => 'Title for folder containing movie',
                   12417:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  12418:     );
1.1065    raeburn  12419:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  12420:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  12421:     my $info = &list_archive_contents($fileloc,\@paths);
                   12422:     if (@paths) {
                   12423:         foreach my $path (@paths) {
                   12424:             $path =~ s{^/}{};
1.1067    raeburn  12425:             if ($path =~ m{^([^/]+)/$}) {
                   12426:                 $topdir = $1;
                   12427:             }
1.1065    raeburn  12428:             if ($path =~ m{^([^/]+)/}) {
                   12429:                 $toplevel{$1} = $path;
                   12430:             } else {
                   12431:                 $toplevel{$path} = $path;
                   12432:             }
                   12433:         }
                   12434:     }
1.1067    raeburn  12435:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1075.2.59  raeburn  12436:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  12437:                         "$topdir/media/",
                   12438:                         "$topdir/media/$topdir.mp4",
                   12439:                         "$topdir/media/FirstFrame.png",
                   12440:                         "$topdir/media/player.swf",
                   12441:                         "$topdir/media/swfobject.js",
                   12442:                         "$topdir/media/expressInstall.swf");
1.1075.2.81  raeburn  12443:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1075.2.59  raeburn  12444:                          "$topdir/$topdir.mp4",
                   12445:                          "$topdir/$topdir\_config.xml",
                   12446:                          "$topdir/$topdir\_controller.swf",
                   12447:                          "$topdir/$topdir\_embed.css",
                   12448:                          "$topdir/$topdir\_First_Frame.png",
                   12449:                          "$topdir/$topdir\_player.html",
                   12450:                          "$topdir/$topdir\_Thumbnails.png",
                   12451:                          "$topdir/playerProductInstall.swf",
                   12452:                          "$topdir/scripts/",
                   12453:                          "$topdir/scripts/config_xml.js",
                   12454:                          "$topdir/scripts/handlebars.js",
                   12455:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   12456:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   12457:                          "$topdir/scripts/modernizr.js",
                   12458:                          "$topdir/scripts/player-min.js",
                   12459:                          "$topdir/scripts/swfobject.js",
                   12460:                          "$topdir/skins/",
                   12461:                          "$topdir/skins/configuration_express.xml",
                   12462:                          "$topdir/skins/express_show/",
                   12463:                          "$topdir/skins/express_show/player-min.css",
                   12464:                          "$topdir/skins/express_show/spritesheet.png");
1.1075.2.81  raeburn  12465:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   12466:                          "$topdir/$topdir.mp4",
                   12467:                          "$topdir/$topdir\_config.xml",
                   12468:                          "$topdir/$topdir\_controller.swf",
                   12469:                          "$topdir/$topdir\_embed.css",
                   12470:                          "$topdir/$topdir\_First_Frame.png",
                   12471:                          "$topdir/$topdir\_player.html",
                   12472:                          "$topdir/$topdir\_Thumbnails.png",
                   12473:                          "$topdir/playerProductInstall.swf",
                   12474:                          "$topdir/scripts/",
                   12475:                          "$topdir/scripts/config_xml.js",
                   12476:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   12477:                          "$topdir/skins/",
                   12478:                          "$topdir/skins/configuration_express.xml",
                   12479:                          "$topdir/skins/express_show/",
                   12480:                          "$topdir/skins/express_show/spritesheet.min.css",
                   12481:                          "$topdir/skins/express_show/spritesheet.png",
                   12482:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1075.2.59  raeburn  12483:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  12484:         if (@diffs == 0) {
1.1075.2.59  raeburn  12485:             $is_camtasia = 6;
                   12486:         } else {
1.1075.2.81  raeburn  12487:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1075.2.59  raeburn  12488:             if (@diffs == 0) {
                   12489:                 $is_camtasia = 8;
1.1075.2.81  raeburn  12490:             } else {
                   12491:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   12492:                 if (@diffs == 0) {
                   12493:                     $is_camtasia = 8;
                   12494:                 }
1.1075.2.59  raeburn  12495:             }
1.1067    raeburn  12496:         }
                   12497:     }
                   12498:     my $output;
                   12499:     if ($is_camtasia) {
                   12500:         $output = <<"ENDCAM";
                   12501: <script type="text/javascript" language="Javascript">
                   12502: // <![CDATA[
                   12503: 
                   12504: function camtasiaToggle() {
                   12505:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   12506:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1075.2.59  raeburn  12507:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  12508:                 document.getElementById('camtasia_titles').style.display='block';
                   12509:             } else {
                   12510:                 document.getElementById('camtasia_titles').style.display='none';
                   12511:             }
                   12512:         }
                   12513:     }
                   12514:     return;
                   12515: }
                   12516: 
                   12517: // ]]>
                   12518: </script>
                   12519: <p>$lt{'camt'}</p>
                   12520: ENDCAM
1.1065    raeburn  12521:     } else {
1.1067    raeburn  12522:         $output = '<p>'.$lt{'this'};
                   12523:         if ($info eq '') {
                   12524:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   12525:         } else {
                   12526:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   12527:                        '<div><pre>'.$info.'</pre></div>';
                   12528:         }
1.1065    raeburn  12529:     }
1.1067    raeburn  12530:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  12531:     my $duplicates;
                   12532:     my $num = 0;
                   12533:     if (ref($dirlist) eq 'ARRAY') {
                   12534:         foreach my $item (@{$dirlist}) {
                   12535:             if (ref($item) eq 'ARRAY') {
                   12536:                 if (exists($toplevel{$item->[0]})) {
                   12537:                     $duplicates .= 
                   12538:                         &start_data_table_row().
                   12539:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12540:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   12541:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12542:                         'value="1" />'.&mt('Yes').'</label>'.
                   12543:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   12544:                         '<td>'.$item->[0].'</td>';
                   12545:                     if ($item->[2]) {
                   12546:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   12547:                     } else {
                   12548:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   12549:                     }
                   12550:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   12551:                                    '<td>'.
                   12552:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   12553:                                    '</td>'.
                   12554:                                    &end_data_table_row();
                   12555:                     $num ++;
                   12556:                 }
                   12557:             }
                   12558:         }
                   12559:     }
                   12560:     my $itemcount;
                   12561:     if (@paths > 0) {
                   12562:         $itemcount = scalar(@paths);
                   12563:     } else {
                   12564:         $itemcount = 1;
                   12565:     }
1.1067    raeburn  12566:     if ($is_camtasia) {
                   12567:         $output .= $lt{'auto'}.'<br />'.
                   12568:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1075.2.59  raeburn  12569:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  12570:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   12571:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   12572:                    $lt{'no'}.'</label></span><br />'.
                   12573:                    '<div id="camtasia_titles" style="display:block">'.
                   12574:                    &Apache::lonhtmlcommon::start_pick_box().
                   12575:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   12576:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   12577:                    &Apache::lonhtmlcommon::row_closure().
                   12578:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   12579:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   12580:                    &Apache::lonhtmlcommon::row_closure(1).
                   12581:                    &Apache::lonhtmlcommon::end_pick_box().
                   12582:                    '</div>';
                   12583:     }
1.1065    raeburn  12584:     $output .= 
                   12585:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  12586:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   12587:         "\n";
1.1065    raeburn  12588:     if ($duplicates ne '') {
                   12589:         $output .= '<p><span class="LC_warning">'.
                   12590:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   12591:                    &start_data_table().
                   12592:                    &start_data_table_header_row().
                   12593:                    '<th>'.&mt('Overwrite?').'</th>'.
                   12594:                    '<th>'.&mt('Name').'</th>'.
                   12595:                    '<th>'.&mt('Type').'</th>'.
                   12596:                    '<th>'.&mt('Size').'</th>'.
                   12597:                    '<th>'.&mt('Last modified').'</th>'.
                   12598:                    &end_data_table_header_row().
                   12599:                    $duplicates.
                   12600:                    &end_data_table().
                   12601:                    '</p>';
                   12602:     }
1.1067    raeburn  12603:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  12604:     if (ref($hiddenelements) eq 'HASH') {
                   12605:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   12606:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   12607:         }
                   12608:     }
                   12609:     $output .= <<"END";
1.1067    raeburn  12610: <br />
1.1053    raeburn  12611: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   12612: </form>
                   12613: $noextract
                   12614: END
                   12615:     return $output;
                   12616: }
                   12617: 
1.1065    raeburn  12618: sub decompression_utility {
                   12619:     my ($program) = @_;
                   12620:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   12621:     my $location;
                   12622:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   12623:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   12624:                          '/usr/sbin/') {
                   12625:             if (-x $dir.$program) {
                   12626:                 $location = $dir.$program;
                   12627:                 last;
                   12628:             }
                   12629:         }
                   12630:     }
                   12631:     return $location;
                   12632: }
                   12633: 
                   12634: sub list_archive_contents {
                   12635:     my ($file,$pathsref) = @_;
                   12636:     my (@cmd,$output);
                   12637:     my $needsregexp;
                   12638:     if ($file =~ /\.zip$/) {
                   12639:         @cmd = (&decompression_utility('unzip'),"-l");
                   12640:         $needsregexp = 1;
                   12641:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   12642:              ($file =~ /\.tgz$/)) {
                   12643:         @cmd = (&decompression_utility('tar'),"-ztf");
                   12644:     } elsif ($file =~ /\.tar\.bz2$/) {
                   12645:         @cmd = (&decompression_utility('tar'),"-jtf");
                   12646:     } elsif ($file =~ m|\.tar$|) {
                   12647:         @cmd = (&decompression_utility('tar'),"-tf");
                   12648:     }
                   12649:     if (@cmd) {
                   12650:         undef($!);
                   12651:         undef($@);
                   12652:         if (open(my $fh,"-|", @cmd, $file)) {
                   12653:             while (my $line = <$fh>) {
                   12654:                 $output .= $line;
                   12655:                 chomp($line);
                   12656:                 my $item;
                   12657:                 if ($needsregexp) {
                   12658:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   12659:                 } else {
                   12660:                     $item = $line;
                   12661:                 }
                   12662:                 if ($item ne '') {
                   12663:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   12664:                         push(@{$pathsref},$item);
                   12665:                     } 
                   12666:                 }
                   12667:             }
                   12668:             close($fh);
                   12669:         }
                   12670:     }
                   12671:     return $output;
                   12672: }
                   12673: 
1.1053    raeburn  12674: sub decompress_uploaded_file {
                   12675:     my ($file,$dir) = @_;
                   12676:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   12677:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   12678:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   12679:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   12680:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   12681:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   12682:     my $decompressed = $env{'cgi.decompressed'};
                   12683:     &Apache::lonnet::delenv('cgi.file');
                   12684:     &Apache::lonnet::delenv('cgi.dir');
                   12685:     &Apache::lonnet::delenv('cgi.decompressed');
                   12686:     return ($decompressed,$result);
                   12687: }
                   12688: 
1.1055    raeburn  12689: sub process_decompression {
                   12690:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1075.2.128  raeburn  12691:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   12692:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12693:                &mt('Unexpected file path.').'</p>'."\n";
                   12694:     }
                   12695:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   12696:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12697:                &mt('Unexpected course context.').'</p>'."\n";
                   12698:     }
                   12699:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
                   12700:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12701:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   12702:     }
1.1055    raeburn  12703:     my ($dir,$error,$warning,$output);
1.1075.2.69  raeburn  12704:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1075.2.34  raeburn  12705:         $error = &mt('Filename not a supported archive file type.').
                   12706:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  12707:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   12708:     } else {
                   12709:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12710:         if ($docuhome eq 'no_host') {
                   12711:             $error = &mt('Could not determine home server for course.');
                   12712:         } else {
                   12713:             my @ids=&Apache::lonnet::current_machine_ids();
                   12714:             my $currdir = "$dir_root/$destination";
                   12715:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12716:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   12717:                        "$dir_root/$destination";
                   12718:             } else {
                   12719:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   12720:                        "$dir_root/$docudom/$docuname/$destination";
                   12721:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   12722:                     $error = &mt('Archive file not found.');
                   12723:                 }
                   12724:             }
1.1065    raeburn  12725:             my (@to_overwrite,@to_skip);
                   12726:             if ($env{'form.archive_overwrite_total'} > 0) {
                   12727:                 my $total = $env{'form.archive_overwrite_total'};
                   12728:                 for (my $i=0; $i<$total; $i++) {
                   12729:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   12730:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   12731:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   12732:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   12733:                     }
                   12734:                 }
                   12735:             }
                   12736:             my $numskip = scalar(@to_skip);
1.1075.2.128  raeburn  12737:             my $numoverwrite = scalar(@to_overwrite);
                   12738:             if (($numskip) && (!$numoverwrite)) {
1.1065    raeburn  12739:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   12740:             } elsif ($dir eq '') {
1.1055    raeburn  12741:                 $error = &mt('Directory containing archive file unavailable.');
                   12742:             } elsif (!$error) {
1.1065    raeburn  12743:                 my ($decompressed,$display);
1.1075.2.128  raeburn  12744:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  12745:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   12746:                     mkdir("$dir/$tempdir",0755);
1.1075.2.128  raeburn  12747:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   12748:                         ($decompressed,$display) =
                   12749:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   12750:                         foreach my $item (@to_skip) {
                   12751:                             if (($item ne '') && ($item !~ /\.\./)) {
                   12752:                                 if (-f "$dir/$tempdir/$item") {
                   12753:                                     unlink("$dir/$tempdir/$item");
                   12754:                                 } elsif (-d "$dir/$tempdir/$item") {
                   12755:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
                   12756:                                 }
                   12757:                             }
                   12758:                         }
                   12759:                         foreach my $item (@to_overwrite) {
                   12760:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   12761:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   12762:                                     if (-f "$dir/$item") {
                   12763:                                         unlink("$dir/$item");
                   12764:                                     } elsif (-d "$dir/$item") {
                   12765:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
                   12766:                                     }
                   12767:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   12768:                                 }
1.1065    raeburn  12769:                             }
                   12770:                         }
1.1075.2.128  raeburn  12771:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
                   12772:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
                   12773:                         }
1.1065    raeburn  12774:                     }
                   12775:                 } else {
                   12776:                     ($decompressed,$display) = 
                   12777:                         &decompress_uploaded_file($file,$dir);
                   12778:                 }
1.1055    raeburn  12779:                 if ($decompressed eq 'ok') {
1.1065    raeburn  12780:                     $output = '<p class="LC_info">'.
                   12781:                               &mt('Files extracted successfully from archive.').
                   12782:                               '</p>'."\n";
1.1055    raeburn  12783:                     my ($warning,$result,@contents);
                   12784:                     my ($newdirlistref,$newlisterror) =
                   12785:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   12786:                                                  $docuname,1);
                   12787:                     my (%is_dir,%changes,@newitems);
                   12788:                     my $dirptr = 16384;
1.1065    raeburn  12789:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  12790:                         foreach my $dir_line (@{$newdirlistref}) {
                   12791:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1075.2.128  raeburn  12792:                             unless (($item =~ /^\.+$/) || ($item eq $file)) { 
1.1055    raeburn  12793:                                 push(@newitems,$item);
                   12794:                                 if ($dirptr&$testdir) {
                   12795:                                     $is_dir{$item} = 1;
                   12796:                                 }
                   12797:                                 $changes{$item} = 1;
                   12798:                             }
                   12799:                         }
                   12800:                     }
                   12801:                     if (keys(%changes) > 0) {
                   12802:                         foreach my $item (sort(@newitems)) {
                   12803:                             if ($changes{$item}) {
                   12804:                                 push(@contents,$item);
                   12805:                             }
                   12806:                         }
                   12807:                     }
                   12808:                     if (@contents > 0) {
1.1067    raeburn  12809:                         my $wantform;
                   12810:                         unless ($env{'form.autoextract_camtasia'}) {
                   12811:                             $wantform = 1;
                   12812:                         }
1.1056    raeburn  12813:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  12814:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   12815:                                                                 $currdir,\%is_dir,
                   12816:                                                                 \%children,\%parent,
1.1056    raeburn  12817:                                                                 \@contents,\%dirorder,
                   12818:                                                                 \%titles,$wantform);
1.1055    raeburn  12819:                         if ($datatable ne '') {
                   12820:                             $output .= &archive_options_form('decompressed',$datatable,
                   12821:                                                              $count,$hiddenelem);
1.1065    raeburn  12822:                             my $startcount = 6;
1.1055    raeburn  12823:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  12824:                                                            \%titles,\%children);
1.1055    raeburn  12825:                         }
1.1067    raeburn  12826:                         if ($env{'form.autoextract_camtasia'}) {
1.1075.2.59  raeburn  12827:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  12828:                             my %displayed;
                   12829:                             my $total = 1;
                   12830:                             $env{'form.archive_directory'} = [];
                   12831:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   12832:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   12833:                                 $path =~ s{/$}{};
                   12834:                                 my $item;
                   12835:                                 if ($path ne '') {
                   12836:                                     $item = "$path/$titles{$i}";
                   12837:                                 } else {
                   12838:                                     $item = $titles{$i};
                   12839:                                 }
                   12840:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   12841:                                 if ($item eq $contents[0]) {
                   12842:                                     push(@{$env{'form.archive_directory'}},$i);
                   12843:                                     $env{'form.archive_'.$i} = 'display';
                   12844:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   12845:                                     $displayed{'folder'} = $i;
1.1075.2.59  raeburn  12846:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   12847:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067    raeburn  12848:                                     $env{'form.archive_'.$i} = 'display';
                   12849:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   12850:                                     $displayed{'web'} = $i;
                   12851:                                 } else {
1.1075.2.59  raeburn  12852:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   12853:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   12854:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  12855:                                         push(@{$env{'form.archive_directory'}},$i);
                   12856:                                     }
                   12857:                                     $env{'form.archive_'.$i} = 'dependency';
                   12858:                                 }
                   12859:                                 $total ++;
                   12860:                             }
                   12861:                             for (my $i=1; $i<$total; $i++) {
                   12862:                                 next if ($i == $displayed{'web'});
                   12863:                                 next if ($i == $displayed{'folder'});
                   12864:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   12865:                             }
                   12866:                             $env{'form.phase'} = 'decompress_cleanup';
                   12867:                             $env{'form.archivedelete'} = 1;
                   12868:                             $env{'form.archive_count'} = $total-1;
                   12869:                             $output .=
                   12870:                                 &process_extracted_files('coursedocs',$docudom,
                   12871:                                                          $docuname,$destination,
                   12872:                                                          $dir_root,$hiddenelem);
                   12873:                         }
1.1055    raeburn  12874:                     } else {
                   12875:                         $warning = &mt('No new items extracted from archive file.');
                   12876:                     }
                   12877:                 } else {
                   12878:                     $output = $display;
                   12879:                     $error = &mt('An error occurred during extraction from the archive file.');
                   12880:                 }
                   12881:             }
                   12882:         }
                   12883:     }
                   12884:     if ($error) {
                   12885:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12886:                    $error.'</p>'."\n";
                   12887:     }
                   12888:     if ($warning) {
                   12889:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   12890:     }
                   12891:     return $output;
                   12892: }
                   12893: 
                   12894: sub get_extracted {
1.1056    raeburn  12895:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   12896:         $titles,$wantform) = @_;
1.1055    raeburn  12897:     my $count = 0;
                   12898:     my $depth = 0;
                   12899:     my $datatable;
1.1056    raeburn  12900:     my @hierarchy;
1.1055    raeburn  12901:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  12902:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   12903:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  12904:     foreach my $item (@{$contents}) {
                   12905:         $count ++;
1.1056    raeburn  12906:         @{$dirorder->{$count}} = @hierarchy;
                   12907:         $titles->{$count} = $item;
1.1055    raeburn  12908:         &archive_hierarchy($depth,$count,$parent,$children);
                   12909:         if ($wantform) {
                   12910:             $datatable .= &archive_row($is_dir->{$item},$item,
                   12911:                                        $currdir,$depth,$count);
                   12912:         }
                   12913:         if ($is_dir->{$item}) {
                   12914:             $depth ++;
1.1056    raeburn  12915:             push(@hierarchy,$count);
                   12916:             $parent->{$depth} = $count;
1.1055    raeburn  12917:             $datatable .=
                   12918:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  12919:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   12920:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  12921:             $depth --;
1.1056    raeburn  12922:             pop(@hierarchy);
1.1055    raeburn  12923:         }
                   12924:     }
                   12925:     return ($count,$datatable);
                   12926: }
                   12927: 
                   12928: sub recurse_extracted_archive {
1.1056    raeburn  12929:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   12930:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  12931:     my $result='';
1.1056    raeburn  12932:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   12933:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   12934:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  12935:         return $result;
                   12936:     }
                   12937:     my $dirptr = 16384;
                   12938:     my ($newdirlistref,$newlisterror) =
                   12939:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   12940:     if (ref($newdirlistref) eq 'ARRAY') {
                   12941:         foreach my $dir_line (@{$newdirlistref}) {
                   12942:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   12943:             unless ($item =~ /^\.+$/) {
                   12944:                 $$count ++;
1.1056    raeburn  12945:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   12946:                 $titles->{$$count} = $item;
1.1055    raeburn  12947:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  12948: 
1.1055    raeburn  12949:                 my $is_dir;
                   12950:                 if ($dirptr&$testdir) {
                   12951:                     $is_dir = 1;
                   12952:                 }
                   12953:                 if ($wantform) {
                   12954:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   12955:                 }
                   12956:                 if ($is_dir) {
                   12957:                     $$depth ++;
1.1056    raeburn  12958:                     push(@{$hierarchy},$$count);
                   12959:                     $parent->{$$depth} = $$count;
1.1055    raeburn  12960:                     $result .=
                   12961:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   12962:                                                    $docuname,$depth,$count,
1.1056    raeburn  12963:                                                    $hierarchy,$dirorder,$children,
                   12964:                                                    $parent,$titles,$wantform);
1.1055    raeburn  12965:                     $$depth --;
1.1056    raeburn  12966:                     pop(@{$hierarchy});
1.1055    raeburn  12967:                 }
                   12968:             }
                   12969:         }
                   12970:     }
                   12971:     return $result;
                   12972: }
                   12973: 
                   12974: sub archive_hierarchy {
                   12975:     my ($depth,$count,$parent,$children) =@_;
                   12976:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   12977:         if (exists($parent->{$depth})) {
                   12978:              $children->{$parent->{$depth}} .= $count.':';
                   12979:         }
                   12980:     }
                   12981:     return;
                   12982: }
                   12983: 
                   12984: sub archive_row {
                   12985:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   12986:     my ($name) = ($item =~ m{([^/]+)$});
                   12987:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  12988:                                        'display'    => 'Add as file',
1.1055    raeburn  12989:                                        'dependency' => 'Include as dependency',
                   12990:                                        'discard'    => 'Discard',
                   12991:                                       );
                   12992:     if ($is_dir) {
1.1059    raeburn  12993:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  12994:     }
1.1056    raeburn  12995:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   12996:     my $offset = 0;
1.1055    raeburn  12997:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  12998:         $offset ++;
1.1065    raeburn  12999:         if ($action ne 'display') {
                   13000:             $offset ++;
                   13001:         }  
1.1055    raeburn  13002:         $output .= '<td><span class="LC_nobreak">'.
                   13003:                    '<label><input type="radio" name="archive_'.$count.
                   13004:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   13005:         my $text = $choices{$action};
                   13006:         if ($is_dir) {
                   13007:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   13008:             if ($action eq 'display') {
1.1059    raeburn  13009:                 $text = &mt('Add as folder');
1.1055    raeburn  13010:             }
1.1056    raeburn  13011:         } else {
                   13012:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   13013: 
                   13014:         }
                   13015:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   13016:         if ($action eq 'dependency') {
                   13017:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   13018:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   13019:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   13020:                        '<option value=""></option>'."\n".
                   13021:                        '</select>'."\n".
                   13022:                        '</div>';
1.1059    raeburn  13023:         } elsif ($action eq 'display') {
                   13024:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   13025:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   13026:                        '</div>';
1.1055    raeburn  13027:         }
1.1056    raeburn  13028:         $output .= '</td>';
1.1055    raeburn  13029:     }
                   13030:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   13031:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   13032:     for (my $i=0; $i<$depth; $i++) {
                   13033:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   13034:     }
                   13035:     if ($is_dir) {
                   13036:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   13037:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   13038:     } else {
                   13039:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   13040:     }
                   13041:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   13042:                &end_data_table_row();
                   13043:     return $output;
                   13044: }
                   13045: 
                   13046: sub archive_options_form {
1.1065    raeburn  13047:     my ($form,$display,$count,$hiddenelem) = @_;
                   13048:     my %lt = &Apache::lonlocal::texthash(
                   13049:                perm => 'Permanently remove archive file?',
                   13050:                hows => 'How should each extracted item be incorporated in the course?',
                   13051:                cont => 'Content actions for all',
                   13052:                addf => 'Add as folder/file',
                   13053:                incd => 'Include as dependency for a displayed file',
                   13054:                disc => 'Discard',
                   13055:                no   => 'No',
                   13056:                yes  => 'Yes',
                   13057:                save => 'Save',
                   13058:     );
                   13059:     my $output = <<"END";
                   13060: <form name="$form" method="post" action="">
                   13061: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   13062: <label>
                   13063:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   13064: </label>
                   13065: &nbsp;
                   13066: <label>
                   13067:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   13068: </span>
                   13069: </p>
                   13070: <input type="hidden" name="phase" value="decompress_cleanup" />
                   13071: <br />$lt{'hows'}
                   13072: <div class="LC_columnSection">
                   13073:   <fieldset>
                   13074:     <legend>$lt{'cont'}</legend>
                   13075:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   13076:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   13077:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   13078:   </fieldset>
                   13079: </div>
                   13080: END
                   13081:     return $output.
1.1055    raeburn  13082:            &start_data_table()."\n".
1.1065    raeburn  13083:            $display."\n".
1.1055    raeburn  13084:            &end_data_table()."\n".
                   13085:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   13086:            $hiddenelem.
1.1065    raeburn  13087:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  13088:            '</form>';
                   13089: }
                   13090: 
                   13091: sub archive_javascript {
1.1056    raeburn  13092:     my ($startcount,$numitems,$titles,$children) = @_;
                   13093:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  13094:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  13095:     my $scripttag = <<START;
                   13096: <script type="text/javascript">
                   13097: // <![CDATA[
                   13098: 
                   13099: function checkAll(form,prefix) {
                   13100:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   13101:     for (var i=0; i < form.elements.length; i++) {
                   13102:         var id = form.elements[i].id;
                   13103:         if ((id != '') && (id != undefined)) {
                   13104:             if (idstr.test(id)) {
                   13105:                 if (form.elements[i].type == 'radio') {
                   13106:                     form.elements[i].checked = true;
1.1056    raeburn  13107:                     var nostart = i-$startcount;
1.1059    raeburn  13108:                     var offset = nostart%7;
                   13109:                     var count = (nostart-offset)/7;    
1.1056    raeburn  13110:                     dependencyCheck(form,count,offset);
1.1055    raeburn  13111:                 }
                   13112:             }
                   13113:         }
                   13114:     }
                   13115: }
                   13116: 
                   13117: function propagateCheck(form,count) {
                   13118:     if (count > 0) {
1.1059    raeburn  13119:         var startelement = $startcount + ((count-1) * 7);
                   13120:         for (var j=1; j<6; j++) {
                   13121:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  13122:                 var item = startelement + j; 
                   13123:                 if (form.elements[item].type == 'radio') {
                   13124:                     if (form.elements[item].checked) {
                   13125:                         containerCheck(form,count,j);
                   13126:                         break;
                   13127:                     }
1.1055    raeburn  13128:                 }
                   13129:             }
                   13130:         }
                   13131:     }
                   13132: }
                   13133: 
                   13134: numitems = $numitems
1.1056    raeburn  13135: var titles = new Array(numitems);
                   13136: var parents = new Array(numitems);
1.1055    raeburn  13137: for (var i=0; i<numitems; i++) {
1.1056    raeburn  13138:     parents[i] = new Array;
1.1055    raeburn  13139: }
1.1059    raeburn  13140: var maintitle = '$maintitle';
1.1055    raeburn  13141: 
                   13142: START
                   13143: 
1.1056    raeburn  13144:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   13145:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  13146:         for (my $i=0; $i<@contents; $i ++) {
                   13147:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   13148:         }
                   13149:     }
                   13150: 
1.1056    raeburn  13151:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   13152:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   13153:     }
                   13154: 
1.1055    raeburn  13155:     $scripttag .= <<END;
                   13156: 
                   13157: function containerCheck(form,count,offset) {
                   13158:     if (count > 0) {
1.1056    raeburn  13159:         dependencyCheck(form,count,offset);
1.1059    raeburn  13160:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  13161:         form.elements[item].checked = true;
                   13162:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   13163:             if (parents[count].length > 0) {
                   13164:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  13165:                     containerCheck(form,parents[count][j],offset);
                   13166:                 }
                   13167:             }
                   13168:         }
                   13169:     }
                   13170: }
                   13171: 
                   13172: function dependencyCheck(form,count,offset) {
                   13173:     if (count > 0) {
1.1059    raeburn  13174:         var chosen = (offset+$startcount)+7*(count-1);
                   13175:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  13176:         var currtype = form.elements[depitem].type;
                   13177:         if (form.elements[chosen].value == 'dependency') {
                   13178:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   13179:             form.elements[depitem].options.length = 0;
                   13180:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11  raeburn  13181:             for (var i=1; i<=numitems; i++) {
                   13182:                 if (i == count) {
                   13183:                     continue;
                   13184:                 }
1.1059    raeburn  13185:                 var startelement = $startcount + (i-1) * 7;
                   13186:                 for (var j=1; j<6; j++) {
                   13187:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  13188:                         var item = startelement + j;
                   13189:                         if (form.elements[item].type == 'radio') {
                   13190:                             if (form.elements[item].checked) {
                   13191:                                 if (form.elements[item].value == 'display') {
                   13192:                                     var n = form.elements[depitem].options.length;
                   13193:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   13194:                                 }
                   13195:                             }
                   13196:                         }
                   13197:                     }
                   13198:                 }
                   13199:             }
                   13200:         } else {
                   13201:             document.getElementById('arc_depon_'+count).style.display='none';
                   13202:             form.elements[depitem].options.length = 0;
                   13203:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   13204:         }
1.1059    raeburn  13205:         titleCheck(form,count,offset);
1.1056    raeburn  13206:     }
                   13207: }
                   13208: 
                   13209: function propagateSelect(form,count,offset) {
                   13210:     if (count > 0) {
1.1065    raeburn  13211:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  13212:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   13213:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   13214:             if (parents[count].length > 0) {
                   13215:                 for (var j=0; j<parents[count].length; j++) {
                   13216:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  13217:                 }
                   13218:             }
                   13219:         }
                   13220:     }
                   13221: }
1.1056    raeburn  13222: 
                   13223: function containerSelect(form,count,offset,picked) {
                   13224:     if (count > 0) {
1.1065    raeburn  13225:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  13226:         if (form.elements[item].type == 'radio') {
                   13227:             if (form.elements[item].value == 'dependency') {
                   13228:                 if (form.elements[item+1].type == 'select-one') {
                   13229:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   13230:                         if (form.elements[item+1].options[i].value == picked) {
                   13231:                             form.elements[item+1].selectedIndex = i;
                   13232:                             break;
                   13233:                         }
                   13234:                     }
                   13235:                 }
                   13236:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   13237:                     if (parents[count].length > 0) {
                   13238:                         for (var j=0; j<parents[count].length; j++) {
                   13239:                             containerSelect(form,parents[count][j],offset,picked);
                   13240:                         }
                   13241:                     }
                   13242:                 }
                   13243:             }
                   13244:         }
                   13245:     }
                   13246: }
                   13247: 
1.1059    raeburn  13248: function titleCheck(form,count,offset) {
                   13249:     if (count > 0) {
                   13250:         var chosen = (offset+$startcount)+7*(count-1);
                   13251:         var depitem = $startcount + ((count-1) * 7) + 2;
                   13252:         var currtype = form.elements[depitem].type;
                   13253:         if (form.elements[chosen].value == 'display') {
                   13254:             document.getElementById('arc_title_'+count).style.display='block';
                   13255:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   13256:                 document.getElementById('archive_title_'+count).value=maintitle;
                   13257:             }
                   13258:         } else {
                   13259:             document.getElementById('arc_title_'+count).style.display='none';
                   13260:             if (currtype == 'text') { 
                   13261:                 document.getElementById('archive_title_'+count).value='';
                   13262:             }
                   13263:         }
                   13264:     }
                   13265:     return;
                   13266: }
                   13267: 
1.1055    raeburn  13268: // ]]>
                   13269: </script>
                   13270: END
                   13271:     return $scripttag;
                   13272: }
                   13273: 
                   13274: sub process_extracted_files {
1.1067    raeburn  13275:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  13276:     my $numitems = $env{'form.archive_count'};
1.1075.2.128  raeburn  13277:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  13278:     my @ids=&Apache::lonnet::current_machine_ids();
                   13279:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  13280:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  13281:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   13282:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   13283:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   13284:         $pathtocheck = "$dir_root/$destination";
                   13285:         $dir = $dir_root;
                   13286:         $ishome = 1;
                   13287:     } else {
                   13288:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   13289:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1075.2.128  raeburn  13290:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  13291:     }
                   13292:     my $currdir = "$dir_root/$destination";
                   13293:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   13294:     if ($env{'form.folderpath'}) {
                   13295:         my @items = split('&',$env{'form.folderpath'});
                   13296:         $folders{'0'} = $items[-2];
1.1075.2.17  raeburn  13297:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   13298:             $containers{'0'}='page';
                   13299:         } else {
                   13300:             $containers{'0'}='sequence';
                   13301:         }
1.1055    raeburn  13302:     }
                   13303:     my @archdirs = &get_env_multiple('form.archive_directory');
                   13304:     if ($numitems) {
                   13305:         for (my $i=1; $i<=$numitems; $i++) {
                   13306:             my $path = $env{'form.archive_content_'.$i};
                   13307:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   13308:                 my $item = $1;
                   13309:                 $toplevelitems{$item} = $i;
                   13310:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   13311:                     $is_dir{$item} = 1;
                   13312:                 }
                   13313:             }
                   13314:         }
                   13315:     }
1.1067    raeburn  13316:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  13317:     if (keys(%toplevelitems) > 0) {
                   13318:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  13319:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   13320:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  13321:     }
1.1066    raeburn  13322:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  13323:     if ($numitems) {
                   13324:         for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11  raeburn  13325:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  13326:             my $path = $env{'form.archive_content_'.$i};
                   13327:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13328:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   13329:                     if ($prefix ne '' && $path ne '') {
                   13330:                         if (-e $prefix.$path) {
1.1066    raeburn  13331:                             if ((@archdirs > 0) && 
                   13332:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   13333:                                 $todeletedir{$prefix.$path} = 1;
                   13334:                             } else {
                   13335:                                 $todelete{$prefix.$path} = 1;
                   13336:                             }
1.1055    raeburn  13337:                         }
                   13338:                     }
                   13339:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  13340:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  13341:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  13342:                     $docstitle = $env{'form.archive_title_'.$i};
                   13343:                     if ($docstitle eq '') {
                   13344:                         $docstitle = $title;
                   13345:                     }
1.1055    raeburn  13346:                     $outer = 0;
1.1056    raeburn  13347:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13348:                         if (@{$dirorder{$i}} > 0) {
                   13349:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  13350:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   13351:                                     $outer = $item;
                   13352:                                     last;
                   13353:                                 }
                   13354:                             }
                   13355:                         }
                   13356:                     }
                   13357:                     my ($errtext,$fatal) = 
                   13358:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   13359:                                                '/'.$folders{$outer}.'.'.
                   13360:                                                $containers{$outer});
                   13361:                     next if ($fatal);
                   13362:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   13363:                         if ($context eq 'coursedocs') {
1.1056    raeburn  13364:                             $mapinner{$i} = time;
1.1055    raeburn  13365:                             $folders{$i} = 'default_'.$mapinner{$i};
                   13366:                             $containers{$i} = 'sequence';
                   13367:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   13368:                                       $folders{$i}.'.'.$containers{$i};
                   13369:                             my $newidx = &LONCAPA::map::getresidx();
                   13370:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  13371:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  13372:                             push(@LONCAPA::map::order,$newidx);
                   13373:                             my ($outtext,$errtext) =
                   13374:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13375:                                                         $docuname.'/'.$folders{$outer}.
1.1075.2.11  raeburn  13376:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  13377:                             $newseqid{$i} = $newidx;
1.1067    raeburn  13378:                             unless ($errtext) {
1.1075.2.128  raeburn  13379:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   13380:                                                        &HTML::Entities::encode($docstitle,'<>&"'))..
                   13381:                                             '</li>'."\n";
1.1067    raeburn  13382:                             }
1.1055    raeburn  13383:                         }
                   13384:                     } else {
                   13385:                         if ($context eq 'coursedocs') {
                   13386:                             my $newidx=&LONCAPA::map::getresidx();
                   13387:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   13388:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   13389:                                       $title;
1.1075.2.128  raeburn  13390:                             if (($outer !~ /\D/) && ($mapinner{$outer} !~ /\D/) && ($newidx !~ /\D/)) {
                   13391:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   13392:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
1.1067    raeburn  13393:                                 }
1.1075.2.128  raeburn  13394:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13395:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   13396:                                 }
                   13397:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13398:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   13399:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   13400:                                         unless ($ishome) {
                   13401:                                             my $fetch = "$newdest{$i}/$title";
                   13402:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   13403:                                             $prompttofetch{$fetch} = 1;
                   13404:                                         }
                   13405:                                    }
                   13406:                                 }
                   13407:                                 $LONCAPA::map::resources[$newidx]=
                   13408:                                     $docstitle.':'.$url.':false:normal:res';
                   13409:                                 push(@LONCAPA::map::order, $newidx);
                   13410:                                 my ($outtext,$errtext)=
                   13411:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13412:                                                             $docuname.'/'.$folders{$outer}.
                   13413:                                                             '.'.$containers{$outer},1,1);
                   13414:                                 unless ($errtext) {
                   13415:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   13416:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   13417:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   13418:                                                    '</li>'."\n";
                   13419:                                     }
1.1067    raeburn  13420:                                 }
1.1075.2.128  raeburn  13421:                             } else {
                   13422:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13423:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1067    raeburn  13424:                             }
1.1055    raeburn  13425:                         }
                   13426:                     }
1.1075.2.11  raeburn  13427:                 }
                   13428:             } else {
1.1075.2.128  raeburn  13429:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13430:                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1075.2.11  raeburn  13431:             }
                   13432:         }
                   13433:         for (my $i=1; $i<=$numitems; $i++) {
                   13434:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   13435:             my $path = $env{'form.archive_content_'.$i};
                   13436:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13437:                 my ($title) = ($path =~ m{/([^/]+)$});
                   13438:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   13439:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   13440:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13441:                         my ($itemidx,$fullpath,$relpath);
                   13442:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   13443:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  13444:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11  raeburn  13445:                                 if ($dirorder{$i}->[$j] eq $container) {
                   13446:                                     $itemidx = $j;
1.1056    raeburn  13447:                                 }
                   13448:                             }
1.1075.2.11  raeburn  13449:                         }
                   13450:                         if ($itemidx eq '') {
                   13451:                             $itemidx =  0;
                   13452:                         }
                   13453:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   13454:                             if ($mapinner{$referrer{$i}}) {
                   13455:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   13456:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13457:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13458:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13459:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13460:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13461:                                             if (!-e $fullpath) {
                   13462:                                                 mkdir($fullpath,0755);
1.1056    raeburn  13463:                                             }
                   13464:                                         }
1.1075.2.11  raeburn  13465:                                     } else {
                   13466:                                         last;
1.1056    raeburn  13467:                                     }
1.1075.2.11  raeburn  13468:                                 }
                   13469:                             }
                   13470:                         } elsif ($newdest{$referrer{$i}}) {
                   13471:                             $fullpath = $newdest{$referrer{$i}};
                   13472:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13473:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   13474:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   13475:                                     last;
                   13476:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13477:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13478:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13479:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13480:                                         if (!-e $fullpath) {
                   13481:                                             mkdir($fullpath,0755);
1.1056    raeburn  13482:                                         }
                   13483:                                     }
1.1075.2.11  raeburn  13484:                                 } else {
                   13485:                                     last;
1.1056    raeburn  13486:                                 }
1.1075.2.11  raeburn  13487:                             }
                   13488:                         }
                   13489:                         if ($fullpath ne '') {
                   13490:                             if (-e "$prefix$path") {
1.1075.2.128  raeburn  13491:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   13492:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   13493:                                 }
1.1075.2.11  raeburn  13494:                             }
                   13495:                             if (-e "$fullpath/$title") {
                   13496:                                 my $showpath;
                   13497:                                 if ($relpath ne '') {
                   13498:                                     $showpath = "$relpath/$title";
                   13499:                                 } else {
                   13500:                                     $showpath = "/$title";
1.1056    raeburn  13501:                                 }
1.1075.2.128  raeburn  13502:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   13503:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   13504:                                            '</li>'."\n";
                   13505:                                 unless ($ishome) {
                   13506:                                     my $fetch = "$fullpath/$title";
                   13507:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   13508:                                     $prompttofetch{$fetch} = 1;
                   13509:                                 }
1.1055    raeburn  13510:                             }
                   13511:                         }
                   13512:                     }
1.1075.2.11  raeburn  13513:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   13514:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1075.2.128  raeburn  13515:                                     &HTML::Entities::encode($path,'<>&"'),
                   13516:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   13517:                                 '<br />';
1.1055    raeburn  13518:                 }
                   13519:             } else {
1.1075.2.128  raeburn  13520:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13521:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  13522:             }
                   13523:         }
                   13524:         if (keys(%todelete)) {
                   13525:             foreach my $key (keys(%todelete)) {
                   13526:                 unlink($key);
1.1066    raeburn  13527:             }
                   13528:         }
                   13529:         if (keys(%todeletedir)) {
                   13530:             foreach my $key (keys(%todeletedir)) {
                   13531:                 rmdir($key);
                   13532:             }
                   13533:         }
                   13534:         foreach my $dir (sort(keys(%is_dir))) {
                   13535:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   13536:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  13537:             }
                   13538:         }
1.1067    raeburn  13539:         if ($result ne '') {
                   13540:             $output .= '<ul>'."\n".
                   13541:                        $result."\n".
                   13542:                        '</ul>';
                   13543:         }
                   13544:         unless ($ishome) {
                   13545:             my $replicationfail;
                   13546:             foreach my $item (keys(%prompttofetch)) {
                   13547:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   13548:                 unless ($fetchresult eq 'ok') {
                   13549:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   13550:                 }
                   13551:             }
                   13552:             if ($replicationfail) {
                   13553:                 $output .= '<p class="LC_error">'.
                   13554:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   13555:                            $replicationfail.
                   13556:                            '</ul></p>';
                   13557:             }
                   13558:         }
1.1055    raeburn  13559:     } else {
                   13560:         $warning = &mt('No items found in archive.');
                   13561:     }
                   13562:     if ($error) {
                   13563:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   13564:                    $error.'</p>'."\n";
                   13565:     }
                   13566:     if ($warning) {
                   13567:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   13568:     }
                   13569:     return $output;
                   13570: }
                   13571: 
1.1066    raeburn  13572: sub cleanup_empty_dirs {
                   13573:     my ($path) = @_;
                   13574:     if (($path ne '') && (-d $path)) {
                   13575:         if (opendir(my $dirh,$path)) {
                   13576:             my @dircontents = grep(!/^\./,readdir($dirh));
                   13577:             my $numitems = 0;
                   13578:             foreach my $item (@dircontents) {
                   13579:                 if (-d "$path/$item") {
1.1075.2.28  raeburn  13580:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  13581:                     if (-e "$path/$item") {
                   13582:                         $numitems ++;
                   13583:                     }
                   13584:                 } else {
                   13585:                     $numitems ++;
                   13586:                 }
                   13587:             }
                   13588:             if ($numitems == 0) {
                   13589:                 rmdir($path);
                   13590:             }
                   13591:             closedir($dirh);
                   13592:         }
                   13593:     }
                   13594:     return;
                   13595: }
                   13596: 
1.41      ng       13597: =pod
1.45      matthew  13598: 
1.1075.2.56  raeburn  13599: =item * &get_folder_hierarchy()
1.1068    raeburn  13600: 
                   13601: Provides hierarchy of names of folders/sub-folders containing the current
                   13602: item,
                   13603: 
                   13604: Inputs: 3
                   13605:      - $navmap - navmaps object
                   13606: 
                   13607:      - $map - url for map (either the trigger itself, or map containing
                   13608:                            the resource, which is the trigger).
                   13609: 
                   13610:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   13611: 
                   13612: Outputs: 1 @pathitems - array of folder/subfolder names.
                   13613: 
                   13614: =cut
                   13615: 
                   13616: sub get_folder_hierarchy {
                   13617:     my ($navmap,$map,$showitem) = @_;
                   13618:     my @pathitems;
                   13619:     if (ref($navmap)) {
                   13620:         my $mapres = $navmap->getResourceByUrl($map);
                   13621:         if (ref($mapres)) {
                   13622:             my $pcslist = $mapres->map_hierarchy();
                   13623:             if ($pcslist ne '') {
                   13624:                 my @pcs = split(/,/,$pcslist);
                   13625:                 foreach my $pc (@pcs) {
                   13626:                     if ($pc == 1) {
1.1075.2.38  raeburn  13627:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  13628:                     } else {
                   13629:                         my $res = $navmap->getByMapPc($pc);
                   13630:                         if (ref($res)) {
                   13631:                             my $title = $res->compTitle();
                   13632:                             $title =~ s/\W+/_/g;
                   13633:                             if ($title ne '') {
                   13634:                                 push(@pathitems,$title);
                   13635:                             }
                   13636:                         }
                   13637:                     }
                   13638:                 }
                   13639:             }
1.1071    raeburn  13640:             if ($showitem) {
                   13641:                 if ($mapres->{ID} eq '0.0') {
1.1075.2.38  raeburn  13642:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  13643:                 } else {
                   13644:                     my $maptitle = $mapres->compTitle();
                   13645:                     $maptitle =~ s/\W+/_/g;
                   13646:                     if ($maptitle ne '') {
                   13647:                         push(@pathitems,$maptitle);
                   13648:                     }
1.1068    raeburn  13649:                 }
                   13650:             }
                   13651:         }
                   13652:     }
                   13653:     return @pathitems;
                   13654: }
                   13655: 
                   13656: =pod
                   13657: 
1.1015    raeburn  13658: =item * &get_turnedin_filepath()
                   13659: 
                   13660: Determines path in a user's portfolio file for storage of files uploaded
                   13661: to a specific essayresponse or dropbox item.
                   13662: 
                   13663: Inputs: 3 required + 1 optional.
                   13664: $symb is symb for resource, $uname and $udom are for current user (required).
                   13665: $caller is optional (can be "submission", if routine is called when storing
                   13666: an upoaded file when "Submit Answer" button was pressed).
                   13667: 
                   13668: Returns array containing $path and $multiresp. 
                   13669: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   13670: than one file upload item.  Callers of routine should append partid as a 
                   13671: subdirectory to $path in cases where $multiresp is 1.
                   13672: 
                   13673: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   13674: 
                   13675: =cut
                   13676: 
                   13677: sub get_turnedin_filepath {
                   13678:     my ($symb,$uname,$udom,$caller) = @_;
                   13679:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   13680:     my $turnindir;
                   13681:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   13682:     $turnindir = $userhash{'turnindir'};
                   13683:     my ($path,$multiresp);
                   13684:     if ($turnindir eq '') {
                   13685:         if ($caller eq 'submission') {
                   13686:             $turnindir = &mt('turned in');
                   13687:             $turnindir =~ s/\W+/_/g;
                   13688:             my %newhash = (
                   13689:                             'turnindir' => $turnindir,
                   13690:                           );
                   13691:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   13692:         }
                   13693:     }
                   13694:     if ($turnindir ne '') {
                   13695:         $path = '/'.$turnindir.'/';
                   13696:         my ($multipart,$turnin,@pathitems);
                   13697:         my $navmap = Apache::lonnavmaps::navmap->new();
                   13698:         if (defined($navmap)) {
                   13699:             my $mapres = $navmap->getResourceByUrl($map);
                   13700:             if (ref($mapres)) {
                   13701:                 my $pcslist = $mapres->map_hierarchy();
                   13702:                 if ($pcslist ne '') {
                   13703:                     foreach my $pc (split(/,/,$pcslist)) {
                   13704:                         my $res = $navmap->getByMapPc($pc);
                   13705:                         if (ref($res)) {
                   13706:                             my $title = $res->compTitle();
                   13707:                             $title =~ s/\W+/_/g;
                   13708:                             if ($title ne '') {
1.1075.2.48  raeburn  13709:                                 if (($pc > 1) && (length($title) > 12)) {
                   13710:                                     $title = substr($title,0,12);
                   13711:                                 }
1.1015    raeburn  13712:                                 push(@pathitems,$title);
                   13713:                             }
                   13714:                         }
                   13715:                     }
                   13716:                 }
                   13717:                 my $maptitle = $mapres->compTitle();
                   13718:                 $maptitle =~ s/\W+/_/g;
                   13719:                 if ($maptitle ne '') {
1.1075.2.48  raeburn  13720:                     if (length($maptitle) > 12) {
                   13721:                         $maptitle = substr($maptitle,0,12);
                   13722:                     }
1.1015    raeburn  13723:                     push(@pathitems,$maptitle);
                   13724:                 }
                   13725:                 unless ($env{'request.state'} eq 'construct') {
                   13726:                     my $res = $navmap->getBySymb($symb);
                   13727:                     if (ref($res)) {
                   13728:                         my $partlist = $res->parts();
                   13729:                         my $totaluploads = 0;
                   13730:                         if (ref($partlist) eq 'ARRAY') {
                   13731:                             foreach my $part (@{$partlist}) {
                   13732:                                 my @types = $res->responseType($part);
                   13733:                                 my @ids = $res->responseIds($part);
                   13734:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   13735:                                     if ($types[$i] eq 'essay') {
                   13736:                                         my $partid = $part.'_'.$ids[$i];
                   13737:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   13738:                                             $totaluploads ++;
                   13739:                                         }
                   13740:                                     }
                   13741:                                 }
                   13742:                             }
                   13743:                             if ($totaluploads > 1) {
                   13744:                                 $multiresp = 1;
                   13745:                             }
                   13746:                         }
                   13747:                     }
                   13748:                 }
                   13749:             } else {
                   13750:                 return;
                   13751:             }
                   13752:         } else {
                   13753:             return;
                   13754:         }
                   13755:         my $restitle=&Apache::lonnet::gettitle($symb);
                   13756:         $restitle =~ s/\W+/_/g;
                   13757:         if ($restitle eq '') {
                   13758:             $restitle = ($resurl =~ m{/[^/]+$});
                   13759:             if ($restitle eq '') {
                   13760:                 $restitle = time;
                   13761:             }
                   13762:         }
1.1075.2.48  raeburn  13763:         if (length($restitle) > 12) {
                   13764:             $restitle = substr($restitle,0,12);
                   13765:         }
1.1015    raeburn  13766:         push(@pathitems,$restitle);
                   13767:         $path .= join('/',@pathitems);
                   13768:     }
                   13769:     return ($path,$multiresp);
                   13770: }
                   13771: 
                   13772: =pod
                   13773: 
1.464     albertel 13774: =back
1.41      ng       13775: 
1.112     bowersj2 13776: =head1 CSV Upload/Handling functions
1.38      albertel 13777: 
1.41      ng       13778: =over 4
                   13779: 
1.648     raeburn  13780: =item * &upfile_store($r)
1.41      ng       13781: 
                   13782: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 13783: needs $env{'form.upfile'}
1.41      ng       13784: returns $datatoken to be put into hidden field
                   13785: 
                   13786: =cut
1.31      albertel 13787: 
                   13788: sub upfile_store {
                   13789:     my $r=shift;
1.258     albertel 13790:     $env{'form.upfile'}=~s/\r/\n/gs;
                   13791:     $env{'form.upfile'}=~s/\f/\n/gs;
                   13792:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   13793:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 13794: 
1.1075.2.128  raeburn  13795:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   13796:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   13797:                                      time.'_'.$$);
                   13798:     return if ($datatoken eq '');
                   13799: 
1.31      albertel 13800:     {
1.158     raeburn  13801:         my $datafile = $r->dir_config('lonDaemons').
                   13802:                            '/tmp/'.$datatoken.'.tmp';
1.1075.2.128  raeburn  13803:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 13804:             print $fh $env{'form.upfile'};
1.158     raeburn  13805:             close($fh);
                   13806:         }
1.31      albertel 13807:     }
                   13808:     return $datatoken;
                   13809: }
                   13810: 
1.56      matthew  13811: =pod
                   13812: 
1.1075.2.128  raeburn  13813: =item * &load_tmp_file($r,$datatoken)
1.41      ng       13814: 
                   13815: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1075.2.128  raeburn  13816: $datatoken is the name to assign to the temporary file.
1.258     albertel 13817: sets $env{'form.upfile'} to the contents of the file
1.41      ng       13818: 
                   13819: =cut
1.31      albertel 13820: 
                   13821: sub load_tmp_file {
1.1075.2.128  raeburn  13822:     my ($r,$datatoken) = @_;
                   13823:     return if ($datatoken eq '');
1.31      albertel 13824:     my @studentdata=();
                   13825:     {
1.158     raeburn  13826:         my $studentfile = $r->dir_config('lonDaemons').
1.1075.2.128  raeburn  13827:                               '/tmp/'.$datatoken.'.tmp';
                   13828:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  13829:             @studentdata=<$fh>;
                   13830:             close($fh);
                   13831:         }
1.31      albertel 13832:     }
1.258     albertel 13833:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 13834: }
                   13835: 
1.1075.2.128  raeburn  13836: sub valid_datatoken {
                   13837:     my ($datatoken) = @_;
1.1075.2.131  raeburn  13838:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1075.2.128  raeburn  13839:         return $datatoken;
                   13840:     }
                   13841:     return;
                   13842: }
                   13843: 
1.56      matthew  13844: =pod
                   13845: 
1.648     raeburn  13846: =item * &upfile_record_sep()
1.41      ng       13847: 
                   13848: Separate uploaded file into records
                   13849: returns array of records,
1.258     albertel 13850: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       13851: 
                   13852: =cut
1.31      albertel 13853: 
                   13854: sub upfile_record_sep {
1.258     albertel 13855:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 13856:     } else {
1.248     albertel 13857: 	my @records;
1.258     albertel 13858: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 13859: 	    if ($line=~/^\s*$/) { next; }
                   13860: 	    push(@records,$line);
                   13861: 	}
                   13862: 	return @records;
1.31      albertel 13863:     }
                   13864: }
                   13865: 
1.56      matthew  13866: =pod
                   13867: 
1.648     raeburn  13868: =item * &record_sep($record)
1.41      ng       13869: 
1.258     albertel 13870: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       13871: 
                   13872: =cut
                   13873: 
1.263     www      13874: sub takeleft {
                   13875:     my $index=shift;
                   13876:     return substr('0000'.$index,-4,4);
                   13877: }
                   13878: 
1.31      albertel 13879: sub record_sep {
                   13880:     my $record=shift;
                   13881:     my %components=();
1.258     albertel 13882:     if ($env{'form.upfiletype'} eq 'xml') {
                   13883:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 13884:         my $i=0;
1.356     albertel 13885:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 13886:             $field=~s/^(\"|\')//;
                   13887:             $field=~s/(\"|\')$//;
1.263     www      13888:             $components{&takeleft($i)}=$field;
1.31      albertel 13889:             $i++;
                   13890:         }
1.258     albertel 13891:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 13892:         my $i=0;
1.356     albertel 13893:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 13894:             $field=~s/^(\"|\')//;
                   13895:             $field=~s/(\"|\')$//;
1.263     www      13896:             $components{&takeleft($i)}=$field;
1.31      albertel 13897:             $i++;
                   13898:         }
                   13899:     } else {
1.561     www      13900:         my $separator=',';
1.480     banghart 13901:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      13902:             $separator=';';
1.480     banghart 13903:         }
1.31      albertel 13904:         my $i=0;
1.561     www      13905: # the character we are looking for to indicate the end of a quote or a record 
                   13906:         my $looking_for=$separator;
                   13907: # do not add the characters to the fields
                   13908:         my $ignore=0;
                   13909: # we just encountered a separator (or the beginning of the record)
                   13910:         my $just_found_separator=1;
                   13911: # store the field we are working on here
                   13912:         my $field='';
                   13913: # work our way through all characters in record
                   13914:         foreach my $character ($record=~/(.)/g) {
                   13915:             if ($character eq $looking_for) {
                   13916:                if ($character ne $separator) {
                   13917: # Found the end of a quote, again looking for separator
                   13918:                   $looking_for=$separator;
                   13919:                   $ignore=1;
                   13920:                } else {
                   13921: # Found a separator, store away what we got
                   13922:                   $components{&takeleft($i)}=$field;
                   13923: 	          $i++;
                   13924:                   $just_found_separator=1;
                   13925:                   $ignore=0;
                   13926:                   $field='';
                   13927:                }
                   13928:                next;
                   13929:             }
                   13930: # single or double quotation marks after a separator indicate beginning of a quote
                   13931: # we are now looking for the end of the quote and need to ignore separators
                   13932:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   13933:                $looking_for=$character;
                   13934:                next;
                   13935:             }
                   13936: # ignore would be true after we reached the end of a quote
                   13937:             if ($ignore) { next; }
                   13938:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   13939:             $field.=$character;
                   13940:             $just_found_separator=0; 
1.31      albertel 13941:         }
1.561     www      13942: # catch the very last entry, since we never encountered the separator
                   13943:         $components{&takeleft($i)}=$field;
1.31      albertel 13944:     }
                   13945:     return %components;
                   13946: }
                   13947: 
1.144     matthew  13948: ######################################################
                   13949: ######################################################
                   13950: 
1.56      matthew  13951: =pod
                   13952: 
1.648     raeburn  13953: =item * &upfile_select_html()
1.41      ng       13954: 
1.144     matthew  13955: Return HTML code to select a file from the users machine and specify 
                   13956: the file type.
1.41      ng       13957: 
                   13958: =cut
                   13959: 
1.144     matthew  13960: ######################################################
                   13961: ######################################################
1.31      albertel 13962: sub upfile_select_html {
1.144     matthew  13963:     my %Types = (
                   13964:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 13965:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  13966:                  space => &mt('Space separated'),
                   13967:                  tab   => &mt('Tabulator separated'),
                   13968: #                 xml   => &mt('HTML/XML'),
                   13969:                  );
                   13970:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  13971:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  13972:     foreach my $type (sort(keys(%Types))) {
                   13973:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   13974:     }
                   13975:     $Str .= "</select>\n";
                   13976:     return $Str;
1.31      albertel 13977: }
                   13978: 
1.301     albertel 13979: sub get_samples {
                   13980:     my ($records,$toget) = @_;
                   13981:     my @samples=({});
                   13982:     my $got=0;
                   13983:     foreach my $rec (@$records) {
                   13984: 	my %temp = &record_sep($rec);
                   13985: 	if (! grep(/\S/, values(%temp))) { next; }
                   13986: 	if (%temp) {
                   13987: 	    $samples[$got]=\%temp;
                   13988: 	    $got++;
                   13989: 	    if ($got == $toget) { last; }
                   13990: 	}
                   13991:     }
                   13992:     return \@samples;
                   13993: }
                   13994: 
1.144     matthew  13995: ######################################################
                   13996: ######################################################
                   13997: 
1.56      matthew  13998: =pod
                   13999: 
1.648     raeburn  14000: =item * &csv_print_samples($r,$records)
1.41      ng       14001: 
                   14002: Prints a table of sample values from each column uploaded $r is an
                   14003: Apache Request ref, $records is an arrayref from
                   14004: &Apache::loncommon::upfile_record_sep
                   14005: 
                   14006: =cut
                   14007: 
1.144     matthew  14008: ######################################################
                   14009: ######################################################
1.31      albertel 14010: sub csv_print_samples {
                   14011:     my ($r,$records) = @_;
1.662     bisitz   14012:     my $samples = &get_samples($records,5);
1.301     albertel 14013: 
1.594     raeburn  14014:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   14015:               &start_data_table_header_row());
1.356     albertel 14016:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   14017:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  14018:     $r->print(&end_data_table_header_row());
1.301     albertel 14019:     foreach my $hash (@$samples) {
1.594     raeburn  14020: 	$r->print(&start_data_table_row());
1.356     albertel 14021: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 14022: 	    $r->print('<td>');
1.356     albertel 14023: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 14024: 	    $r->print('</td>');
                   14025: 	}
1.594     raeburn  14026: 	$r->print(&end_data_table_row());
1.31      albertel 14027:     }
1.594     raeburn  14028:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 14029: }
                   14030: 
1.144     matthew  14031: ######################################################
                   14032: ######################################################
                   14033: 
1.56      matthew  14034: =pod
                   14035: 
1.648     raeburn  14036: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       14037: 
                   14038: Prints a table to create associations between values and table columns.
1.144     matthew  14039: 
1.41      ng       14040: $r is an Apache Request ref,
                   14041: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  14042: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       14043: 
                   14044: =cut
                   14045: 
1.144     matthew  14046: ######################################################
                   14047: ######################################################
1.31      albertel 14048: sub csv_print_select_table {
                   14049:     my ($r,$records,$d) = @_;
1.301     albertel 14050:     my $i=0;
                   14051:     my $samples = &get_samples($records,1);
1.144     matthew  14052:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  14053: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  14054:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  14055:               '<th>'.&mt('Column').'</th>'.
                   14056:               &end_data_table_header_row()."\n");
1.356     albertel 14057:     foreach my $array_ref (@$d) {
                   14058: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  14059: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 14060: 
1.875     bisitz   14061: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  14062: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 14063: 	$r->print('<option value="none"></option>');
1.356     albertel 14064: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   14065: 	    $r->print('<option value="'.$sample.'"'.
                   14066:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   14067:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 14068: 	}
1.594     raeburn  14069: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 14070: 	$i++;
                   14071:     }
1.594     raeburn  14072:     $r->print(&end_data_table());
1.31      albertel 14073:     $i--;
                   14074:     return $i;
                   14075: }
1.56      matthew  14076: 
1.144     matthew  14077: ######################################################
                   14078: ######################################################
                   14079: 
1.56      matthew  14080: =pod
1.31      albertel 14081: 
1.648     raeburn  14082: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       14083: 
                   14084: Prints a table of sample values from the upload and can make associate samples to internal names.
                   14085: 
                   14086: $r is an Apache Request ref,
                   14087: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   14088: $d is an array of 2 element arrays (internal name, displayed name)
                   14089: 
                   14090: =cut
                   14091: 
1.144     matthew  14092: ######################################################
                   14093: ######################################################
1.31      albertel 14094: sub csv_samples_select_table {
                   14095:     my ($r,$records,$d) = @_;
                   14096:     my $i=0;
1.144     matthew  14097:     #
1.662     bisitz   14098:     my $max_samples = 5;
                   14099:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  14100:     $r->print(&start_data_table().
                   14101:               &start_data_table_header_row().'<th>'.
                   14102:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   14103:               &end_data_table_header_row());
1.301     albertel 14104: 
                   14105:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  14106: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  14107: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 14108: 	foreach my $option (@$d) {
                   14109: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  14110: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 14111:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  14112:                       $display.'</option>');
1.31      albertel 14113: 	}
                   14114: 	$r->print('</select></td><td>');
1.662     bisitz   14115: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 14116: 	    if (defined($samples->[$line]{$key})) { 
                   14117: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   14118: 	    }
                   14119: 	}
1.594     raeburn  14120: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 14121: 	$i++;
                   14122:     }
1.594     raeburn  14123:     $r->print(&end_data_table());
1.31      albertel 14124:     $i--;
                   14125:     return($i);
1.115     matthew  14126: }
                   14127: 
1.144     matthew  14128: ######################################################
                   14129: ######################################################
                   14130: 
1.115     matthew  14131: =pod
                   14132: 
1.648     raeburn  14133: =item * &clean_excel_name($name)
1.115     matthew  14134: 
                   14135: Returns a replacement for $name which does not contain any illegal characters.
                   14136: 
                   14137: =cut
                   14138: 
1.144     matthew  14139: ######################################################
                   14140: ######################################################
1.115     matthew  14141: sub clean_excel_name {
                   14142:     my ($name) = @_;
                   14143:     $name =~ s/[:\*\?\/\\]//g;
                   14144:     if (length($name) > 31) {
                   14145:         $name = substr($name,0,31);
                   14146:     }
                   14147:     return $name;
1.25      albertel 14148: }
1.84      albertel 14149: 
1.85      albertel 14150: =pod
                   14151: 
1.648     raeburn  14152: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 14153: 
                   14154: Returns either 1 or undef
                   14155: 
                   14156: 1 if the part is to be hidden, undef if it is to be shown
                   14157: 
                   14158: Arguments are:
                   14159: 
                   14160: $id the id of the part to be checked
                   14161: $symb, optional the symb of the resource to check
                   14162: $udom, optional the domain of the user to check for
                   14163: $uname, optional the username of the user to check for
                   14164: 
                   14165: =cut
1.84      albertel 14166: 
                   14167: sub check_if_partid_hidden {
                   14168:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 14169:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 14170: 					 $symb,$udom,$uname);
1.141     albertel 14171:     my $truth=1;
                   14172:     #if the string starts with !, then the list is the list to show not hide
                   14173:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 14174:     my @hiddenlist=split(/,/,$hiddenparts);
                   14175:     foreach my $checkid (@hiddenlist) {
1.141     albertel 14176: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 14177:     }
1.141     albertel 14178:     return !$truth;
1.84      albertel 14179: }
1.127     matthew  14180: 
1.138     matthew  14181: 
                   14182: ############################################################
                   14183: ############################################################
                   14184: 
                   14185: =pod
                   14186: 
1.157     matthew  14187: =back 
                   14188: 
1.138     matthew  14189: =head1 cgi-bin script and graphing routines
                   14190: 
1.157     matthew  14191: =over 4
                   14192: 
1.648     raeburn  14193: =item * &get_cgi_id()
1.138     matthew  14194: 
                   14195: Inputs: none
                   14196: 
                   14197: Returns an id which can be used to pass environment variables
                   14198: to various cgi-bin scripts.  These environment variables will
                   14199: be removed from the users environment after a given time by
                   14200: the routine &Apache::lonnet::transfer_profile_to_env.
                   14201: 
                   14202: =cut
                   14203: 
                   14204: ############################################################
                   14205: ############################################################
1.152     albertel 14206: my $uniq=0;
1.136     matthew  14207: sub get_cgi_id {
1.154     albertel 14208:     $uniq=($uniq+1)%100000;
1.280     albertel 14209:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  14210: }
                   14211: 
1.127     matthew  14212: ############################################################
                   14213: ############################################################
                   14214: 
                   14215: =pod
                   14216: 
1.648     raeburn  14217: =item * &DrawBarGraph()
1.127     matthew  14218: 
1.138     matthew  14219: Facilitates the plotting of data in a (stacked) bar graph.
                   14220: Puts plot definition data into the users environment in order for 
                   14221: graph.png to plot it.  Returns an <img> tag for the plot.
                   14222: The bars on the plot are labeled '1','2',...,'n'.
                   14223: 
                   14224: Inputs:
                   14225: 
                   14226: =over 4
                   14227: 
                   14228: =item $Title: string, the title of the plot
                   14229: 
                   14230: =item $xlabel: string, text describing the X-axis of the plot
                   14231: 
                   14232: =item $ylabel: string, text describing the Y-axis of the plot
                   14233: 
                   14234: =item $Max: scalar, the maximum Y value to use in the plot
                   14235: If $Max is < any data point, the graph will not be rendered.
                   14236: 
1.140     matthew  14237: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  14238: they are plotted.  If undefined, default values will be used.
                   14239: 
1.178     matthew  14240: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   14241: 
1.138     matthew  14242: =item @Values: An array of array references.  Each array reference holds data
                   14243: to be plotted in a stacked bar chart.
                   14244: 
1.239     matthew  14245: =item If the final element of @Values is a hash reference the key/value
                   14246: pairs will be added to the graph definition.
                   14247: 
1.138     matthew  14248: =back
                   14249: 
                   14250: Returns:
                   14251: 
                   14252: An <img> tag which references graph.png and the appropriate identifying
                   14253: information for the plot.
                   14254: 
1.127     matthew  14255: =cut
                   14256: 
                   14257: ############################################################
                   14258: ############################################################
1.134     matthew  14259: sub DrawBarGraph {
1.178     matthew  14260:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  14261:     #
                   14262:     if (! defined($colors)) {
                   14263:         $colors = ['#33ff00', 
                   14264:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   14265:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   14266:                   ]; 
                   14267:     }
1.228     matthew  14268:     my $extra_settings = {};
                   14269:     if (ref($Values[-1]) eq 'HASH') {
                   14270:         $extra_settings = pop(@Values);
                   14271:     }
1.127     matthew  14272:     #
1.136     matthew  14273:     my $identifier = &get_cgi_id();
                   14274:     my $id = 'cgi.'.$identifier;        
1.129     matthew  14275:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  14276:         return '';
                   14277:     }
1.225     matthew  14278:     #
                   14279:     my @Labels;
                   14280:     if (defined($labels)) {
                   14281:         @Labels = @$labels;
                   14282:     } else {
                   14283:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1075.2.119  raeburn  14284:             push(@Labels,$i+1);
1.225     matthew  14285:         }
                   14286:     }
                   14287:     #
1.129     matthew  14288:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  14289:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  14290:     my %ValuesHash;
                   14291:     my $NumSets=1;
                   14292:     foreach my $array (@Values) {
                   14293:         next if (! ref($array));
1.136     matthew  14294:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  14295:             join(',',@$array);
1.129     matthew  14296:     }
1.127     matthew  14297:     #
1.136     matthew  14298:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  14299:     if ($NumBars < 3) {
                   14300:         $width = 120+$NumBars*32;
1.220     matthew  14301:         $xskip = 1;
1.225     matthew  14302:         $bar_width = 30;
                   14303:     } elsif ($NumBars < 5) {
                   14304:         $width = 120+$NumBars*20;
                   14305:         $xskip = 1;
                   14306:         $bar_width = 20;
1.220     matthew  14307:     } elsif ($NumBars < 10) {
1.136     matthew  14308:         $width = 120+$NumBars*15;
                   14309:         $xskip = 1;
                   14310:         $bar_width = 15;
                   14311:     } elsif ($NumBars <= 25) {
                   14312:         $width = 120+$NumBars*11;
                   14313:         $xskip = 5;
                   14314:         $bar_width = 8;
                   14315:     } elsif ($NumBars <= 50) {
                   14316:         $width = 120+$NumBars*8;
                   14317:         $xskip = 5;
                   14318:         $bar_width = 4;
                   14319:     } else {
                   14320:         $width = 120+$NumBars*8;
                   14321:         $xskip = 5;
                   14322:         $bar_width = 4;
                   14323:     }
                   14324:     #
1.137     matthew  14325:     $Max = 1 if ($Max < 1);
                   14326:     if ( int($Max) < $Max ) {
                   14327:         $Max++;
                   14328:         $Max = int($Max);
                   14329:     }
1.127     matthew  14330:     $Title  = '' if (! defined($Title));
                   14331:     $xlabel = '' if (! defined($xlabel));
                   14332:     $ylabel = '' if (! defined($ylabel));
1.369     www      14333:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   14334:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   14335:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  14336:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  14337:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   14338:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   14339:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   14340:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14341:     $ValuesHash{$id.'.height'}   = $height;
                   14342:     $ValuesHash{$id.'.width'}    = $width;
                   14343:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   14344:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   14345:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  14346:     #
1.228     matthew  14347:     # Deal with other parameters
                   14348:     while (my ($key,$value) = each(%$extra_settings)) {
                   14349:         $ValuesHash{$id.'.'.$key} = $value;
                   14350:     }
                   14351:     #
1.646     raeburn  14352:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  14353:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14354: }
                   14355: 
                   14356: ############################################################
                   14357: ############################################################
                   14358: 
                   14359: =pod
                   14360: 
1.648     raeburn  14361: =item * &DrawXYGraph()
1.137     matthew  14362: 
1.138     matthew  14363: Facilitates the plotting of data in an XY graph.
                   14364: Puts plot definition data into the users environment in order for 
                   14365: graph.png to plot it.  Returns an <img> tag for the plot.
                   14366: 
                   14367: Inputs:
                   14368: 
                   14369: =over 4
                   14370: 
                   14371: =item $Title: string, the title of the plot
                   14372: 
                   14373: =item $xlabel: string, text describing the X-axis of the plot
                   14374: 
                   14375: =item $ylabel: string, text describing the Y-axis of the plot
                   14376: 
                   14377: =item $Max: scalar, the maximum Y value to use in the plot
                   14378: If $Max is < any data point, the graph will not be rendered.
                   14379: 
                   14380: =item $colors: Array ref containing the hex color codes for the data to be 
                   14381: plotted in.  If undefined, default values will be used.
                   14382: 
                   14383: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14384: 
                   14385: =item $Ydata: Array ref containing Array refs.  
1.185     www      14386: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  14387: 
                   14388: =item %Values: hash indicating or overriding any default values which are 
                   14389: passed to graph.png.  
                   14390: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14391: 
                   14392: =back
                   14393: 
                   14394: Returns:
                   14395: 
                   14396: An <img> tag which references graph.png and the appropriate identifying
                   14397: information for the plot.
                   14398: 
1.137     matthew  14399: =cut
                   14400: 
                   14401: ############################################################
                   14402: ############################################################
                   14403: sub DrawXYGraph {
                   14404:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   14405:     #
                   14406:     # Create the identifier for the graph
                   14407:     my $identifier = &get_cgi_id();
                   14408:     my $id = 'cgi.'.$identifier;
                   14409:     #
                   14410:     $Title  = '' if (! defined($Title));
                   14411:     $xlabel = '' if (! defined($xlabel));
                   14412:     $ylabel = '' if (! defined($ylabel));
                   14413:     my %ValuesHash = 
                   14414:         (
1.369     www      14415:          $id.'.title'  => &escape($Title),
                   14416:          $id.'.xlabel' => &escape($xlabel),
                   14417:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  14418:          $id.'.y_max_value'=> $Max,
                   14419:          $id.'.labels'     => join(',',@$Xlabels),
                   14420:          $id.'.PlotType'   => 'XY',
                   14421:          );
                   14422:     #
                   14423:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14424:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14425:     }
                   14426:     #
                   14427:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   14428:         return '';
                   14429:     }
                   14430:     my $NumSets=1;
1.138     matthew  14431:     foreach my $array (@{$Ydata}){
1.137     matthew  14432:         next if (! ref($array));
                   14433:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   14434:     }
1.138     matthew  14435:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  14436:     #
                   14437:     # Deal with other parameters
                   14438:     while (my ($key,$value) = each(%Values)) {
                   14439:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  14440:     }
                   14441:     #
1.646     raeburn  14442:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  14443:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14444: }
                   14445: 
                   14446: ############################################################
                   14447: ############################################################
                   14448: 
                   14449: =pod
                   14450: 
1.648     raeburn  14451: =item * &DrawXYYGraph()
1.138     matthew  14452: 
                   14453: Facilitates the plotting of data in an XY graph with two Y axes.
                   14454: Puts plot definition data into the users environment in order for 
                   14455: graph.png to plot it.  Returns an <img> tag for the plot.
                   14456: 
                   14457: Inputs:
                   14458: 
                   14459: =over 4
                   14460: 
                   14461: =item $Title: string, the title of the plot
                   14462: 
                   14463: =item $xlabel: string, text describing the X-axis of the plot
                   14464: 
                   14465: =item $ylabel: string, text describing the Y-axis of the plot
                   14466: 
                   14467: =item $colors: Array ref containing the hex color codes for the data to be 
                   14468: plotted in.  If undefined, default values will be used.
                   14469: 
                   14470: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14471: 
                   14472: =item $Ydata1: The first data set
                   14473: 
                   14474: =item $Min1: The minimum value of the left Y-axis
                   14475: 
                   14476: =item $Max1: The maximum value of the left Y-axis
                   14477: 
                   14478: =item $Ydata2: The second data set
                   14479: 
                   14480: =item $Min2: The minimum value of the right Y-axis
                   14481: 
                   14482: =item $Max2: The maximum value of the left Y-axis
                   14483: 
                   14484: =item %Values: hash indicating or overriding any default values which are 
                   14485: passed to graph.png.  
                   14486: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14487: 
                   14488: =back
                   14489: 
                   14490: Returns:
                   14491: 
                   14492: An <img> tag which references graph.png and the appropriate identifying
                   14493: information for the plot.
1.136     matthew  14494: 
                   14495: =cut
                   14496: 
                   14497: ############################################################
                   14498: ############################################################
1.137     matthew  14499: sub DrawXYYGraph {
                   14500:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   14501:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  14502:     #
                   14503:     # Create the identifier for the graph
                   14504:     my $identifier = &get_cgi_id();
                   14505:     my $id = 'cgi.'.$identifier;
                   14506:     #
                   14507:     $Title  = '' if (! defined($Title));
                   14508:     $xlabel = '' if (! defined($xlabel));
                   14509:     $ylabel = '' if (! defined($ylabel));
                   14510:     my %ValuesHash = 
                   14511:         (
1.369     www      14512:          $id.'.title'  => &escape($Title),
                   14513:          $id.'.xlabel' => &escape($xlabel),
                   14514:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  14515:          $id.'.labels' => join(',',@$Xlabels),
                   14516:          $id.'.PlotType' => 'XY',
                   14517:          $id.'.NumSets' => 2,
1.137     matthew  14518:          $id.'.two_axes' => 1,
                   14519:          $id.'.y1_max_value' => $Max1,
                   14520:          $id.'.y1_min_value' => $Min1,
                   14521:          $id.'.y2_max_value' => $Max2,
                   14522:          $id.'.y2_min_value' => $Min2,
1.136     matthew  14523:          );
                   14524:     #
1.137     matthew  14525:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14526:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14527:     }
                   14528:     #
                   14529:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   14530:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  14531:         return '';
                   14532:     }
                   14533:     my $NumSets=1;
1.137     matthew  14534:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  14535:         next if (! ref($array));
                   14536:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  14537:     }
                   14538:     #
                   14539:     # Deal with other parameters
                   14540:     while (my ($key,$value) = each(%Values)) {
                   14541:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  14542:     }
                   14543:     #
1.646     raeburn  14544:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 14545:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  14546: }
                   14547: 
                   14548: ############################################################
                   14549: ############################################################
                   14550: 
                   14551: =pod
                   14552: 
1.157     matthew  14553: =back 
                   14554: 
1.139     matthew  14555: =head1 Statistics helper routines?  
                   14556: 
                   14557: Bad place for them but what the hell.
                   14558: 
1.157     matthew  14559: =over 4
                   14560: 
1.648     raeburn  14561: =item * &chartlink()
1.139     matthew  14562: 
                   14563: Returns a link to the chart for a specific student.  
                   14564: 
                   14565: Inputs:
                   14566: 
                   14567: =over 4
                   14568: 
                   14569: =item $linktext: The text of the link
                   14570: 
                   14571: =item $sname: The students username
                   14572: 
                   14573: =item $sdomain: The students domain
                   14574: 
                   14575: =back
                   14576: 
1.157     matthew  14577: =back
                   14578: 
1.139     matthew  14579: =cut
                   14580: 
                   14581: ############################################################
                   14582: ############################################################
                   14583: sub chartlink {
                   14584:     my ($linktext, $sname, $sdomain) = @_;
                   14585:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      14586:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 14587:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  14588:        '">'.$linktext.'</a>';
1.153     matthew  14589: }
                   14590: 
                   14591: #######################################################
                   14592: #######################################################
                   14593: 
                   14594: =pod
                   14595: 
                   14596: =head1 Course Environment Routines
1.157     matthew  14597: 
                   14598: =over 4
1.153     matthew  14599: 
1.648     raeburn  14600: =item * &restore_course_settings()
1.153     matthew  14601: 
1.648     raeburn  14602: =item * &store_course_settings()
1.153     matthew  14603: 
                   14604: Restores/Store indicated form parameters from the course environment.
                   14605: Will not overwrite existing values of the form parameters.
                   14606: 
                   14607: Inputs: 
                   14608: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   14609: 
                   14610: a hash ref describing the data to be stored.  For example:
                   14611:    
                   14612: %Save_Parameters = ('Status' => 'scalar',
                   14613:     'chartoutputmode' => 'scalar',
                   14614:     'chartoutputdata' => 'scalar',
                   14615:     'Section' => 'array',
1.373     raeburn  14616:     'Group' => 'array',
1.153     matthew  14617:     'StudentData' => 'array',
                   14618:     'Maps' => 'array');
                   14619: 
                   14620: Returns: both routines return nothing
                   14621: 
1.631     raeburn  14622: =back
                   14623: 
1.153     matthew  14624: =cut
                   14625: 
                   14626: #######################################################
                   14627: #######################################################
                   14628: sub store_course_settings {
1.496     albertel 14629:     return &store_settings($env{'request.course.id'},@_);
                   14630: }
                   14631: 
                   14632: sub store_settings {
1.153     matthew  14633:     # save to the environment
                   14634:     # appenv the same items, just to be safe
1.300     albertel 14635:     my $udom  = $env{'user.domain'};
                   14636:     my $uname = $env{'user.name'};
1.496     albertel 14637:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14638:     my %SaveHash;
                   14639:     my %AppHash;
                   14640:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 14641:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 14642:         my $envname = 'environment.'.$basename;
1.258     albertel 14643:         if (exists($env{'form.'.$setting})) {
1.153     matthew  14644:             # Save this value away
                   14645:             if ($type eq 'scalar' &&
1.258     albertel 14646:                 (! exists($env{$envname}) || 
                   14647:                  $env{$envname} ne $env{'form.'.$setting})) {
                   14648:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   14649:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  14650:             } elsif ($type eq 'array') {
                   14651:                 my $stored_form;
1.258     albertel 14652:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  14653:                     $stored_form = join(',',
                   14654:                                         map {
1.369     www      14655:                                             &escape($_);
1.258     albertel 14656:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  14657:                 } else {
                   14658:                     $stored_form = 
1.369     www      14659:                         &escape($env{'form.'.$setting});
1.153     matthew  14660:                 }
                   14661:                 # Determine if the array contents are the same.
1.258     albertel 14662:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  14663:                     $SaveHash{$basename} = $stored_form;
                   14664:                     $AppHash{$envname}   = $stored_form;
                   14665:                 }
                   14666:             }
                   14667:         }
                   14668:     }
                   14669:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 14670:                                           $udom,$uname);
1.153     matthew  14671:     if ($put_result !~ /^(ok|delayed)/) {
                   14672:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   14673:                                  'got error:'.$put_result);
                   14674:     }
                   14675:     # Make sure these settings stick around in this session, too
1.646     raeburn  14676:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  14677:     return;
                   14678: }
                   14679: 
                   14680: sub restore_course_settings {
1.499     albertel 14681:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 14682: }
                   14683: 
                   14684: sub restore_settings {
                   14685:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14686:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 14687:         next if (exists($env{'form.'.$setting}));
1.496     albertel 14688:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  14689:             '.'.$setting;
1.258     albertel 14690:         if (exists($env{$envname})) {
1.153     matthew  14691:             if ($type eq 'scalar') {
1.258     albertel 14692:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  14693:             } elsif ($type eq 'array') {
1.258     albertel 14694:                 $env{'form.'.$setting} = [ 
1.153     matthew  14695:                                            map { 
1.369     www      14696:                                                &unescape($_); 
1.258     albertel 14697:                                            } split(',',$env{$envname})
1.153     matthew  14698:                                            ];
                   14699:             }
                   14700:         }
                   14701:     }
1.127     matthew  14702: }
                   14703: 
1.618     raeburn  14704: #######################################################
                   14705: #######################################################
                   14706: 
                   14707: =pod
                   14708: 
                   14709: =head1 Domain E-mail Routines  
                   14710: 
                   14711: =over 4
                   14712: 
1.648     raeburn  14713: =item * &build_recipient_list()
1.618     raeburn  14714: 
1.1075.2.44  raeburn  14715: Build recipient lists for following types of e-mail:
1.766     raeburn  14716: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1075.2.44  raeburn  14717: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   14718: module change checking, student/employee ID conflict checks, as
                   14719: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   14720: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  14721: 
                   14722: Inputs:
1.1075.2.44  raeburn  14723: defmail (scalar - email address of default recipient),
                   14724: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   14725: requestsmail, updatesmail, or idconflictsmail).
                   14726: 
1.619     raeburn  14727: defdom (domain for which to retrieve configuration settings),
1.1075.2.44  raeburn  14728: 
                   14729: origmail (scalar - email address of recipient from loncapa.conf,
                   14730: i.e., predates configuration by DC via domainprefs.pm
1.618     raeburn  14731: 
1.1075.2.139  raeburn  14732: $requname username of requester (if mailing type is helpdeskmail)
                   14733: 
                   14734: $requdom domain of requester (if mailing type is helpdeskmail)
                   14735: 
                   14736: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
                   14737: 
1.655     raeburn  14738: Returns: comma separated list of addresses to which to send e-mail.
                   14739: 
                   14740: =back
1.618     raeburn  14741: 
                   14742: =cut
                   14743: 
                   14744: ############################################################
                   14745: ############################################################
                   14746: sub build_recipient_list {
1.1075.2.139  raeburn  14747:     my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618     raeburn  14748:     my @recipients;
1.1075.2.122  raeburn  14749:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  14750:     my %domconfig =
1.1075.2.122  raeburn  14751:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  14752:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  14753:         if (exists($domconfig{'contacts'}{$mailing})) {
                   14754:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   14755:                 my @contacts = ('adminemail','supportemail');
                   14756:                 foreach my $item (@contacts) {
                   14757:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   14758:                         my $addr = $domconfig{'contacts'}{$item}; 
                   14759:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14760:                             push(@recipients,$addr);
                   14761:                         }
1.619     raeburn  14762:                     }
1.1075.2.122  raeburn  14763:                 }
                   14764:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   14765:                 if ($mailing eq 'helpdeskmail') {
                   14766:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   14767:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   14768:                         my @ok_bccs;
                   14769:                         foreach my $bcc (@bccs) {
                   14770:                             $bcc =~ s/^\s+//g;
                   14771:                             $bcc =~ s/\s+$//g;
                   14772:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14773:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14774:                                     push(@ok_bccs,$bcc);
                   14775:                                 }
                   14776:                             }
                   14777:                         }
                   14778:                         if (@ok_bccs > 0) {
                   14779:                             $allbcc = join(', ',@ok_bccs);
                   14780:                         }
                   14781:                     }
                   14782:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  14783:                 }
                   14784:             }
1.766     raeburn  14785:         } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14786:             $lastresort = $origmail;
1.618     raeburn  14787:         }
1.1075.2.139  raeburn  14788:         if ($mailing eq 'helpdeskmail') {
                   14789:             if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
                   14790:                 (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
                   14791:                 my ($inststatus,$inststatus_checked);
                   14792:                 if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
                   14793:                     ($env{'user.domain'} ne 'public')) {
                   14794:                     $inststatus_checked = 1;
                   14795:                     $inststatus = $env{'environment.inststatus'};
                   14796:                 }
                   14797:                 unless ($inststatus_checked) {
                   14798:                     if (($requname ne '') && ($requdom ne '')) {
                   14799:                         if (($requname =~ /^$match_username$/) &&
                   14800:                             ($requdom =~ /^$match_domain$/) &&
                   14801:                             (&Apache::lonnet::domain($requdom))) {
                   14802:                             my $requhome = &Apache::lonnet::homeserver($requname,
                   14803:                                                                       $requdom);
                   14804:                             unless ($requhome eq 'no_host') {
                   14805:                                 my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
                   14806:                                 $inststatus = $userenv{'inststatus'};
                   14807:                                 $inststatus_checked = 1;
                   14808:                             }
                   14809:                         }
                   14810:                     }
                   14811:                 }
                   14812:                 unless ($inststatus_checked) {
                   14813:                     if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
                   14814:                         my %srch = (srchby     => 'email',
                   14815:                                     srchdomain => $defdom,
                   14816:                                     srchterm   => $reqemail,
                   14817:                                     srchtype   => 'exact');
                   14818:                         my %srch_results = &Apache::lonnet::usersearch(\%srch);
                   14819:                         foreach my $uname (keys(%srch_results)) {
                   14820:                             if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14821:                                 $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14822:                                 $inststatus_checked = 1;
                   14823:                                 last;
                   14824:                             }
                   14825:                         }
                   14826:                         unless ($inststatus_checked) {
                   14827:                             my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
                   14828:                             if ($dirsrchres eq 'ok') {
                   14829:                                 foreach my $uname (keys(%srch_results)) {
                   14830:                                     if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14831:                                         $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14832:                                         $inststatus_checked = 1;
                   14833:                                         last;
                   14834:                                     }
                   14835:                                 }
                   14836:                             }
                   14837:                         }
                   14838:                     }
                   14839:                 }
                   14840:                 if ($inststatus ne '') {
                   14841:                     foreach my $status (split(/\:/,$inststatus)) {
                   14842:                         if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
                   14843:                             my @contacts = ('adminemail','supportemail');
                   14844:                             foreach my $item (@contacts) {
                   14845:                                 if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
                   14846:                                     my $addr = $domconfig{'contacts'}{'overrides'}{$status};
                   14847:                                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14848:                                         push(@recipients,$addr);
                   14849:                                     }
                   14850:                                 }
                   14851:                             }
                   14852:                             $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
                   14853:                             if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
                   14854:                                 my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
                   14855:                                 my @ok_bccs;
                   14856:                                 foreach my $bcc (@bccs) {
                   14857:                                     $bcc =~ s/^\s+//g;
                   14858:                                     $bcc =~ s/\s+$//g;
                   14859:                                     if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14860:                                         if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14861:                                             push(@ok_bccs,$bcc);
                   14862:                                         }
                   14863:                                     }
                   14864:                                 }
                   14865:                                 if (@ok_bccs > 0) {
                   14866:                                     $allbcc = join(', ',@ok_bccs);
                   14867:                                 }
                   14868:                             }
                   14869:                             $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
                   14870:                             last;
                   14871:                         }
                   14872:                     }
                   14873:                 }
                   14874:             }
                   14875:         }
1.619     raeburn  14876:     } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14877:         $lastresort = $origmail;
                   14878:     }
1.1075.2.128  raeburn  14879:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1075.2.122  raeburn  14880:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   14881:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   14882:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   14883:             my %what = (
                   14884:                           perlvar => 1,
                   14885:                        );
                   14886:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   14887:             if ($primary) {
                   14888:                 my $gotaddr;
                   14889:                 my ($result,$returnhash) =
                   14890:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   14891:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   14892:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   14893:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   14894:                         $gotaddr = 1;
                   14895:                     }
                   14896:                 }
                   14897:                 unless ($gotaddr) {
                   14898:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   14899:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   14900:                     unless ($uintdom eq $intdom) {
                   14901:                         my %domconfig =
                   14902:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   14903:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   14904:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   14905:                                 my @contacts = ('adminemail','supportemail');
                   14906:                                 foreach my $item (@contacts) {
                   14907:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   14908:                                         my $addr = $domconfig{'contacts'}{$item};
                   14909:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14910:                                             push(@recipients,$addr);
                   14911:                                         }
                   14912:                                     }
                   14913:                                 }
                   14914:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   14915:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   14916:                                 }
                   14917:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   14918:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   14919:                                     my @ok_bccs;
                   14920:                                     foreach my $bcc (@bccs) {
                   14921:                                         $bcc =~ s/^\s+//g;
                   14922:                                         $bcc =~ s/\s+$//g;
                   14923:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14924:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14925:                                                 push(@ok_bccs,$bcc);
                   14926:                                             }
                   14927:                                         }
                   14928:                                     }
                   14929:                                     if (@ok_bccs > 0) {
                   14930:                                         $allbcc = join(', ',@ok_bccs);
                   14931:                                     }
                   14932:                                 }
                   14933:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   14934:                             }
                   14935:                         }
                   14936:                     }
                   14937:                 }
                   14938:             }
                   14939:         }
1.618     raeburn  14940:     }
1.688     raeburn  14941:     if (defined($defmail)) {
                   14942:         if ($defmail ne '') {
                   14943:             push(@recipients,$defmail);
                   14944:         }
1.618     raeburn  14945:     }
                   14946:     if ($otheremails) {
1.619     raeburn  14947:         my @others;
                   14948:         if ($otheremails =~ /,/) {
                   14949:             @others = split(/,/,$otheremails);
1.618     raeburn  14950:         } else {
1.619     raeburn  14951:             push(@others,$otheremails);
                   14952:         }
                   14953:         foreach my $addr (@others) {
                   14954:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14955:                 push(@recipients,$addr);
                   14956:             }
1.618     raeburn  14957:         }
                   14958:     }
1.1075.2.128  raeburn  14959:     if ($mailing eq 'helpdeskmail') {
1.1075.2.122  raeburn  14960:         if ((!@recipients) && ($lastresort ne '')) {
                   14961:             push(@recipients,$lastresort);
                   14962:         }
                   14963:     } elsif ($lastresort ne '') {
                   14964:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   14965:             push(@recipients,$lastresort);
                   14966:         }
                   14967:     }
                   14968:     my $recipientlist = join(',',@recipients);
                   14969:     if (wantarray) {
                   14970:         return ($recipientlist,$allbcc,$addtext);
                   14971:     } else {
                   14972:         return $recipientlist;
                   14973:     }
1.618     raeburn  14974: }
                   14975: 
1.127     matthew  14976: ############################################################
                   14977: ############################################################
1.154     albertel 14978: 
1.655     raeburn  14979: =pod
                   14980: 
                   14981: =head1 Course Catalog Routines
                   14982: 
                   14983: =over 4
                   14984: 
                   14985: =item * &gather_categories()
                   14986: 
                   14987: Converts category definitions - keys of categories hash stored in  
                   14988: coursecategories in configuration.db on the primary library server in a 
                   14989: domain - to an array.  Also generates javascript and idx hash used to 
                   14990: generate Domain Coordinator interface for editing Course Categories.
                   14991: 
                   14992: Inputs:
1.663     raeburn  14993: 
1.655     raeburn  14994: categories (reference to hash of category definitions).
1.663     raeburn  14995: 
1.655     raeburn  14996: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14997:       categories and subcategories).
1.663     raeburn  14998: 
1.655     raeburn  14999: idx (reference to hash of counters used in Domain Coordinator interface for 
                   15000:       editing Course Categories).
1.663     raeburn  15001: 
1.655     raeburn  15002: jsarray (reference to array of categories used to create Javascript arrays for
                   15003:          Domain Coordinator interface for editing Course Categories).
                   15004: 
                   15005: Returns: nothing
                   15006: 
                   15007: Side effects: populates cats, idx and jsarray. 
                   15008: 
                   15009: =cut
                   15010: 
                   15011: sub gather_categories {
                   15012:     my ($categories,$cats,$idx,$jsarray) = @_;
                   15013:     my %counters;
                   15014:     my $num = 0;
                   15015:     foreach my $item (keys(%{$categories})) {
                   15016:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   15017:         if ($container eq '' && $depth == 0) {
                   15018:             $cats->[$depth][$categories->{$item}] = $cat;
                   15019:         } else {
                   15020:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   15021:         }
                   15022:         my ($escitem,$tail) = split(/:/,$item,2);
                   15023:         if ($counters{$tail} eq '') {
                   15024:             $counters{$tail} = $num;
                   15025:             $num ++;
                   15026:         }
                   15027:         if (ref($idx) eq 'HASH') {
                   15028:             $idx->{$item} = $counters{$tail};
                   15029:         }
                   15030:         if (ref($jsarray) eq 'ARRAY') {
                   15031:             push(@{$jsarray->[$counters{$tail}]},$item);
                   15032:         }
                   15033:     }
                   15034:     return;
                   15035: }
                   15036: 
                   15037: =pod
                   15038: 
                   15039: =item * &extract_categories()
                   15040: 
                   15041: Used to generate breadcrumb trails for course categories.
                   15042: 
                   15043: Inputs:
1.663     raeburn  15044: 
1.655     raeburn  15045: categories (reference to hash of category definitions).
1.663     raeburn  15046: 
1.655     raeburn  15047: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   15048:       categories and subcategories).
1.663     raeburn  15049: 
1.655     raeburn  15050: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  15051: 
1.655     raeburn  15052: allitems (reference to hash - key is category key 
                   15053:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  15054: 
1.655     raeburn  15055: idx (reference to hash of counters used in Domain Coordinator interface for
                   15056:       editing Course Categories).
1.663     raeburn  15057: 
1.655     raeburn  15058: jsarray (reference to array of categories used to create Javascript arrays for
                   15059:          Domain Coordinator interface for editing Course Categories).
                   15060: 
1.665     raeburn  15061: subcats (reference to hash of arrays containing all subcategories within each 
                   15062:          category, -recursive)
                   15063: 
1.1075.2.132  raeburn  15064: maxd (reference to hash used to hold max depth for all top-level categories).
                   15065: 
1.655     raeburn  15066: Returns: nothing
                   15067: 
                   15068: Side effects: populates trails and allitems hash references.
                   15069: 
                   15070: =cut
                   15071: 
                   15072: sub extract_categories {
1.1075.2.132  raeburn  15073:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655     raeburn  15074:     if (ref($categories) eq 'HASH') {
                   15075:         &gather_categories($categories,$cats,$idx,$jsarray);
                   15076:         if (ref($cats->[0]) eq 'ARRAY') {
                   15077:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   15078:                 my $name = $cats->[0][$i];
                   15079:                 my $item = &escape($name).'::0';
                   15080:                 my $trailstr;
                   15081:                 if ($name eq 'instcode') {
                   15082:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  15083:                 } elsif ($name eq 'communities') {
                   15084:                     $trailstr = &mt('Communities');
1.655     raeburn  15085:                 } else {
                   15086:                     $trailstr = $name;
                   15087:                 }
                   15088:                 if ($allitems->{$item} eq '') {
                   15089:                     push(@{$trails},$trailstr);
                   15090:                     $allitems->{$item} = scalar(@{$trails})-1;
                   15091:                 }
                   15092:                 my @parents = ($name);
                   15093:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   15094:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   15095:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  15096:                         if (ref($subcats) eq 'HASH') {
                   15097:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   15098:                         }
1.1075.2.132  raeburn  15099:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665     raeburn  15100:                     }
                   15101:                 } else {
                   15102:                     if (ref($subcats) eq 'HASH') {
                   15103:                         $subcats->{$item} = [];
1.655     raeburn  15104:                     }
1.1075.2.132  raeburn  15105:                     if (ref($maxd) eq 'HASH') {
                   15106:                         $maxd->{$name} = 1;
                   15107:                     }
1.655     raeburn  15108:                 }
                   15109:             }
                   15110:         }
                   15111:     }
                   15112:     return;
                   15113: }
                   15114: 
                   15115: =pod
                   15116: 
1.1075.2.56  raeburn  15117: =item * &recurse_categories()
1.655     raeburn  15118: 
                   15119: Recursively used to generate breadcrumb trails for course categories.
                   15120: 
                   15121: Inputs:
1.663     raeburn  15122: 
1.655     raeburn  15123: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   15124:       categories and subcategories).
1.663     raeburn  15125: 
1.655     raeburn  15126: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  15127: 
                   15128: category (current course category, for which breadcrumb trail is being generated).
                   15129: 
                   15130: trails (reference to array of breadcrumb trails for each category).
                   15131: 
1.655     raeburn  15132: allitems (reference to hash - key is category key
                   15133:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  15134: 
1.655     raeburn  15135: parents (array containing containers directories for current category, 
                   15136:          back to top level). 
                   15137: 
                   15138: Returns: nothing
                   15139: 
                   15140: Side effects: populates trails and allitems hash references
                   15141: 
                   15142: =cut
                   15143: 
                   15144: sub recurse_categories {
1.1075.2.132  raeburn  15145:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655     raeburn  15146:     my $shallower = $depth - 1;
                   15147:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   15148:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   15149:             my $name = $cats->[$depth]{$category}[$k];
                   15150:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   15151:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   15152:             if ($allitems->{$item} eq '') {
                   15153:                 push(@{$trails},$trailstr);
                   15154:                 $allitems->{$item} = scalar(@{$trails})-1;
                   15155:             }
                   15156:             my $deeper = $depth+1;
                   15157:             push(@{$parents},$category);
1.665     raeburn  15158:             if (ref($subcats) eq 'HASH') {
                   15159:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   15160:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   15161:                     my $higher;
                   15162:                     if ($j > 0) {
                   15163:                         $higher = &escape($parents->[$j]).':'.
                   15164:                                   &escape($parents->[$j-1]).':'.$j;
                   15165:                     } else {
                   15166:                         $higher = &escape($parents->[$j]).'::'.$j;
                   15167:                     }
                   15168:                     push(@{$subcats->{$higher}},$subcat);
                   15169:                 }
                   15170:             }
                   15171:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1075.2.132  raeburn  15172:                                 $subcats,$maxd);
1.655     raeburn  15173:             pop(@{$parents});
                   15174:         }
                   15175:     } else {
                   15176:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.132  raeburn  15177:         my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  15178:         if ($allitems->{$item} eq '') {
                   15179:             push(@{$trails},$trailstr);
                   15180:             $allitems->{$item} = scalar(@{$trails})-1;
                   15181:         }
1.1075.2.132  raeburn  15182:         if (ref($maxd) eq 'HASH') {
                   15183:             if ($depth > $maxd->{$parents->[0]}) {
                   15184:                 $maxd->{$parents->[0]} = $depth;
                   15185:             }
                   15186:         }
1.655     raeburn  15187:     }
                   15188:     return;
                   15189: }
                   15190: 
1.663     raeburn  15191: =pod
                   15192: 
1.1075.2.56  raeburn  15193: =item * &assign_categories_table()
1.663     raeburn  15194: 
                   15195: Create a datatable for display of hierarchical categories in a domain,
                   15196: with checkboxes to allow a course to be categorized. 
                   15197: 
                   15198: Inputs:
                   15199: 
                   15200: cathash - reference to hash of categories defined for the domain (from
                   15201:           configuration.db)
                   15202: 
                   15203: currcat - scalar with an & separated list of categories assigned to a course. 
                   15204: 
1.919     raeburn  15205: type    - scalar contains course type (Course or Community).
                   15206: 
1.1075.2.117  raeburn  15207: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   15208:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   15209: 
1.663     raeburn  15210: Returns: $output (markup to be displayed) 
                   15211: 
                   15212: =cut
                   15213: 
                   15214: sub assign_categories_table {
1.1075.2.117  raeburn  15215:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  15216:     my $output;
                   15217:     if (ref($cathash) eq 'HASH') {
1.1075.2.132  raeburn  15218:         my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
                   15219:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663     raeburn  15220:         $maxdepth = scalar(@cats);
                   15221:         if (@cats > 0) {
                   15222:             my $itemcount = 0;
                   15223:             if (ref($cats[0]) eq 'ARRAY') {
                   15224:                 my @currcategories;
                   15225:                 if ($currcat ne '') {
                   15226:                     @currcategories = split('&',$currcat);
                   15227:                 }
1.919     raeburn  15228:                 my $table;
1.663     raeburn  15229:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   15230:                     my $parent = $cats[0][$i];
1.919     raeburn  15231:                     next if ($parent eq 'instcode');
                   15232:                     if ($type eq 'Community') {
                   15233:                         next unless ($parent eq 'communities');
                   15234:                     } else {
                   15235:                         next if ($parent eq 'communities');
                   15236:                     }
1.663     raeburn  15237:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   15238:                     my $item = &escape($parent).'::0';
                   15239:                     my $checked = '';
                   15240:                     if (@currcategories > 0) {
                   15241:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   15242:                             $checked = ' checked="checked"';
1.663     raeburn  15243:                         }
                   15244:                     }
1.919     raeburn  15245:                     my $parent_title = $parent;
                   15246:                     if ($parent eq 'communities') {
                   15247:                         $parent_title = &mt('Communities');
                   15248:                     }
                   15249:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   15250:                               '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  15251:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  15252:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  15253:                     my $depth = 1;
                   15254:                     push(@path,$parent);
1.1075.2.117  raeburn  15255:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  15256:                     pop(@path);
1.919     raeburn  15257:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  15258:                     $itemcount ++;
                   15259:                 }
1.919     raeburn  15260:                 if ($itemcount) {
                   15261:                     $output = &Apache::loncommon::start_data_table().
                   15262:                               $table.
                   15263:                               &Apache::loncommon::end_data_table();
                   15264:                 }
1.663     raeburn  15265:             }
                   15266:         }
                   15267:     }
                   15268:     return $output;
                   15269: }
                   15270: 
                   15271: =pod
                   15272: 
1.1075.2.56  raeburn  15273: =item * &assign_category_rows()
1.663     raeburn  15274: 
                   15275: Create a datatable row for display of nested categories in a domain,
                   15276: with checkboxes to allow a course to be categorized,called recursively.
                   15277: 
                   15278: Inputs:
                   15279: 
                   15280: itemcount - track row number for alternating colors
                   15281: 
                   15282: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   15283:       categories and subcategories.
                   15284: 
                   15285: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   15286: 
                   15287: parent - parent of current category item
                   15288: 
                   15289: path - Array containing all categories back up through the hierarchy from the
                   15290:        current category to the top level.
                   15291: 
                   15292: currcategories - reference to array of current categories assigned to the course
                   15293: 
1.1075.2.117  raeburn  15294: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   15295:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   15296: 
1.663     raeburn  15297: Returns: $output (markup to be displayed).
                   15298: 
                   15299: =cut
                   15300: 
                   15301: sub assign_category_rows {
1.1075.2.117  raeburn  15302:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  15303:     my ($text,$name,$item,$chgstr);
                   15304:     if (ref($cats) eq 'ARRAY') {
                   15305:         my $maxdepth = scalar(@{$cats});
                   15306:         if (ref($cats->[$depth]) eq 'HASH') {
                   15307:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   15308:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   15309:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1075.2.45  raeburn  15310:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  15311:                 for (my $j=0; $j<$numchildren; $j++) {
                   15312:                     $name = $cats->[$depth]{$parent}[$j];
                   15313:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   15314:                     my $deeper = $depth+1;
                   15315:                     my $checked = '';
                   15316:                     if (ref($currcategories) eq 'ARRAY') {
                   15317:                         if (@{$currcategories} > 0) {
                   15318:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   15319:                                 $checked = ' checked="checked"';
1.663     raeburn  15320:                             }
                   15321:                         }
                   15322:                     }
1.664     raeburn  15323:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   15324:                              '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  15325:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  15326:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   15327:                              '</td><td>';
1.663     raeburn  15328:                     if (ref($path) eq 'ARRAY') {
                   15329:                         push(@{$path},$name);
1.1075.2.117  raeburn  15330:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  15331:                         pop(@{$path});
                   15332:                     }
                   15333:                     $text .= '</td></tr>';
                   15334:                 }
                   15335:                 $text .= '</table></td>';
                   15336:             }
                   15337:         }
                   15338:     }
                   15339:     return $text;
                   15340: }
                   15341: 
1.1075.2.69  raeburn  15342: =pod
                   15343: 
                   15344: =back
                   15345: 
                   15346: =cut
                   15347: 
1.655     raeburn  15348: ############################################################
                   15349: ############################################################
                   15350: 
                   15351: 
1.443     albertel 15352: sub commit_customrole {
1.664     raeburn  15353:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  15354:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 15355:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   15356:                          ($end?', ending '.localtime($end):'').': <b>'.
                   15357:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  15358:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 15359:                  '</b><br />';
                   15360:     return $output;
                   15361: }
                   15362: 
                   15363: sub commit_standardrole {
1.1075.2.31  raeburn  15364:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541     raeburn  15365:     my ($output,$logmsg,$linefeed);
                   15366:     if ($context eq 'auto') {
                   15367:         $linefeed = "\n";
                   15368:     } else {
                   15369:         $linefeed = "<br />\n";
                   15370:     }  
1.443     albertel 15371:     if ($three eq 'st') {
1.541     raeburn  15372:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31  raeburn  15373:                                          $one,$two,$sec,$context,$credits);
1.541     raeburn  15374:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  15375:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   15376:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 15377:         } else {
1.541     raeburn  15378:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 15379:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  15380:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   15381:             if ($context eq 'auto') {
                   15382:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   15383:             } else {
                   15384:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   15385:                &mt('Add to classlist').': <b>ok</b>';
                   15386:             }
                   15387:             $output .= $linefeed;
1.443     albertel 15388:         }
                   15389:     } else {
                   15390:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   15391:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  15392:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  15393:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  15394:         if ($context eq 'auto') {
                   15395:             $output .= $result.$linefeed;
                   15396:         } else {
                   15397:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   15398:         }
1.443     albertel 15399:     }
                   15400:     return $output;
                   15401: }
                   15402: 
                   15403: sub commit_studentrole {
1.1075.2.31  raeburn  15404:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
                   15405:         $credits) = @_;
1.626     raeburn  15406:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  15407:     if ($context eq 'auto') {
                   15408:         $linefeed = "\n";
                   15409:     } else {
                   15410:         $linefeed = '<br />'."\n";
                   15411:     }
1.443     albertel 15412:     if (defined($one) && defined($two)) {
                   15413:         my $cid=$one.'_'.$two;
                   15414:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   15415:         my $secchange = 0;
                   15416:         my $expire_role_result;
                   15417:         my $modify_section_result;
1.628     raeburn  15418:         if ($oldsec ne '-1') { 
                   15419:             if ($oldsec ne $sec) {
1.443     albertel 15420:                 $secchange = 1;
1.628     raeburn  15421:                 my $now = time;
1.443     albertel 15422:                 my $uurl='/'.$cid;
                   15423:                 $uurl=~s/\_/\//g;
                   15424:                 if ($oldsec) {
                   15425:                     $uurl.='/'.$oldsec;
                   15426:                 }
1.626     raeburn  15427:                 $oldsecurl = $uurl;
1.628     raeburn  15428:                 $expire_role_result = 
1.652     raeburn  15429:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  15430:                 if ($env{'request.course.sec'} ne '') { 
                   15431:                     if ($expire_role_result eq 'refused') {
                   15432:                         my @roles = ('st');
                   15433:                         my @statuses = ('previous');
                   15434:                         my @roledoms = ($one);
                   15435:                         my $withsec = 1;
                   15436:                         my %roleshash = 
                   15437:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   15438:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   15439:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   15440:                             my ($oldstart,$oldend) = 
                   15441:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   15442:                             if ($oldend > 0 && $oldend <= $now) {
                   15443:                                 $expire_role_result = 'ok';
                   15444:                             }
                   15445:                         }
                   15446:                     }
                   15447:                 }
1.443     albertel 15448:                 $result = $expire_role_result;
                   15449:             }
                   15450:         }
                   15451:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31  raeburn  15452:             $modify_section_result = 
                   15453:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   15454:                                                            undef,undef,undef,$sec,
                   15455:                                                            $end,$start,'','',$cid,
                   15456:                                                            '',$context,$credits);
1.443     albertel 15457:             if ($modify_section_result =~ /^ok/) {
                   15458:                 if ($secchange == 1) {
1.628     raeburn  15459:                     if ($sec eq '') {
                   15460:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   15461:                     } else {
                   15462:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   15463:                     }
1.443     albertel 15464:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  15465:                     if ($sec eq '') {
                   15466:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   15467:                     } else {
                   15468:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15469:                     }
1.443     albertel 15470:                 } else {
1.628     raeburn  15471:                     if ($sec eq '') {
                   15472:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   15473:                     } else {
                   15474:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15475:                     }
1.443     albertel 15476:                 }
                   15477:             } else {
1.628     raeburn  15478:                 if ($secchange) {       
                   15479:                     $$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;
                   15480:                 } else {
                   15481:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   15482:                 }
1.443     albertel 15483:             }
                   15484:             $result = $modify_section_result;
                   15485:         } elsif ($secchange == 1) {
1.628     raeburn  15486:             if ($oldsec eq '') {
1.1075.2.20  raeburn  15487:                 $$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  15488:             } else {
                   15489:                 $$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;
                   15490:             }
1.626     raeburn  15491:             if ($expire_role_result eq 'refused') {
                   15492:                 my $newsecurl = '/'.$cid;
                   15493:                 $newsecurl =~ s/\_/\//g;
                   15494:                 if ($sec ne '') {
                   15495:                     $newsecurl.='/'.$sec;
                   15496:                 }
                   15497:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   15498:                     if ($sec eq '') {
                   15499:                         $$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;
                   15500:                     } else {
                   15501:                         $$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;
                   15502:                     }
                   15503:                 }
                   15504:             }
1.443     albertel 15505:         }
                   15506:     } else {
1.626     raeburn  15507:         $$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 15508:         $result = "error: incomplete course id\n";
                   15509:     }
                   15510:     return $result;
                   15511: }
                   15512: 
1.1075.2.25  raeburn  15513: sub show_role_extent {
                   15514:     my ($scope,$context,$role) = @_;
                   15515:     $scope =~ s{^/}{};
                   15516:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   15517:     push(@courseroles,'co');
                   15518:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   15519:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   15520:         $scope =~ s{/}{_};
                   15521:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   15522:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   15523:         my ($audom,$auname) = split(/\//,$scope);
                   15524:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   15525:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   15526:     } else {
                   15527:         $scope =~ s{/$}{};
                   15528:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   15529:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   15530:     }
                   15531: }
                   15532: 
1.443     albertel 15533: ############################################################
                   15534: ############################################################
                   15535: 
1.566     albertel 15536: sub check_clone {
1.578     raeburn  15537:     my ($args,$linefeed) = @_;
1.566     albertel 15538:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   15539:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   15540:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1075.2.161.  .1(raebu 15541:21):     my $clonetitle;
                   15542:21):     my @clonemsg;
1.566     albertel 15543:     my $can_clone = 0;
1.944     raeburn  15544:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  15545:     if ($lctype ne 'community') {
                   15546:         $lctype = 'course';
                   15547:     }
1.566     albertel 15548:     if ($clonehome eq 'no_host') {
1.944     raeburn  15549:         if ($args->{'crstype'} eq 'Community') {
1.1075.2.161.  .1(raebu 15550:21):             push(@clonemsg,({
                   15551:21):                               mt => 'No new community created.',
                   15552:21):                               args => [],
                   15553:21):                             },
                   15554:21):                             {
                   15555:21):                               mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
                   15556:21):                               args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
                   15557:21):                             }));
1.908     raeburn  15558:         } else {
1.1075.2.161.  .1(raebu 15559:21):             push(@clonemsg,({
                   15560:21):                               mt => 'No new course created.',
                   15561:21):                               args => [],
                   15562:21):                             },
                   15563:21):                             {
                   15564:21):                               mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
                   15565:21):                               args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   15566:21):                             }));
                   15567:21):         }
1.566     albertel 15568:     } else {
                   15569: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1075.2.161.  .1(raebu 15570:21):         $clonetitle = $clonedesc{'description'};
1.944     raeburn  15571:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15572:             if ($clonedesc{'type'} ne 'Community') {
1.1075.2.161.  .1(raebu 15573:21):                 push(@clonemsg,({
                   15574:21):                                   mt => 'No new community created.',
                   15575:21):                                   args => [],
                   15576:21):                                 },
                   15577:21):                                 {
                   15578:21):                                   mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
                   15579:21):                                   args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   15580:21):                                 }));
                   15581:21):                 return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908     raeburn  15582:             }
                   15583:         }
1.1075.2.119  raeburn  15584: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  15585:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 15586: 	    $can_clone = 1;
                   15587: 	} else {
1.1075.2.95  raeburn  15588: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 15589: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1075.2.95  raeburn  15590:             if ($clonehash{'cloners'} eq '') {
                   15591:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   15592:                 if ($domdefs{'canclone'}) {
                   15593:                     unless ($domdefs{'canclone'} eq 'none') {
                   15594:                         if ($domdefs{'canclone'} eq 'domain') {
                   15595:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   15596:                                 $can_clone = 1;
                   15597:                             }
                   15598:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15599:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   15600:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   15601:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   15602:                                 $can_clone = 1;
                   15603:                             }
                   15604:                         }
                   15605:                     }
1.908     raeburn  15606:                 }
1.1075.2.95  raeburn  15607:             } else {
                   15608: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   15609:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  15610:                     $can_clone = 1;
1.1075.2.95  raeburn  15611:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  15612:                     $can_clone = 1;
1.1075.2.96  raeburn  15613:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   15614:                     $can_clone = 1;
1.1075.2.95  raeburn  15615:                 }
                   15616:                 unless ($can_clone) {
1.1075.2.96  raeburn  15617:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15618:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1075.2.95  raeburn  15619:                         my (%gotdomdefaults,%gotcodedefaults);
                   15620:                         foreach my $cloner (@cloners) {
                   15621:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   15622:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   15623:                                 my (%codedefaults,@code_order);
                   15624:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   15625:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   15626:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   15627:                                     }
                   15628:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   15629:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   15630:                                     }
                   15631:                                 } else {
                   15632:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   15633:                                                                             \%codedefaults,
                   15634:                                                                             \@code_order);
                   15635:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   15636:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   15637:                                 }
                   15638:                                 if (@code_order > 0) {
                   15639:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   15640:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   15641:                                                                                 $args->{'crscode'})) {
                   15642:                                         $can_clone = 1;
                   15643:                                         last;
                   15644:                                     }
                   15645:                                 }
                   15646:                             }
                   15647:                         }
                   15648:                     }
1.1075.2.96  raeburn  15649:                 }
                   15650:             }
                   15651:             unless ($can_clone) {
                   15652:                 my $ccrole = 'cc';
                   15653:                 if ($args->{'crstype'} eq 'Community') {
                   15654:                     $ccrole = 'co';
                   15655:                 }
                   15656:                 my %roleshash =
                   15657:                     &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   15658:                                                   $args->{'ccdomain'},
                   15659:                                                   'userroles',['active'],[$ccrole],
                   15660:                                                   [$args->{'clonedomain'}]);
                   15661:                 if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   15662:                     $can_clone = 1;
                   15663:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   15664:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   15665:                     $can_clone = 1;
1.1075.2.95  raeburn  15666:                 }
                   15667:             }
                   15668:             unless ($can_clone) {
                   15669:                 if ($args->{'crstype'} eq 'Community') {
1.1075.2.161.  .1(raebu 15670:21):                     push(@clonemsg,({
                   15671:21):                                       mt => 'No new community created.',
                   15672:21):                                       args => [],
                   15673:21):                                     },
                   15674:21):                                     {
                   15675: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]).',
                   15676:21):                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   15677:21):                                     }));
1.1075.2.95  raeburn  15678:                 } else {
1.1075.2.161.  .1(raebu 15679:21):                     push(@clonemsg,({
                   15680:21):                                       mt => 'No new course created.',
                   15681:21):                                       args => [],
                   15682:21):                                     },
                   15683:21):                                     {
                   15684: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]).',
                   15685:21):                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   15686:21):                                     }));
1.578     raeburn  15687: 	        }
1.566     albertel 15688: 	    }
1.578     raeburn  15689:         }
1.566     albertel 15690:     }
1.1075.2.161.  .1(raebu 15691:21):     return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566     albertel 15692: }
                   15693: 
1.444     albertel 15694: sub construct_course {
1.1075.2.119  raeburn  15695:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1075.2.161.  .1(raebu 15696:21):         $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
                   15697:21):     my ($outcome,$msgref,$clonemsgref);
1.541     raeburn  15698:     my $linefeed =  '<br />'."\n";
                   15699:     if ($context eq 'auto') {
                   15700:         $linefeed = "\n";
                   15701:     }
1.566     albertel 15702: 
                   15703: #
                   15704: # Are we cloning?
                   15705: #
1.1075.2.161.  .1(raebu 15706:21):     my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566     albertel 15707:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1075.2.161.  .1(raebu 15708:21): 	($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566     albertel 15709:         if (!$can_clone) {
1.1075.2.161.  .1(raebu 15710:21): 	    return (0,$outcome,$clonemsgref);
1.566     albertel 15711: 	}
                   15712:     }
                   15713: 
1.444     albertel 15714: #
                   15715: # Open course
                   15716: #
                   15717:     my $crstype = lc($args->{'crstype'});
                   15718:     my %cenv=();
                   15719:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   15720:                                              $args->{'cdescr'},
                   15721:                                              $args->{'curl'},
                   15722:                                              $args->{'course_home'},
                   15723:                                              $args->{'nonstandard'},
                   15724:                                              $args->{'crscode'},
                   15725:                                              $args->{'ccuname'}.':'.
                   15726:                                              $args->{'ccdomain'},
1.882     raeburn  15727:                                              $args->{'crstype'},
1.1075.2.161.  .1(raebu 15728:21):                                              $cnum,$context,$category,
                   15729:21):                                              $callercontext);
1.444     albertel 15730: 
                   15731:     # Note: The testing routines depend on this being output; see 
                   15732:     # Utils::Course. This needs to at least be output as a comment
                   15733:     # if anyone ever decides to not show this, and Utils::Course::new
                   15734:     # will need to be suitably modified.
1.1075.2.161.  .1(raebu 15735:21):     if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   15736:21):         $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
                   15737:21):     } else {
                   15738:21):         $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
                   15739:21):     }
1.943     raeburn  15740:     if ($$courseid =~ /^error:/) {
1.1075.2.161.  .1(raebu 15741:21):         return (0,$outcome,$clonemsgref);
1.943     raeburn  15742:     }
                   15743: 
1.444     albertel 15744: #
                   15745: # Check if created correctly
                   15746: #
1.479     albertel 15747:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 15748:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  15749:     if ($crsuhome eq 'no_host') {
1.1075.2.161.  .1(raebu 15750:21):         if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   15751:21):             $outcome .= &mt_user($user_lh,
                   15752:21):                             'Course creation failed, unrecognized course home server.');
                   15753:21):         } else {
                   15754:21):             $outcome .= &mt('Course creation failed, unrecognized course home server.');
                   15755:21):         }
                   15756:21):         $outcome .= $linefeed;
                   15757:21):         return (0,$outcome,$clonemsgref);
1.943     raeburn  15758:     }
1.541     raeburn  15759:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 15760: 
1.444     albertel 15761: #
1.566     albertel 15762: # Do the cloning
1.1075.2.161.  .1(raebu 15763:21): #
                   15764:21):     my @clonemsg;
1.566     albertel 15765:     if ($can_clone && $cloneid) {
1.1075.2.161.  .1(raebu 15766:21):         push(@clonemsg,
                   15767:21):                       {
                   15768:21):                           mt => 'Created [_1] by cloning from [_2]',
                   15769:21):                           args => [$crstype,$clonetitle],
                   15770:21):                       });
1.566     albertel 15771: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 15772: # Copy all files
1.1075.2.161.  .1(raebu 15773:21):         my @info =
                   15774:21):             &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
                   15775:21):                                                      $args->{'dateshift'},$args->{'crscode'},
                   15776:21):                                                      $args->{'ccuname'}.':'.$args->{'ccdomain'},
                   15777:21):                                                      $args->{'tinyurls'});
                   15778:21):         if (@info) {
                   15779:21):             push(@clonemsg,@info);
                   15780:21):         }
1.444     albertel 15781: # Restore URL
1.566     albertel 15782: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 15783: # Restore title
1.566     albertel 15784: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  15785: # Restore creation date, creator and creation context.
                   15786:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   15787:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   15788:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 15789: # Mark as cloned
1.566     albertel 15790: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      15791: # Need to clone grading mode
                   15792:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   15793:         $cenv{'grading'}=$newenv{'grading'};
                   15794: # Do not clone these environment entries
                   15795:         &Apache::lonnet::del('environment',
                   15796:                   ['default_enrollment_start_date',
                   15797:                    'default_enrollment_end_date',
                   15798:                    'question.email',
                   15799:                    'policy.email',
                   15800:                    'comment.email',
                   15801:                    'pch.users.denied',
1.725     raeburn  15802:                    'plc.users.denied',
                   15803:                    'hidefromcat',
1.1075.2.36  raeburn  15804:                    'checkforpriv',
1.1075.2.158  raeburn  15805:                    'categories'],
1.638     www      15806:                    $$crsudom,$$crsunum);
1.1075.2.63  raeburn  15807:         if ($args->{'textbook'}) {
                   15808:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   15809:         }
1.444     albertel 15810:     }
1.566     albertel 15811: 
1.444     albertel 15812: #
                   15813: # Set environment (will override cloned, if existing)
                   15814: #
                   15815:     my @sections = ();
                   15816:     my @xlists = ();
                   15817:     if ($args->{'crstype'}) {
                   15818:         $cenv{'type'}=$args->{'crstype'};
                   15819:     }
                   15820:     if ($args->{'crsid'}) {
                   15821:         $cenv{'courseid'}=$args->{'crsid'};
                   15822:     }
                   15823:     if ($args->{'crscode'}) {
                   15824:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   15825:     }
                   15826:     if ($args->{'crsquota'} ne '') {
                   15827:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   15828:     } else {
                   15829:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   15830:     }
                   15831:     if ($args->{'ccuname'}) {
                   15832:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   15833:                                         ':'.$args->{'ccdomain'};
                   15834:     } else {
                   15835:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   15836:     }
1.1075.2.31  raeburn  15837:     if ($args->{'defaultcredits'}) {
                   15838:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   15839:     }
1.444     albertel 15840:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   15841:     if ($args->{'crssections'}) {
                   15842:         $cenv{'internal.sectionnums'} = '';
                   15843:         if ($args->{'crssections'} =~ m/,/) {
                   15844:             @sections = split/,/,$args->{'crssections'};
                   15845:         } else {
                   15846:             $sections[0] = $args->{'crssections'};
                   15847:         }
                   15848:         if (@sections > 0) {
                   15849:             foreach my $item (@sections) {
                   15850:                 my ($sec,$gp) = split/:/,$item;
                   15851:                 my $class = $args->{'crscode'}.$sec;
                   15852:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   15853:                 $cenv{'internal.sectionnums'} .= $item.',';
                   15854:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  15855:                     push(@badclasses,$class);
1.444     albertel 15856:                 }
                   15857:             }
                   15858:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   15859:         }
                   15860:     }
                   15861: # do not hide course coordinator from staff listing, 
                   15862: # even if privileged
                   15863:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36  raeburn  15864: # add course coordinator's domain to domains to check for privileged users
                   15865: # if different to course domain
                   15866:     if ($$crsudom ne $args->{'ccdomain'}) {
                   15867:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   15868:     }
1.444     albertel 15869: # add crosslistings
                   15870:     if ($args->{'crsxlist'}) {
                   15871:         $cenv{'internal.crosslistings'}='';
                   15872:         if ($args->{'crsxlist'} =~ m/,/) {
                   15873:             @xlists = split/,/,$args->{'crsxlist'};
                   15874:         } else {
                   15875:             $xlists[0] = $args->{'crsxlist'};
                   15876:         }
                   15877:         if (@xlists > 0) {
                   15878:             foreach my $item (@xlists) {
                   15879:                 my ($xl,$gp) = split/:/,$item;
                   15880:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   15881:                 $cenv{'internal.crosslistings'} .= $item.',';
                   15882:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  15883:                     push(@badclasses,$xl);
1.444     albertel 15884:                 }
                   15885:             }
                   15886:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   15887:         }
                   15888:     }
                   15889:     if ($args->{'autoadds'}) {
                   15890:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   15891:     }
                   15892:     if ($args->{'autodrops'}) {
                   15893:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   15894:     }
                   15895: # check for notification of enrollment changes
                   15896:     my @notified = ();
                   15897:     if ($args->{'notify_owner'}) {
                   15898:         if ($args->{'ccuname'} ne '') {
                   15899:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   15900:         }
                   15901:     }
                   15902:     if ($args->{'notify_dc'}) {
                   15903:         if ($uname ne '') { 
1.630     raeburn  15904:             push(@notified,$uname.':'.$udom);
1.444     albertel 15905:         }
                   15906:     }
                   15907:     if (@notified > 0) {
                   15908:         my $notifylist;
                   15909:         if (@notified > 1) {
                   15910:             $notifylist = join(',',@notified);
                   15911:         } else {
                   15912:             $notifylist = $notified[0];
                   15913:         }
                   15914:         $cenv{'internal.notifylist'} = $notifylist;
                   15915:     }
                   15916:     if (@badclasses > 0) {
                   15917:         my %lt=&Apache::lonlocal::texthash(
1.1075.2.119  raeburn  15918:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   15919:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   15920:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 15921:         );
1.1075.2.119  raeburn  15922:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   15923:                            &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  15924:         if ($context eq 'auto') {
                   15925:             $outcome .= $badclass_msg.$linefeed;
1.1075.2.119  raeburn  15926:         } else {
1.566     albertel 15927:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1075.2.119  raeburn  15928:         }
                   15929:         foreach my $item (@badclasses) {
1.541     raeburn  15930:             if ($context eq 'auto') {
1.1075.2.119  raeburn  15931:                 $outcome .= " - $item\n";
1.541     raeburn  15932:             } else {
1.1075.2.119  raeburn  15933:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  15934:             }
1.1075.2.119  raeburn  15935:         }
                   15936:         if ($context eq 'auto') {
                   15937:             $outcome .= $linefeed;
                   15938:         } else {
                   15939:             $outcome .= "</ul><br /><br /></div>\n";
                   15940:         }
1.444     albertel 15941:     }
                   15942:     if ($args->{'no_end_date'}) {
                   15943:         $args->{'endaccess'} = 0;
                   15944:     }
                   15945:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   15946:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   15947:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   15948:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   15949:     if ($args->{'showphotos'}) {
                   15950:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   15951:     }
                   15952:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   15953:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   15954:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   15955:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  15956:             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'); 
                   15957:             if ($context eq 'auto') {
                   15958:                 $outcome .= $krb_msg;
                   15959:             } else {
1.566     albertel 15960:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  15961:             }
                   15962:             $outcome .= $linefeed;
1.444     albertel 15963:         }
                   15964:     }
                   15965:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   15966:        if ($args->{'setpolicy'}) {
                   15967:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15968:        }
                   15969:        if ($args->{'setcontent'}) {
                   15970:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15971:        }
1.1075.2.110  raeburn  15972:        if ($args->{'setcomment'}) {
                   15973:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15974:        }
1.444     albertel 15975:     }
                   15976:     if ($args->{'reshome'}) {
                   15977: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   15978: 	$cenv{'reshome'}=~s/\/+$/\//;
                   15979:     }
                   15980: #
                   15981: # course has keyed access
                   15982: #
                   15983:     if ($args->{'setkeys'}) {
                   15984:        $cenv{'keyaccess'}='yes';
                   15985:     }
                   15986: # if specified, key authority is not course, but user
                   15987: # only active if keyaccess is yes
                   15988:     if ($args->{'keyauth'}) {
1.487     albertel 15989: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   15990: 	$user = &LONCAPA::clean_username($user);
                   15991: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     15992: 	if ($user ne '' && $domain ne '') {
1.487     albertel 15993: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 15994: 	}
                   15995:     }
                   15996: 
1.1075.2.59  raeburn  15997: #
                   15998: #  generate and store uniquecode (available to course requester), if course should have one.
                   15999: #
                   16000:     if ($args->{'uniquecode'}) {
                   16001:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   16002:         if ($code) {
                   16003:             $cenv{'internal.uniquecode'} = $code;
                   16004:             my %crsinfo =
                   16005:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   16006:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   16007:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   16008:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   16009:             }
                   16010:             if (ref($coderef)) {
                   16011:                 $$coderef = $code;
                   16012:             }
                   16013:         }
                   16014:     }
                   16015: 
1.444     albertel 16016:     if ($args->{'disresdis'}) {
                   16017:         $cenv{'pch.roles.denied'}='st';
                   16018:     }
                   16019:     if ($args->{'disablechat'}) {
                   16020:         $cenv{'plc.roles.denied'}='st';
                   16021:     }
                   16022: 
                   16023:     # Record we've not yet viewed the Course Initialization Helper for this 
                   16024:     # course
                   16025:     $cenv{'course.helper.not.run'} = 1;
                   16026:     #
                   16027:     # Use new Randomseed
                   16028:     #
                   16029:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   16030:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   16031:     #
                   16032:     # The encryption code and receipt prefix for this course
                   16033:     #
                   16034:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   16035:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   16036:     #
                   16037:     # By default, use standard grading
                   16038:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   16039: 
1.541     raeburn  16040:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   16041:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 16042: #
                   16043: # Open all assignments
                   16044: #
                   16045:     if ($args->{'openall'}) {
1.1075.2.146  raeburn  16046:        my $opendate = time;
                   16047:        if ($args->{'openallfrom'} =~ /^\d+$/) {
                   16048:            $opendate = $args->{'openallfrom'};
                   16049:        }
1.444     albertel 16050:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1075.2.146  raeburn  16051:        my %storecontent = ($storeunder         => $opendate,
1.444     albertel 16052:                            $storeunder.'.type' => 'date_start');
1.1075.2.146  raeburn  16053:        $outcome .= &mt('All assignments open starting [_1]',
                   16054:                        &Apache::lonlocal::locallocaltime($opendate)).': '.
                   16055:                    &Apache::lonnet::cput
                   16056:                        ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 16057:    }
                   16058: #
                   16059: # Set first page
                   16060: #
                   16061:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   16062: 	    || ($cloneid)) {
1.445     albertel 16063: 	use LONCAPA::map;
1.444     albertel 16064: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 16065: 
                   16066: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   16067:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   16068: 
1.444     albertel 16069:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   16070:         my $title; my $url;
                   16071:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   16072: 	    $title=&mt('Syllabus');
1.444     albertel 16073:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   16074:         } else {
1.963     raeburn  16075:             $title=&mt('Table of Contents');
1.444     albertel 16076:             $url='/adm/navmaps';
                   16077:         }
1.445     albertel 16078: 
                   16079:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   16080: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   16081: 
                   16082: 	if ($errtext) { $fatal=2; }
1.541     raeburn  16083:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 16084:     }
1.566     albertel 16085: 
1.1075.2.161.  .1(raebu 16086:21):     return (1,$outcome,\@clonemsg);
1.444     albertel 16087: }
                   16088: 
1.1075.2.59  raeburn  16089: sub make_unique_code {
                   16090:     my ($cdom,$cnum) = @_;
                   16091:     # get lock on uniquecodes db
                   16092:     my $lockhash = {
                   16093:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   16094:                                                   ':'.$env{'user.domain'},
                   16095:                    };
                   16096:     my $tries = 0;
                   16097:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   16098:     my ($code,$error);
                   16099: 
                   16100:     while (($gotlock ne 'ok') && ($tries<3)) {
                   16101:         $tries ++;
                   16102:         sleep 1;
                   16103:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   16104:     }
                   16105:     if ($gotlock eq 'ok') {
                   16106:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   16107:         my $gotcode;
                   16108:         my $attempts = 0;
                   16109:         while ((!$gotcode) && ($attempts < 100)) {
                   16110:             $code = &generate_code();
                   16111:             if (!exists($currcodes{$code})) {
                   16112:                 $gotcode = 1;
                   16113:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   16114:                     $error = 'nostore';
                   16115:                 }
                   16116:             }
                   16117:             $attempts ++;
                   16118:         }
                   16119:         my @del_lock = ($cnum."\0".'uniquecodes');
                   16120:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   16121:     } else {
                   16122:         $error = 'nolock';
                   16123:     }
                   16124:     return ($code,$error);
                   16125: }
                   16126: 
                   16127: sub generate_code {
                   16128:     my $code;
                   16129:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   16130:     for (my $i=0; $i<6; $i++) {
                   16131:         my $lettnum = int (rand 2);
                   16132:         my $item = '';
                   16133:         if ($lettnum) {
                   16134:             $item = $letts[int( rand(18) )];
                   16135:         } else {
                   16136:             $item = 1+int( rand(8) );
                   16137:         }
                   16138:         $code .= $item;
                   16139:     }
                   16140:     return $code;
                   16141: }
                   16142: 
1.444     albertel 16143: ############################################################
                   16144: ############################################################
                   16145: 
1.953     droeschl 16146: #SD
                   16147: # only Community and Course, or anything else?
1.378     raeburn  16148: sub course_type {
                   16149:     my ($cid) = @_;
                   16150:     if (!defined($cid)) {
                   16151:         $cid = $env{'request.course.id'};
                   16152:     }
1.404     albertel 16153:     if (defined($env{'course.'.$cid.'.type'})) {
                   16154:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  16155:     } else {
                   16156:         return 'Course';
1.377     raeburn  16157:     }
                   16158: }
1.156     albertel 16159: 
1.406     raeburn  16160: sub group_term {
                   16161:     my $crstype = &course_type();
                   16162:     my %names = (
                   16163:                   'Course' => 'group',
1.865     raeburn  16164:                   'Community' => 'group',
1.406     raeburn  16165:                 );
                   16166:     return $names{$crstype};
                   16167: }
                   16168: 
1.902     raeburn  16169: sub course_types {
1.1075.2.59  raeburn  16170:     my @types = ('official','unofficial','community','textbook');
1.902     raeburn  16171:     my %typename = (
                   16172:                          official   => 'Official course',
                   16173:                          unofficial => 'Unofficial course',
                   16174:                          community  => 'Community',
1.1075.2.59  raeburn  16175:                          textbook   => 'Textbook course',
1.902     raeburn  16176:                    );
                   16177:     return (\@types,\%typename);
                   16178: }
                   16179: 
1.156     albertel 16180: sub icon {
                   16181:     my ($file)=@_;
1.505     albertel 16182:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 16183:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 16184:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 16185:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   16186: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   16187: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   16188: 	            $curfext.".gif") {
                   16189: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   16190: 		$curfext.".gif";
                   16191: 	}
                   16192:     }
1.249     albertel 16193:     return &lonhttpdurl($iconname);
1.154     albertel 16194: } 
1.84      albertel 16195: 
1.575     albertel 16196: sub lonhttpdurl {
1.692     www      16197: #
                   16198: # Had been used for "small fry" static images on separate port 8080.
                   16199: # Modify here if lightweight http functionality desired again.
                   16200: # Currently eliminated due to increasing firewall issues.
                   16201: #
1.575     albertel 16202:     my ($url)=@_;
1.692     www      16203:     return $url;
1.215     albertel 16204: }
                   16205: 
1.213     albertel 16206: sub connection_aborted {
                   16207:     my ($r)=@_;
                   16208:     $r->print(" ");$r->rflush();
                   16209:     my $c = $r->connection;
                   16210:     return $c->aborted();
                   16211: }
                   16212: 
1.221     foxr     16213: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     16214: #    strings as 'strings'.
                   16215: sub escape_single {
1.221     foxr     16216:     my ($input) = @_;
1.223     albertel 16217:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     16218:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   16219:     return $input;
                   16220: }
1.223     albertel 16221: 
1.222     foxr     16222: #  Same as escape_single, but escape's "'s  This 
                   16223: #  can be used for  "strings"
                   16224: sub escape_double {
                   16225:     my ($input) = @_;
                   16226:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   16227:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   16228:     return $input;
                   16229: }
1.223     albertel 16230:  
1.222     foxr     16231: #   Escapes the last element of a full URL.
                   16232: sub escape_url {
                   16233:     my ($url)   = @_;
1.238     raeburn  16234:     my @urlslices = split(/\//, $url,-1);
1.369     www      16235:     my $lastitem = &escape(pop(@urlslices));
1.1075.2.83  raeburn  16236:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     16237: }
1.462     albertel 16238: 
1.820     raeburn  16239: sub compare_arrays {
                   16240:     my ($arrayref1,$arrayref2) = @_;
                   16241:     my (@difference,%count);
                   16242:     @difference = ();
                   16243:     %count = ();
                   16244:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   16245:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   16246:         foreach my $element (keys(%count)) {
                   16247:             if ($count{$element} == 1) {
                   16248:                 push(@difference,$element);
                   16249:             }
                   16250:         }
                   16251:     }
                   16252:     return @difference;
                   16253: }
                   16254: 
1.1075.2.152  raeburn  16255: sub lon_status_items {
                   16256:     my %defaults = (
                   16257:                      E         => 100,
                   16258:                      W         => 4,
                   16259:                      N         => 1,
                   16260:                      U         => 5,
                   16261:                      threshold => 200,
                   16262:                      sysmail   => 2500,
                   16263:                    );
                   16264:     my %names = (
                   16265:                    E => 'Errors',
                   16266:                    W => 'Warnings',
                   16267:                    N => 'Notices',
                   16268:                    U => 'Unsent',
                   16269:                 );
                   16270:     return (\%defaults,\%names);
                   16271: }
                   16272: 
1.817     bisitz   16273: # -------------------------------------------------------- Initialize user login
1.462     albertel 16274: sub init_user_environment {
1.463     albertel 16275:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 16276:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   16277: 
                   16278:     my $public=($username eq 'public' && $domain eq 'public');
                   16279: 
                   16280: # See if old ID present, if so, remove
                   16281: 
1.1062    raeburn  16282:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 16283:     my $now=time;
                   16284: 
                   16285:     if ($public) {
                   16286: 	my $max_public=100;
                   16287: 	my $oldest;
                   16288: 	my $oldest_time=0;
                   16289: 	for(my $next=1;$next<=$max_public;$next++) {
                   16290: 	    if (-e $lonids."/publicuser_$next.id") {
                   16291: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   16292: 		if ($mtime<$oldest_time || !$oldest_time) {
                   16293: 		    $oldest_time=$mtime;
                   16294: 		    $oldest=$next;
                   16295: 		}
                   16296: 	    } else {
                   16297: 		$cookie="publicuser_$next";
                   16298: 		last;
                   16299: 	    }
                   16300: 	}
                   16301: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   16302:     } else {
1.463     albertel 16303: 	# if this isn't a robot, kill any existing non-robot sessions
                   16304: 	if (!$args->{'robot'}) {
                   16305: 	    opendir(DIR,$lonids);
                   16306: 	    while ($filename=readdir(DIR)) {
                   16307: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1075.2.136  raeburn  16308:                     if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
                   16309:                             &GDBM_READER(),0640)) {
                   16310:                         my $linkedfile;
                   16311:                         if (exists($oldenv{'user.linkedenv'})) {
                   16312:                             $linkedfile = $oldenv{'user.linkedenv'};
                   16313:                         }
                   16314:                         untie(%oldenv);
                   16315:                         if (unlink("$lonids/$filename")) {
                   16316:                             if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                   16317:                                 if (-l "$lonids/$linkedfile.id") {
                   16318:                                     unlink("$lonids/$linkedfile.id");
                   16319:                                 }
                   16320:                             }
                   16321:                         }
                   16322:                     } else {
                   16323:                         unlink($lonids.'/'.$filename);
                   16324:                     }
1.463     albertel 16325: 		}
1.462     albertel 16326: 	    }
1.463     albertel 16327: 	    closedir(DIR);
1.1075.2.84  raeburn  16328: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   16329:             my $namespace = 'nohist_courseeditor';
                   16330:             my $lockingkey = 'paste'."\0".'locked_num';
                   16331:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   16332:                                                 $domain,$username);
                   16333:             if (exists($lockhash{$lockingkey})) {
                   16334:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   16335:                 unless ($delresult eq 'ok') {
                   16336:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   16337:                 }
                   16338:             }
1.462     albertel 16339: 	}
                   16340: # Give them a new cookie
1.463     albertel 16341: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      16342: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 16343: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 16344:     
                   16345: # Initialize roles
                   16346: 
1.1062    raeburn  16347: 	($userroles,$firstaccenv,$timerintenv) = 
                   16348:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 16349:     }
                   16350: # ------------------------------------ Check browser type and MathML capability
                   16351: 
1.1075.2.77  raeburn  16352:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   16353:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 16354: 
                   16355: # ------------------------------------------------------------- Get environment
                   16356: 
                   16357:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   16358:     my ($tmp) = keys(%userenv);
                   16359:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   16360:     } else {
                   16361: 	undef(%userenv);
                   16362:     }
                   16363:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   16364: 	$form->{'interface'}=$userenv{'interface'};
                   16365:     }
                   16366:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   16367: 
                   16368: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   16369:     foreach my $option ('interface','localpath','localres') {
                   16370:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 16371:     }
                   16372: # --------------------------------------------------------- Write first profile
                   16373: 
                   16374:     {
1.1075.2.150  raeburn  16375:         my $ip = &Apache::lonnet::get_requestor_ip();
1.462     albertel 16376: 	my %initial_env = 
                   16377: 	    ("user.name"          => $username,
                   16378: 	     "user.domain"        => $domain,
                   16379: 	     "user.home"          => $authhost,
                   16380: 	     "browser.type"       => $clientbrowser,
                   16381: 	     "browser.version"    => $clientversion,
                   16382: 	     "browser.mathml"     => $clientmathml,
                   16383: 	     "browser.unicode"    => $clientunicode,
                   16384: 	     "browser.os"         => $clientos,
1.1075.2.42  raeburn  16385:              "browser.mobile"     => $clientmobile,
                   16386:              "browser.info"       => $clientinfo,
1.1075.2.77  raeburn  16387:              "browser.osversion"  => $clientosversion,
1.462     albertel 16388: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   16389: 	     "request.course.fn"  => '',
                   16390: 	     "request.course.uri" => '',
                   16391: 	     "request.course.sec" => '',
                   16392: 	     "request.role"       => 'cm',
                   16393: 	     "request.role.adv"   => $env{'user.adv'},
1.1075.2.150  raeburn  16394: 	     "request.host"       => $ip,);
1.462     albertel 16395: 
                   16396:         if ($form->{'localpath'}) {
                   16397: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   16398: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   16399:         }
                   16400: 	
                   16401: 	if ($form->{'interface'}) {
                   16402: 	    $form->{'interface'}=~s/\W//gs;
                   16403: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   16404: 	    $env{'browser.interface'}=$form->{'interface'};
                   16405: 	}
                   16406: 
1.1075.2.54  raeburn  16407:         if ($form->{'iptoken'}) {
                   16408:             my $lonhost = $r->dir_config('lonHostID');
                   16409:             $initial_env{"user.noloadbalance"} = $lonhost;
                   16410:             $env{'user.noloadbalance'} = $lonhost;
                   16411:         }
                   16412: 
1.1075.2.120  raeburn  16413:         if ($form->{'noloadbalance'}) {
                   16414:             my @hosts = &Apache::lonnet::current_machine_ids();
                   16415:             my $hosthere = $form->{'noloadbalance'};
                   16416:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   16417:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   16418:                 $env{'user.noloadbalance'} = $hosthere;
                   16419:             }
                   16420:         }
                   16421: 
1.1016    raeburn  16422:         unless ($domain eq 'public') {
1.1075.2.125  raeburn  16423:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   16424:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
1.980     raeburn  16425: 
1.1075.2.125  raeburn  16426:             foreach my $tool ('aboutme','blog','webdav','portfolio') {
                   16427:                 $userenv{'availabletools.'.$tool} = 
                   16428:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   16429:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   16430:             }
1.724     raeburn  16431: 
1.1075.2.125  raeburn  16432:             foreach my $crstype ('official','unofficial','community','textbook') {
                   16433:                 $userenv{'canrequest.'.$crstype} =
                   16434:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   16435:                                                       'reload','requestcourses',
                   16436:                                                       \%userenv,\%domdef,\%is_adv);
                   16437:             }
1.765     raeburn  16438: 
1.1075.2.125  raeburn  16439:             $userenv{'canrequest.author'} =
                   16440:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   16441:                                                   'reload','requestauthor',
                   16442:                                                   \%userenv,\%domdef,\%is_adv);
                   16443:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   16444:                                                  $domain,$username);
                   16445:             my $reqstatus = $reqauthor{'author_status'};
                   16446:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
                   16447:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   16448:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   16449:                                                       $reqauthor{'author'}{'timestamp'};
                   16450:                 }
1.1075.2.14  raeburn  16451:             }
                   16452:         }
                   16453: 
1.462     albertel 16454: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  16455: 
1.462     albertel 16456: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   16457: 		 &GDBM_WRCREAT(),0640)) {
                   16458: 	    &_add_to_env(\%disk_env,\%initial_env);
                   16459: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   16460: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  16461:             if (ref($firstaccenv) eq 'HASH') {
                   16462:                 &_add_to_env(\%disk_env,$firstaccenv);
                   16463:             }
                   16464:             if (ref($timerintenv) eq 'HASH') {
                   16465:                 &_add_to_env(\%disk_env,$timerintenv);
                   16466:             }
1.463     albertel 16467: 	    if (ref($args->{'extra_env'})) {
                   16468: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   16469: 	    }
1.462     albertel 16470: 	    untie(%disk_env);
                   16471: 	} else {
1.705     tempelho 16472: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   16473: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 16474: 	    return 'error: '.$!;
                   16475: 	}
                   16476:     }
                   16477:     $env{'request.role'}='cm';
                   16478:     $env{'request.role.adv'}=$env{'user.adv'};
                   16479:     $env{'browser.type'}=$clientbrowser;
                   16480: 
                   16481:     return $cookie;
                   16482: 
                   16483: }
                   16484: 
                   16485: sub _add_to_env {
                   16486:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  16487:     if (ref($env_data) eq 'HASH') {
                   16488:         while (my ($key,$value) = each(%$env_data)) {
                   16489: 	    $idf->{$prefix.$key} = $value;
                   16490: 	    $env{$prefix.$key}   = $value;
                   16491:         }
1.462     albertel 16492:     }
                   16493: }
                   16494: 
1.685     tempelho 16495: # --- Get the symbolic name of a problem and the url
                   16496: sub get_symb {
                   16497:     my ($request,$silent) = @_;
1.726     raeburn  16498:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 16499:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   16500:     if ($symb eq '') {
                   16501:         if (!$silent) {
1.1071    raeburn  16502:             if (ref($request)) { 
                   16503:                 $request->print("Unable to handle ambiguous references:$url:.");
                   16504:             }
1.685     tempelho 16505:             return ();
                   16506:         }
                   16507:     }
                   16508:     &Apache::lonenc::check_decrypt(\$symb);
                   16509:     return ($symb);
                   16510: }
                   16511: 
                   16512: # --------------------------------------------------------------Get annotation
                   16513: 
                   16514: sub get_annotation {
                   16515:     my ($symb,$enc) = @_;
                   16516: 
                   16517:     my $key = $symb;
                   16518:     if (!$enc) {
                   16519:         $key =
                   16520:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   16521:     }
                   16522:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   16523:     return $annotation{$key};
                   16524: }
                   16525: 
                   16526: sub clean_symb {
1.731     raeburn  16527:     my ($symb,$delete_enc) = @_;
1.685     tempelho 16528: 
                   16529:     &Apache::lonenc::check_decrypt(\$symb);
                   16530:     my $enc = $env{'request.enc'};
1.731     raeburn  16531:     if ($delete_enc) {
1.730     raeburn  16532:         delete($env{'request.enc'});
                   16533:     }
1.685     tempelho 16534: 
                   16535:     return ($symb,$enc);
                   16536: }
1.462     albertel 16537: 
1.1075.2.69  raeburn  16538: ############################################################
                   16539: ############################################################
                   16540: 
                   16541: =pod
                   16542: 
                   16543: =head1 Routines for building display used to search for courses
                   16544: 
                   16545: 
                   16546: =over 4
                   16547: 
                   16548: =item * &build_filters()
                   16549: 
                   16550: Create markup for a table used to set filters to use when selecting
                   16551: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   16552: and quotacheck.pl
                   16553: 
                   16554: 
                   16555: Inputs:
                   16556: 
                   16557: filterlist - anonymous array of fields to include as potential filters
                   16558: 
                   16559: crstype - course type
                   16560: 
                   16561: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   16562:               to pop-open a course selector (will contain "extra element").
                   16563: 
                   16564: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   16565: 
                   16566: filter - anonymous hash of criteria and their values
                   16567: 
                   16568: action - form action
                   16569: 
                   16570: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   16571: 
                   16572: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
                   16573: 
                   16574: cloneruname - username of owner of new course who wants to clone
                   16575: 
                   16576: clonerudom - domain of owner of new course who wants to clone
                   16577: 
                   16578: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
                   16579: 
                   16580: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   16581: 
                   16582: codedom - domain
                   16583: 
                   16584: formname - value of form element named "form".
                   16585: 
                   16586: fixeddom - domain, if fixed.
                   16587: 
                   16588: prevphase - value to assign to form element named "phase" when going back to the previous screen
                   16589: 
                   16590: cnameelement - name of form element in form on opener page which will receive title of selected course
                   16591: 
                   16592: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   16593: 
                   16594: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   16595: 
                   16596: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   16597: 
                   16598: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   16599: 
                   16600: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   16601: 
                   16602: 
                   16603: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   16604: 
                   16605: 
                   16606: Side Effects: None
                   16607: 
                   16608: =cut
                   16609: 
                   16610: # ---------------------------------------------- search for courses based on last activity etc.
                   16611: 
                   16612: sub build_filters {
                   16613:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   16614:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   16615:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   16616:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   16617:         $clonetext,$clonewarning) = @_;
                   16618:     my ($list,$jscript);
                   16619:     my $onchange = 'javascript:updateFilters(this)';
                   16620:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   16621:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   16622:         $typeselectform,$instcodetitle);
                   16623:     if ($formname eq '') {
                   16624:         $formname = $caller;
                   16625:     }
                   16626:     foreach my $item (@{$filterlist}) {
                   16627:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   16628:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   16629:             if ($item eq 'domainfilter') {
                   16630:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   16631:             } elsif ($item eq 'coursefilter') {
                   16632:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   16633:             } elsif ($item eq 'ownerfilter') {
                   16634:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16635:             } elsif ($item eq 'ownerdomfilter') {
                   16636:                 $filter->{'ownerdomfilter'} =
                   16637:                     &LONCAPA::clean_domain($filter->{$item});
                   16638:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   16639:                                                        'ownerdomfilter',1);
                   16640:             } elsif ($item eq 'personfilter') {
                   16641:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16642:             } elsif ($item eq 'persondomfilter') {
                   16643:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   16644:                                                         'persondomfilter',1);
                   16645:             } else {
                   16646:                 $filter->{$item} =~ s/\W//g;
                   16647:             }
                   16648:             if (!$filter->{$item}) {
                   16649:                 $filter->{$item} = '';
                   16650:             }
                   16651:         }
                   16652:         if ($item eq 'domainfilter') {
                   16653:             my $allow_blank = 1;
                   16654:             if ($formname eq 'portform') {
                   16655:                 $allow_blank=0;
                   16656:             } elsif ($formname eq 'studentform') {
                   16657:                 $allow_blank=0;
                   16658:             }
                   16659:             if ($fixeddom) {
                   16660:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   16661:                                     ' value="'.$codedom.'" />'.
                   16662:                                     &Apache::lonnet::domain($codedom,'description');
                   16663:             } else {
                   16664:                 $domainselectform = &select_dom_form($filter->{$item},
                   16665:                                                      'domainfilter',
                   16666:                                                       $allow_blank,'',$onchange);
                   16667:             }
                   16668:         } else {
                   16669:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   16670:         }
                   16671:     }
                   16672: 
                   16673:     # last course activity filter and selection
                   16674:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   16675: 
                   16676:     # course created filter and selection
                   16677:     if (exists($filter->{'createdfilter'})) {
                   16678:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   16679:     }
                   16680: 
                   16681:     my %lt = &Apache::lonlocal::texthash(
                   16682:                 'cac' => "$crstype Activity",
                   16683:                 'ccr' => "$crstype Created",
                   16684:                 'cde' => "$crstype Title",
                   16685:                 'cdo' => "$crstype Domain",
                   16686:                 'ins' => 'Institutional Code',
                   16687:                 'inc' => 'Institutional Categorization',
                   16688:                 'cow' => "$crstype Owner/Co-owner",
                   16689:                 'cop' => "$crstype Personnel Includes",
                   16690:                 'cog' => 'Type',
                   16691:              );
                   16692: 
                   16693:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16694:         my $typeval = 'Course';
                   16695:         if ($crstype eq 'Community') {
                   16696:             $typeval = 'Community';
                   16697:         }
                   16698:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   16699:     } else {
                   16700:         $typeselectform =  '<select name="type" size="1"';
                   16701:         if ($onchange) {
                   16702:             $typeselectform .= ' onchange="'.$onchange.'"';
                   16703:         }
                   16704:         $typeselectform .= '>'."\n";
                   16705:         foreach my $posstype ('Course','Community') {
                   16706:             $typeselectform.='<option value="'.$posstype.'"'.
                   16707:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
                   16708:         }
                   16709:         $typeselectform.="</select>";
                   16710:     }
                   16711: 
                   16712:     my ($cloneableonlyform,$cloneabletitle);
                   16713:     if (exists($filter->{'cloneableonly'})) {
                   16714:         my $cloneableon = '';
                   16715:         my $cloneableoff = ' checked="checked"';
                   16716:         if ($filter->{'cloneableonly'}) {
                   16717:             $cloneableon = $cloneableoff;
                   16718:             $cloneableoff = '';
                   16719:         }
                   16720:         $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>';
                   16721:         if ($formname eq 'ccrs') {
1.1075.2.71  raeburn  16722:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1075.2.69  raeburn  16723:         } else {
                   16724:             $cloneabletitle = &mt('Cloneable by you');
                   16725:         }
                   16726:     }
                   16727:     my $officialjs;
                   16728:     if ($crstype eq 'Course') {
                   16729:         if (exists($filter->{'instcodefilter'})) {
                   16730: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   16731: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   16732:             if ($codedom) {
                   16733:                 $officialjs = 1;
                   16734:                 ($instcodeform,$jscript,$$numtitlesref) =
                   16735:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   16736:                                                                   $officialjs,$codetitlesref);
                   16737:                 if ($jscript) {
                   16738:                     $jscript = '<script type="text/javascript">'."\n".
                   16739:                                '// <![CDATA['."\n".
                   16740:                                $jscript."\n".
                   16741:                                '// ]]>'."\n".
                   16742:                                '</script>'."\n";
                   16743:                 }
                   16744:             }
                   16745:             if ($instcodeform eq '') {
                   16746:                 $instcodeform =
                   16747:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   16748:                     $list->{'instcodefilter'}.'" />';
                   16749:                 $instcodetitle = $lt{'ins'};
                   16750:             } else {
                   16751:                 $instcodetitle = $lt{'inc'};
                   16752:             }
                   16753:             if ($fixeddom) {
                   16754:                 $instcodetitle .= '<br />('.$codedom.')';
                   16755:             }
                   16756:         }
                   16757:     }
                   16758:     my $output = qq|
                   16759: <form method="post" name="filterpicker" action="$action">
                   16760: <input type="hidden" name="form" value="$formname" />
                   16761: |;
                   16762:     if ($formname eq 'modifycourse') {
                   16763:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   16764:                    '<input type="hidden" name="prevphase" value="'.
                   16765:                    $prevphase.'" />'."\n";
1.1075.2.82  raeburn  16766:     } elsif ($formname eq 'quotacheck') {
                   16767:         $output .= qq|
                   16768: <input type="hidden" name="sortby" value="" />
                   16769: <input type="hidden" name="sortorder" value="" />
                   16770: |;
                   16771:     } else {
1.1075.2.69  raeburn  16772:         my $name_input;
                   16773:         if ($cnameelement ne '') {
                   16774:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   16775:                           $cnameelement.'" />';
                   16776:         }
                   16777:         $output .= qq|
                   16778: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   16779: <input type="hidden" name="cdomelement" value="$cdomelement" />
                   16780: $name_input
                   16781: $roleelement
                   16782: $multelement
                   16783: $typeelement
                   16784: |;
                   16785:         if ($formname eq 'portform') {
                   16786:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   16787:         }
                   16788:     }
                   16789:     if ($fixeddom) {
                   16790:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   16791:     }
                   16792:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   16793:     if ($sincefilterform) {
                   16794:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   16795:                   .$sincefilterform
                   16796:                   .&Apache::lonhtmlcommon::row_closure();
                   16797:     }
                   16798:     if ($createdfilterform) {
                   16799:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   16800:                   .$createdfilterform
                   16801:                   .&Apache::lonhtmlcommon::row_closure();
                   16802:     }
                   16803:     if ($domainselectform) {
                   16804:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   16805:                   .$domainselectform
                   16806:                   .&Apache::lonhtmlcommon::row_closure();
                   16807:     }
                   16808:     if ($typeselectform) {
                   16809:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16810:             $output .= $typeselectform;
                   16811:         } else {
                   16812:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   16813:                       .$typeselectform
                   16814:                       .&Apache::lonhtmlcommon::row_closure();
                   16815:         }
                   16816:     }
                   16817:     if ($instcodeform) {
                   16818:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   16819:                   .$instcodeform
                   16820:                   .&Apache::lonhtmlcommon::row_closure();
                   16821:     }
                   16822:     if (exists($filter->{'ownerfilter'})) {
                   16823:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   16824:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16825:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   16826:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16827:                    $ownerdomselectform.'</td></tr></table>'.
                   16828:                    &Apache::lonhtmlcommon::row_closure();
                   16829:     }
                   16830:     if (exists($filter->{'personfilter'})) {
                   16831:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   16832:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16833:                    '<input type="text" name="personfilter" size="20" value="'.
                   16834:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16835:                    $persondomselectform.'</td></tr></table>'.
                   16836:                    &Apache::lonhtmlcommon::row_closure();
                   16837:     }
                   16838:     if (exists($filter->{'coursefilter'})) {
                   16839:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   16840:                   .'<input type="text" name="coursefilter" size="25" value="'
                   16841:                   .$list->{'coursefilter'}.'" />'
                   16842:                   .&Apache::lonhtmlcommon::row_closure();
                   16843:     }
                   16844:     if ($cloneableonlyform) {
                   16845:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   16846:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   16847:     }
                   16848:     if (exists($filter->{'descriptfilter'})) {
                   16849:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   16850:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   16851:                   .$list->{'descriptfilter'}.'" />'
                   16852:                   .&Apache::lonhtmlcommon::row_closure(1);
                   16853:     }
                   16854:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   16855:                '<input type="hidden" name="updater" value="" />'."\n".
                   16856:                '<input type="submit" name="gosearch" value="'.
                   16857:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   16858:     return $jscript.$clonewarning.$output;
                   16859: }
                   16860: 
                   16861: =pod
                   16862: 
                   16863: =item * &timebased_select_form()
                   16864: 
                   16865: Create markup for a dropdown list used to select a time-based
                   16866: filter e.g., Course Activity, Course Created, when searching for courses
                   16867: or communities
                   16868: 
                   16869: Inputs:
                   16870: 
                   16871: item - name of form element (sincefilter or createdfilter)
                   16872: 
                   16873: filter - anonymous hash of criteria and their values
                   16874: 
                   16875: Returns: HTML for a select box contained a blank, then six time selections,
                   16876:          with value set in incoming form variables currently selected.
                   16877: 
                   16878: Side Effects: None
                   16879: 
                   16880: =cut
                   16881: 
                   16882: sub timebased_select_form {
                   16883:     my ($item,$filter) = @_;
                   16884:     if (ref($filter) eq 'HASH') {
                   16885:         $filter->{$item} =~ s/[^\d-]//g;
                   16886:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   16887:         return &select_form(
                   16888:                             $filter->{$item},
                   16889:                             $item,
                   16890:                             {      '-1' => '',
                   16891:                                 '86400' => &mt('today'),
                   16892:                                '604800' => &mt('last week'),
                   16893:                               '2592000' => &mt('last month'),
                   16894:                               '7776000' => &mt('last three months'),
                   16895:                              '15552000' => &mt('last six months'),
                   16896:                              '31104000' => &mt('last year'),
                   16897:                     'select_form_order' =>
                   16898:                            ['-1','86400','604800','2592000','7776000',
                   16899:                             '15552000','31104000']});
                   16900:     }
                   16901: }
                   16902: 
                   16903: =pod
                   16904: 
                   16905: =item * &js_changer()
                   16906: 
                   16907: Create script tag containing Javascript used to submit course search form
                   16908: when course type or domain is changed, and also to hide 'Searching ...' on
                   16909: page load completion for page showing search result.
                   16910: 
                   16911: Inputs: None
                   16912: 
                   16913: Returns: markup containing updateFilters() and hideSearching() javascript functions.
                   16914: 
                   16915: Side Effects: None
                   16916: 
                   16917: =cut
                   16918: 
                   16919: sub js_changer {
                   16920:     return <<ENDJS;
                   16921: <script type="text/javascript">
                   16922: // <![CDATA[
                   16923: function updateFilters(caller) {
                   16924:     if (typeof(caller) != "undefined") {
                   16925:         document.filterpicker.updater.value = caller.name;
                   16926:     }
                   16927:     document.filterpicker.submit();
                   16928: }
                   16929: 
                   16930: function hideSearching() {
                   16931:     if (document.getElementById('searching')) {
                   16932:         document.getElementById('searching').style.display = 'none';
                   16933:     }
                   16934:     return;
                   16935: }
                   16936: 
                   16937: // ]]>
                   16938: </script>
                   16939: 
                   16940: ENDJS
                   16941: }
                   16942: 
                   16943: =pod
                   16944: 
                   16945: =item * &search_courses()
                   16946: 
                   16947: Process selected filters form course search form and pass to lonnet::courseiddump
                   16948: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   16949: 
                   16950: Inputs:
                   16951: 
                   16952: dom - domain being searched
                   16953: 
                   16954: type - course type ('Course' or 'Community' or '.' if any).
                   16955: 
                   16956: filter - anonymous hash of criteria and their values
                   16957: 
                   16958: numtitles - for institutional codes - number of categories
                   16959: 
                   16960: cloneruname - optional username of new course owner
                   16961: 
                   16962: clonerudom - optional domain of new course owner
                   16963: 
1.1075.2.95  raeburn  16964: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1075.2.69  raeburn  16965:             (used when DC is using course creation form)
                   16966: 
                   16967: codetitles - reference to array of titles of components in institutional codes (official courses).
                   16968: 
1.1075.2.95  raeburn  16969: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   16970:            (and so can clone automatically)
                   16971: 
                   16972: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   16973: 
                   16974: reqinstcode - institutional code of new course, where search_courses is used to identify potential
                   16975:               courses to clone
1.1075.2.69  raeburn  16976: 
                   16977: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   16978: 
                   16979: 
                   16980: Side Effects: None
                   16981: 
                   16982: =cut
                   16983: 
                   16984: 
                   16985: sub search_courses {
1.1075.2.95  raeburn  16986:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   16987:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1075.2.69  raeburn  16988:     my (%courses,%showcourses,$cloner);
                   16989:     if (($filter->{'ownerfilter'} ne '') ||
                   16990:         ($filter->{'ownerdomfilter'} ne '')) {
                   16991:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   16992:                                        $filter->{'ownerdomfilter'};
                   16993:     }
                   16994:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   16995:         if (!$filter->{$item}) {
                   16996:             $filter->{$item}='.';
                   16997:         }
                   16998:     }
                   16999:     my $now = time;
                   17000:     my $timefilter =
                   17001:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   17002:     my ($createdbefore,$createdafter);
                   17003:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   17004:         $createdbefore = $now;
                   17005:         $createdafter = $now-$filter->{'createdfilter'};
                   17006:     }
                   17007:     my ($instcodefilter,$regexpok);
                   17008:     if ($numtitles) {
                   17009:         if ($env{'form.official'} eq 'on') {
                   17010:             $instcodefilter =
                   17011:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   17012:             $regexpok = 1;
                   17013:         } elsif ($env{'form.official'} eq 'off') {
                   17014:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   17015:             unless ($instcodefilter eq '') {
                   17016:                 $regexpok = -1;
                   17017:             }
                   17018:         }
                   17019:     } else {
                   17020:         $instcodefilter = $filter->{'instcodefilter'};
                   17021:     }
                   17022:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   17023:     if ($type eq '') { $type = '.'; }
                   17024: 
                   17025:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   17026:         $cloner = $cloneruname.':'.$clonerudom;
                   17027:     }
                   17028:     %courses = &Apache::lonnet::courseiddump($dom,
                   17029:                                              $filter->{'descriptfilter'},
                   17030:                                              $timefilter,
                   17031:                                              $instcodefilter,
                   17032:                                              $filter->{'combownerfilter'},
                   17033:                                              $filter->{'coursefilter'},
                   17034:                                              undef,undef,$type,$regexpok,undef,undef,
1.1075.2.95  raeburn  17035:                                              undef,undef,$cloner,$cc_clone,
1.1075.2.69  raeburn  17036:                                              $filter->{'cloneableonly'},
                   17037:                                              $createdbefore,$createdafter,undef,
1.1075.2.95  raeburn  17038:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1075.2.69  raeburn  17039:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   17040:         my $ccrole;
                   17041:         if ($type eq 'Community') {
                   17042:             $ccrole = 'co';
                   17043:         } else {
                   17044:             $ccrole = 'cc';
                   17045:         }
                   17046:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   17047:                                                      $filter->{'persondomfilter'},
                   17048:                                                      'userroles',undef,
                   17049:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   17050:                                                      $dom);
                   17051:         foreach my $role (keys(%rolehash)) {
                   17052:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   17053:             my $cid = $cdom.'_'.$cnum;
                   17054:             if (exists($courses{$cid})) {
                   17055:                 if (ref($courses{$cid}) eq 'HASH') {
                   17056:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   17057:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1075.2.119  raeburn  17058:                             push(@{$courses{$cid}{roles}},$courserole);
1.1075.2.69  raeburn  17059:                         }
                   17060:                     } else {
                   17061:                         $courses{$cid}{roles} = [$courserole];
                   17062:                     }
                   17063:                     $showcourses{$cid} = $courses{$cid};
                   17064:                 }
                   17065:             }
                   17066:         }
                   17067:         %courses = %showcourses;
                   17068:     }
                   17069:     return %courses;
                   17070: }
                   17071: 
                   17072: =pod
                   17073: 
                   17074: =back
                   17075: 
1.1075.2.88  raeburn  17076: =head1 Routines for version requirements for current course.
                   17077: 
                   17078: =over 4
                   17079: 
                   17080: =item * &check_release_required()
                   17081: 
                   17082: Compares required LON-CAPA version with version on server, and
                   17083: if required version is newer looks for a server with the required version.
                   17084: 
                   17085: Looks first at servers in user's owen domain; if none suitable, looks at
                   17086: servers in course's domain are permitted to host sessions for user's domain.
                   17087: 
                   17088: Inputs:
                   17089: 
                   17090: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   17091: 
                   17092: $courseid - Course ID of current course
                   17093: 
                   17094: $rolecode - User's current role in course (for switchserver query string).
                   17095: 
                   17096: $required - LON-CAPA version needed by course (format: Major.Minor).
                   17097: 
                   17098: 
                   17099: Returns:
                   17100: 
                   17101: $switchserver - query string tp append to /adm/switchserver call (if
                   17102:                 current server's LON-CAPA version is too old.
                   17103: 
                   17104: $warning - Message is displayed if no suitable server could be found.
                   17105: 
                   17106: =cut
                   17107: 
                   17108: sub check_release_required {
                   17109:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   17110:     my ($switchserver,$warning);
                   17111:     if ($required ne '') {
                   17112:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   17113:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   17114:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   17115:             my $otherserver;
                   17116:             if (($major eq '' && $minor eq '') ||
                   17117:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   17118:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   17119:                 my $switchlcrev =
                   17120:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   17121:                                                            $userdomserver);
                   17122:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   17123:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   17124:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   17125:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   17126:                     if ($cdom ne $env{'user.domain'}) {
                   17127:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   17128:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   17129:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   17130:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   17131:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   17132:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   17133:                         my $canhost =
                   17134:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   17135:                                                               $coursedomserver,
                   17136:                                                               $remoterev,
                   17137:                                                               $udomdefaults{'remotesessions'},
                   17138:                                                               $defdomdefaults{'hostedsessions'});
                   17139: 
                   17140:                         if ($canhost) {
                   17141:                             $otherserver = $coursedomserver;
                   17142:                         } else {
                   17143:                             $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.");
                   17144:                         }
                   17145:                     } else {
                   17146:                         $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).");
                   17147:                     }
                   17148:                 } else {
                   17149:                     $otherserver = $userdomserver;
                   17150:                 }
                   17151:             }
                   17152:             if ($otherserver ne '') {
                   17153:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   17154:             }
                   17155:         }
                   17156:     }
                   17157:     return ($switchserver,$warning);
                   17158: }
                   17159: 
                   17160: =pod
                   17161: 
                   17162: =item * &check_release_result()
                   17163: 
                   17164: Inputs:
                   17165: 
                   17166: $switchwarning - Warning message if no suitable server found to host session.
                   17167: 
                   17168: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   17169:                 and current role.
                   17170: 
                   17171: Returns: HTML to display with information about requirement to switch server.
                   17172:          Either displaying warning with link to Roles/Courses screen or
                   17173:          display link to switchserver.
                   17174: 
1.1075.2.69  raeburn  17175: =cut
                   17176: 
1.1075.2.88  raeburn  17177: sub check_release_result {
                   17178:     my ($switchwarning,$switchserver) = @_;
                   17179:     my $output = &start_page('Selected course unavailable on this server').
                   17180:                  '<p class="LC_warning">';
                   17181:     if ($switchwarning) {
                   17182:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   17183:         if (&show_course()) {
                   17184:             $output .= &mt('Display courses');
                   17185:         } else {
                   17186:             $output .= &mt('Display roles');
                   17187:         }
                   17188:         $output .= '</a>';
                   17189:     } elsif ($switchserver) {
                   17190:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   17191:                    '<br />'.
                   17192:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   17193:                    &mt('Switch Server').
                   17194:                    '</a>';
                   17195:     }
                   17196:     $output .= '</p>'.&end_page();
                   17197:     return $output;
                   17198: }
                   17199: 
                   17200: =pod
                   17201: 
                   17202: =item * &needs_coursereinit()
                   17203: 
                   17204: Determine if course contents stored for user's session needs to be
                   17205: refreshed, because content has changed since "Big Hash" last tied.
                   17206: 
                   17207: Check for change is made if time last checked is more than 10 minutes ago
                   17208: (by default).
                   17209: 
                   17210: Inputs:
                   17211: 
                   17212: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   17213: 
                   17214: $interval (optional) - Time which may elapse (in s) between last check for content
                   17215:                        change in current course. (default: 600 s).
                   17216: 
                   17217: Returns: an array; first element is:
                   17218: 
                   17219: =over 4
                   17220: 
                   17221: 'switch' - if content updates mean user's session
                   17222:            needs to be switched to a server running a newer LON-CAPA version
                   17223: 
                   17224: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   17225:            on current server hosting user's session
                   17226: 
                   17227: ''       - if no action required.
                   17228: 
                   17229: =back
                   17230: 
                   17231: If first item element is 'switch':
                   17232: 
                   17233: second item is $switchwarning - Warning message if no suitable server found to host session.
                   17234: 
                   17235: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   17236:                               and current role.
                   17237: 
                   17238: otherwise: no other elements returned.
                   17239: 
                   17240: =back
                   17241: 
                   17242: =cut
                   17243: 
                   17244: sub needs_coursereinit {
                   17245:     my ($loncaparev,$interval) = @_;
                   17246:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   17247:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   17248:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   17249:     my $now = time;
                   17250:     if ($interval eq '') {
                   17251:         $interval = 600;
                   17252:     }
                   17253:     if (($now-$env{'request.course.timechecked'})>$interval) {
                   17254:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1075.2.161.  .1(raebu 17255:21):         my $blocked = &blocking_status('reinit',$cnum,$cdom,undef,1);
                   17256:21):         if ($blocked) {
                   17257:21):             return ();
                   17258:21):         }
                   17259:21):         my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
1.1075.2.88  raeburn  17260:         if ($lastchange > $env{'request.course.tied'}) {
                   17261:             my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   17262:             if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   17263:                 my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   17264:                 if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   17265:                     &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   17266:                                              $curr_reqd_hash{'internal.releaserequired'}});
                   17267:                     my ($switchserver,$switchwarning) =
                   17268:                         &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   17269:                                                 $curr_reqd_hash{'internal.releaserequired'});
                   17270:                     if ($switchwarning ne '' || $switchserver ne '') {
                   17271:                         return ('switch',$switchwarning,$switchserver);
                   17272:                     }
                   17273:                 }
                   17274:             }
                   17275:             return ('update');
                   17276:         }
                   17277:     }
                   17278:     return ();
                   17279: }
1.1075.2.69  raeburn  17280: 
1.1075.2.11  raeburn  17281: sub update_content_constraints {
                   17282:     my ($cdom,$cnum,$chome,$cid) = @_;
                   17283:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   17284:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   17285:     my %checkresponsetypes;
                   17286:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   17287:         my ($item,$name,$value) = split(/:/,$key);
                   17288:         if ($item eq 'resourcetag') {
                   17289:             if ($name eq 'responsetype') {
                   17290:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   17291:             }
                   17292:         }
                   17293:     }
                   17294:     my $navmap = Apache::lonnavmaps::navmap->new();
                   17295:     if (defined($navmap)) {
                   17296:         my %allresponses;
                   17297:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
                   17298:             my %responses = $res->responseTypes();
                   17299:             foreach my $key (keys(%responses)) {
                   17300:                 next unless(exists($checkresponsetypes{$key}));
                   17301:                 $allresponses{$key} += $responses{$key};
                   17302:             }
                   17303:         }
                   17304:         foreach my $key (keys(%allresponses)) {
                   17305:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   17306:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   17307:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   17308:             }
                   17309:         }
                   17310:         undef($navmap);
                   17311:     }
                   17312:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   17313:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   17314:     }
                   17315:     return;
                   17316: }
                   17317: 
1.1075.2.27  raeburn  17318: sub allmaps_incourse {
                   17319:     my ($cdom,$cnum,$chome,$cid) = @_;
                   17320:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   17321:         $cid = $env{'request.course.id'};
                   17322:         $cdom = $env{'course.'.$cid.'.domain'};
                   17323:         $cnum = $env{'course.'.$cid.'.num'};
                   17324:         $chome = $env{'course.'.$cid.'.home'};
                   17325:     }
                   17326:     my %allmaps = ();
                   17327:     my $lastchange =
                   17328:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   17329:     if ($lastchange > $env{'request.course.tied'}) {
                   17330:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   17331:         unless ($ferr) {
                   17332:             &update_content_constraints($cdom,$cnum,$chome,$cid);
                   17333:         }
                   17334:     }
                   17335:     my $navmap = Apache::lonnavmaps::navmap->new();
                   17336:     if (defined($navmap)) {
                   17337:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   17338:             $allmaps{$res->src()} = 1;
                   17339:         }
                   17340:     }
                   17341:     return \%allmaps;
                   17342: }
                   17343: 
1.1075.2.11  raeburn  17344: sub parse_supplemental_title {
                   17345:     my ($title) = @_;
                   17346: 
                   17347:     my ($foldertitle,$renametitle);
                   17348:     if ($title =~ /&amp;&amp;&amp;/) {
                   17349:         $title = &HTML::Entites::decode($title);
                   17350:     }
                   17351:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   17352:         $renametitle=$4;
                   17353:         my ($time,$uname,$udom) = ($1,$2,$3);
                   17354:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   17355:         my $name =  &plainname($uname,$udom);
                   17356:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   17357:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
                   17358:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
                   17359:             $name.': <br />'.$foldertitle;
                   17360:     }
                   17361:     if (wantarray) {
                   17362:         return ($title,$foldertitle,$renametitle);
                   17363:     }
                   17364:     return $title;
                   17365: }
                   17366: 
1.1075.2.43  raeburn  17367: sub recurse_supplemental {
                   17368:     my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
                   17369:     if ($suppmap) {
                   17370:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   17371:         if ($fatal) {
                   17372:             $errors ++;
                   17373:         } else {
                   17374:             if ($#LONCAPA::map::resources > 0) {
                   17375:                 foreach my $res (@LONCAPA::map::resources) {
                   17376:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
                   17377:                     if (($src ne '') && ($status eq 'res')) {
1.1075.2.46  raeburn  17378:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
                   17379:                             ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1075.2.43  raeburn  17380:                         } else {
                   17381:                             $numfiles ++;
                   17382:                         }
                   17383:                     }
                   17384:                 }
                   17385:             }
                   17386:         }
                   17387:     }
                   17388:     return ($numfiles,$errors);
                   17389: }
                   17390: 
1.1075.2.18  raeburn  17391: sub symb_to_docspath {
1.1075.2.119  raeburn  17392:     my ($symb,$navmapref) = @_;
                   17393:     return unless ($symb && ref($navmapref));
1.1075.2.18  raeburn  17394:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   17395:     if ($resurl=~/\.(sequence|page)$/) {
                   17396:         $mapurl=$resurl;
                   17397:     } elsif ($resurl eq 'adm/navmaps') {
                   17398:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   17399:     }
                   17400:     my $mapresobj;
1.1075.2.119  raeburn  17401:     unless (ref($$navmapref)) {
                   17402:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   17403:     }
                   17404:     if (ref($$navmapref)) {
                   17405:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1075.2.18  raeburn  17406:     }
                   17407:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   17408:     my $type=$2;
                   17409:     my $path;
                   17410:     if (ref($mapresobj)) {
                   17411:         my $pcslist = $mapresobj->map_hierarchy();
                   17412:         if ($pcslist ne '') {
                   17413:             foreach my $pc (split(/,/,$pcslist)) {
                   17414:                 next if ($pc <= 1);
1.1075.2.119  raeburn  17415:                 my $res = $$navmapref->getByMapPc($pc);
1.1075.2.18  raeburn  17416:                 if (ref($res)) {
                   17417:                     my $thisurl = $res->src();
                   17418:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   17419:                     my $thistitle = $res->title();
                   17420:                     $path .= '&'.
                   17421:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1075.2.46  raeburn  17422:                              &escape($thistitle).
1.1075.2.18  raeburn  17423:                              ':'.$res->randompick().
                   17424:                              ':'.$res->randomout().
                   17425:                              ':'.$res->encrypted().
                   17426:                              ':'.$res->randomorder().
                   17427:                              ':'.$res->is_page();
                   17428:                 }
                   17429:             }
                   17430:         }
                   17431:         $path =~ s/^\&//;
                   17432:         my $maptitle = $mapresobj->title();
                   17433:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  17434:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17435:         }
                   17436:         $path .= (($path ne '')? '&' : '').
                   17437:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17438:                  &escape($maptitle).
1.1075.2.18  raeburn  17439:                  ':'.$mapresobj->randompick().
                   17440:                  ':'.$mapresobj->randomout().
                   17441:                  ':'.$mapresobj->encrypted().
                   17442:                  ':'.$mapresobj->randomorder().
                   17443:                  ':'.$mapresobj->is_page();
                   17444:     } else {
                   17445:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   17446:         my $ispage = (($type eq 'page')? 1 : '');
                   17447:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  17448:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17449:         }
                   17450:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17451:                 &escape($maptitle).':::::'.$ispage;
1.1075.2.18  raeburn  17452:     }
                   17453:     unless ($mapurl eq 'default') {
                   17454:         $path = 'default&'.
1.1075.2.46  raeburn  17455:                 &escape('Main Content').
1.1075.2.18  raeburn  17456:                 ':::::&'.$path;
                   17457:     }
                   17458:     return $path;
                   17459: }
                   17460: 
1.1075.2.14  raeburn  17461: sub captcha_display {
1.1075.2.137  raeburn  17462:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17463:     my ($output,$error);
1.1075.2.107  raeburn  17464:     my ($captcha,$pubkey,$privkey,$version) =
1.1075.2.137  raeburn  17465:         &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17466:     if ($captcha eq 'original') {
                   17467:         $output = &create_captcha();
                   17468:         unless ($output) {
                   17469:             $error = 'captcha';
                   17470:         }
                   17471:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17472:         $output = &create_recaptcha($pubkey,$version);
1.1075.2.14  raeburn  17473:         unless ($output) {
                   17474:             $error = 'recaptcha';
                   17475:         }
                   17476:     }
1.1075.2.107  raeburn  17477:     return ($output,$error,$captcha,$version);
1.1075.2.14  raeburn  17478: }
                   17479: 
                   17480: sub captcha_response {
1.1075.2.137  raeburn  17481:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17482:     my ($captcha_chk,$captcha_error);
1.1075.2.137  raeburn  17483:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17484:     if ($captcha eq 'original') {
                   17485:         ($captcha_chk,$captcha_error) = &check_captcha();
                   17486:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17487:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1075.2.14  raeburn  17488:     } else {
                   17489:         $captcha_chk = 1;
                   17490:     }
                   17491:     return ($captcha_chk,$captcha_error);
                   17492: }
                   17493: 
                   17494: sub get_captcha_config {
1.1075.2.137  raeburn  17495:     my ($context,$lonhost,$dom_in_effect) = @_;
1.1075.2.107  raeburn  17496:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1075.2.14  raeburn  17497:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   17498:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   17499:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   17500:     if ($context eq 'usercreation') {
                   17501:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   17502:         if (ref($domconfig{$context}) eq 'HASH') {
                   17503:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   17504:             if (ref($hashtocheck) eq 'HASH') {
                   17505:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   17506:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   17507:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   17508:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   17509:                     }
                   17510:                     if ($privkey && $pubkey) {
                   17511:                         $captcha = 'recaptcha';
1.1075.2.107  raeburn  17512:                         $version = $hashtocheck->{'recaptchaversion'};
                   17513:                         if ($version ne '2') {
                   17514:                             $version = 1;
                   17515:                         }
1.1075.2.14  raeburn  17516:                     } else {
                   17517:                         $captcha = 'original';
                   17518:                     }
                   17519:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   17520:                     $captcha = 'original';
                   17521:                 }
                   17522:             }
                   17523:         } else {
                   17524:             $captcha = 'captcha';
                   17525:         }
                   17526:     } elsif ($context eq 'login') {
                   17527:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   17528:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   17529:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   17530:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
                   17531:             if ($privkey && $pubkey) {
                   17532:                 $captcha = 'recaptcha';
1.1075.2.107  raeburn  17533:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   17534:                 if ($version ne '2') {
                   17535:                     $version = 1;
                   17536:                 }
1.1075.2.14  raeburn  17537:             } else {
                   17538:                 $captcha = 'original';
                   17539:             }
                   17540:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   17541:             $captcha = 'original';
                   17542:         }
1.1075.2.137  raeburn  17543:     } elsif ($context eq 'passwords') {
                   17544:         if ($dom_in_effect) {
                   17545:             my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
                   17546:             if ($passwdconf{'captcha'} eq 'recaptcha') {
                   17547:                 if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
                   17548:                     $pubkey = $passwdconf{'recaptchakeys'}{'public'};
                   17549:                     $privkey = $passwdconf{'recaptchakeys'}{'private'};
                   17550:                 }
                   17551:                 if ($privkey && $pubkey) {
                   17552:                     $captcha = 'recaptcha';
                   17553:                     $version = $passwdconf{'recaptchaversion'};
                   17554:                     if ($version ne '2') {
                   17555:                         $version = 1;
                   17556:                     }
                   17557:                 } else {
                   17558:                     $captcha = 'original';
                   17559:                 }
                   17560:             } elsif ($passwdconf{'captcha'} ne 'notused') {
                   17561:                 $captcha = 'original';
                   17562:             }
                   17563:         }
1.1075.2.14  raeburn  17564:     }
1.1075.2.107  raeburn  17565:     return ($captcha,$pubkey,$privkey,$version);
1.1075.2.14  raeburn  17566: }
                   17567: 
                   17568: sub create_captcha {
                   17569:     my %captcha_params = &captcha_settings();
                   17570:     my ($output,$maxtries,$tries) = ('',10,0);
                   17571:     while ($tries < $maxtries) {
                   17572:         $tries ++;
                   17573:         my $captcha = Authen::Captcha->new (
                   17574:                                            output_folder => $captcha_params{'output_dir'},
                   17575:                                            data_folder   => $captcha_params{'db_dir'},
                   17576:                                           );
                   17577:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   17578: 
                   17579:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   17580:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1075.2.158  raeburn  17581:                       '<span class="LC_nobreak">'.
1.1075.2.14  raeburn  17582:                       &mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1075.2.66  raeburn  17583:                       '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
1.1075.2.158  raeburn  17584:                       '</span><br />'.
1.1075.2.66  raeburn  17585:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1075.2.14  raeburn  17586:             last;
                   17587:         }
                   17588:     }
1.1075.2.158  raeburn  17589:     if ($output eq '') {
                   17590:         &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
                   17591:     }
1.1075.2.14  raeburn  17592:     return $output;
                   17593: }
                   17594: 
                   17595: sub captcha_settings {
                   17596:     my %captcha_params = (
                   17597:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   17598:                            www_output_dir => "/captchaspool",
                   17599:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   17600:                            numchars       => '5',
                   17601:                          );
                   17602:     return %captcha_params;
                   17603: }
                   17604: 
                   17605: sub check_captcha {
                   17606:     my ($captcha_chk,$captcha_error);
                   17607:     my $code = $env{'form.code'};
                   17608:     my $md5sum = $env{'form.crypt'};
                   17609:     my %captcha_params = &captcha_settings();
                   17610:     my $captcha = Authen::Captcha->new(
                   17611:                       output_folder => $captcha_params{'output_dir'},
                   17612:                       data_folder   => $captcha_params{'db_dir'},
                   17613:                   );
1.1075.2.26  raeburn  17614:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14  raeburn  17615:     my %captcha_hash = (
                   17616:                         0       => 'Code not checked (file error)',
                   17617:                        -1      => 'Failed: code expired',
                   17618:                        -2      => 'Failed: invalid code (not in database)',
                   17619:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   17620:     );
                   17621:     if ($captcha_chk != 1) {
                   17622:         $captcha_error = $captcha_hash{$captcha_chk}
                   17623:     }
                   17624:     return ($captcha_chk,$captcha_error);
                   17625: }
                   17626: 
                   17627: sub create_recaptcha {
1.1075.2.107  raeburn  17628:     my ($pubkey,$version) = @_;
                   17629:     if ($version >= 2) {
1.1075.2.158  raeburn  17630:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
                   17631:                '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1075.2.107  raeburn  17632:     } else {
                   17633:         my $use_ssl;
                   17634:         if ($ENV{'SERVER_PORT'} == 443) {
                   17635:             $use_ssl = 1;
                   17636:         }
                   17637:         my $captcha = Captcha::reCAPTCHA->new;
                   17638:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   17639:                $captcha->get_html($pubkey,undef,$use_ssl).
                   17640:                &mt('If the text is hard to read, [_1] will replace them.',
                   17641:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   17642:                '<br /><br />';
                   17643:      }
1.1075.2.14  raeburn  17644: }
                   17645: 
                   17646: sub check_recaptcha {
1.1075.2.107  raeburn  17647:     my ($privkey,$version) = @_;
1.1075.2.14  raeburn  17648:     my $captcha_chk;
1.1075.2.150  raeburn  17649:     my $ip = &Apache::lonnet::get_requestor_ip(); 
1.1075.2.107  raeburn  17650:     if ($version >= 2) {
                   17651:         my $ua = LWP::UserAgent->new;
                   17652:         $ua->timeout(10);
                   17653:         my %info = (
                   17654:                      secret   => $privkey,
                   17655:                      response => $env{'form.g-recaptcha-response'},
1.1075.2.150  raeburn  17656:                      remoteip => $ip,
1.1075.2.107  raeburn  17657:                    );
                   17658:         my $response = $ua->post('https://www.google.com/recaptcha/api/siteverify',\%info);
                   17659:         if ($response->is_success)  {
                   17660:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   17661:             if (ref($data) eq 'HASH') {
                   17662:                 if ($data->{'success'}) {
                   17663:                     $captcha_chk = 1;
                   17664:                 }
                   17665:             }
                   17666:         }
                   17667:     } else {
                   17668:         my $captcha = Captcha::reCAPTCHA->new;
                   17669:         my $captcha_result =
                   17670:             $captcha->check_answer(
                   17671:                                     $privkey,
1.1075.2.150  raeburn  17672:                                     $ip,
1.1075.2.107  raeburn  17673:                                     $env{'form.recaptcha_challenge_field'},
                   17674:                                     $env{'form.recaptcha_response_field'},
                   17675:                                   );
                   17676:         if ($captcha_result->{is_valid}) {
                   17677:             $captcha_chk = 1;
                   17678:         }
1.1075.2.14  raeburn  17679:     }
                   17680:     return $captcha_chk;
                   17681: }
                   17682: 
1.1075.2.64  raeburn  17683: sub emailusername_info {
1.1075.2.103  raeburn  17684:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1075.2.64  raeburn  17685:     my %titles = &Apache::lonlocal::texthash (
                   17686:                      lastname      => 'Last Name',
                   17687:                      firstname     => 'First Name',
                   17688:                      institution   => 'School/college/university',
                   17689:                      location      => "School's city, state/province, country",
                   17690:                      web           => "School's web address",
                   17691:                      officialemail => 'E-mail address at institution (if different)',
1.1075.2.103  raeburn  17692:                      id            => 'Student/Employee ID',
1.1075.2.64  raeburn  17693:                  );
                   17694:     return (\@fields,\%titles);
                   17695: }
                   17696: 
1.1075.2.56  raeburn  17697: sub cleanup_html {
                   17698:     my ($incoming) = @_;
                   17699:     my $outgoing;
                   17700:     if ($incoming ne '') {
                   17701:         $outgoing = $incoming;
                   17702:         $outgoing =~ s/;/&#059;/g;
                   17703:         $outgoing =~ s/\#/&#035;/g;
                   17704:         $outgoing =~ s/\&/&#038;/g;
                   17705:         $outgoing =~ s/</&#060;/g;
                   17706:         $outgoing =~ s/>/&#062;/g;
                   17707:         $outgoing =~ s/\(/&#040/g;
                   17708:         $outgoing =~ s/\)/&#041;/g;
                   17709:         $outgoing =~ s/"/&#034;/g;
                   17710:         $outgoing =~ s/'/&#039;/g;
                   17711:         $outgoing =~ s/\$/&#036;/g;
                   17712:         $outgoing =~ s{/}{&#047;}g;
                   17713:         $outgoing =~ s/=/&#061;/g;
                   17714:         $outgoing =~ s/\\/&#092;/g
                   17715:     }
                   17716:     return $outgoing;
                   17717: }
                   17718: 
1.1075.2.74  raeburn  17719: # Checks for critical messages and returns a redirect url if one exists.
                   17720: # $interval indicates how often to check for messages.
1.1075.2.161.  .1(raebu 17721:21): # $context is the calling context -- roles, grades, contents, menu or flip.
1.1075.2.74  raeburn  17722: sub critical_redirect {
1.1075.2.161.  .1(raebu 17723:21):     my ($interval,$context) = @_;
1.1075.2.158  raeburn  17724:     unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
                   17725:         return ();
                   17726:     }
1.1075.2.74  raeburn  17727:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1075.2.161.  .1(raebu 17728:21):         if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
                   17729:21):             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   17730:21):             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   17731:21):             my $blocked = &blocking_status('alert',$cnum,$cdom,undef,1);
                   17732:21):             if ($blocked) {
                   17733:21):                 my $checkrole = "cm./$cdom/$cnum";
                   17734:21):                 if ($env{'request.course.sec'} ne '') {
                   17735:21):                     $checkrole .= "/$env{'request.course.sec'}";
                   17736:21):                 }
                   17737:21):                 unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   17738:21):                         ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   17739:21):                     return;
                   17740:21):                 }
                   17741:21):             }
                   17742:21):         }
1.1075.2.74  raeburn  17743:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
                   17744:                                         $env{'user.name'});
                   17745:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
                   17746:         my $redirecturl;
                   17747:         if ($what[0]) {
1.1075.2.158  raeburn  17748:             if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1075.2.74  raeburn  17749:                 $redirecturl='/adm/email?critical=display';
                   17750:                 my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   17751:                 return (1, $url);
                   17752:             }
                   17753:         }
                   17754:     }
                   17755:     return ();
                   17756: }
                   17757: 
1.1075.2.64  raeburn  17758: # Use:
                   17759: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   17760: #
                   17761: ##################################################
                   17762: #          password associated functions         #
                   17763: ##################################################
                   17764: sub des_keys {
                   17765:     # Make a new key for DES encryption.
                   17766:     # Each key has two parts which are returned separately.
                   17767:     # Please note:  Each key must be passed through the &hex function
                   17768:     # before it is output to the web browser.  The hex versions cannot
                   17769:     # be used to decrypt.
                   17770:     my @hexstr=('0','1','2','3','4','5','6','7',
                   17771:                 '8','9','a','b','c','d','e','f');
                   17772:     my $lkey='';
                   17773:     for (0..7) {
                   17774:         $lkey.=$hexstr[rand(15)];
                   17775:     }
                   17776:     my $ukey='';
                   17777:     for (0..7) {
                   17778:         $ukey.=$hexstr[rand(15)];
                   17779:     }
                   17780:     return ($lkey,$ukey);
                   17781: }
                   17782: 
                   17783: sub des_decrypt {
                   17784:     my ($key,$cyphertext) = @_;
                   17785:     my $keybin=pack("H16",$key);
                   17786:     my $cypher;
                   17787:     if ($Crypt::DES::VERSION>=2.03) {
                   17788:         $cypher=new Crypt::DES $keybin;
                   17789:     } else {
                   17790:         $cypher=new DES $keybin;
                   17791:     }
1.1075.2.106  raeburn  17792:     my $plaintext='';
                   17793:     my $cypherlength = length($cyphertext);
                   17794:     my $numchunks = int($cypherlength/32);
                   17795:     for (my $j=0; $j<$numchunks; $j++) {
                   17796:         my $start = $j*32;
                   17797:         my $cypherblock = substr($cyphertext,$start,32);
                   17798:         my $chunk =
                   17799:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   17800:         $chunk .=
                   17801:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   17802:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   17803:         $plaintext .= $chunk;
                   17804:     }
1.1075.2.64  raeburn  17805:     return $plaintext;
                   17806: }
                   17807: 
1.1075.2.161.  .1(raebu 17808:21): sub get_requested_shorturls {
                   17809:21):     my ($cdom,$cnum,$navmap) = @_;
                   17810:21):     return unless (ref($navmap));
                   17811:21):     my ($numnew,$errors);
                   17812:21):     my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
                   17813:21):     if (@toshorten) {
                   17814:21):         my (%maps,%resources,%titles);
                   17815:21):         &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
                   17816:21):                                                                'shorturls',$cdom,$cnum);
                   17817:21):         if (keys(%resources)) {
                   17818:21):             my %tocreate;
                   17819:21):             foreach my $item (sort {$a <=> $b} (@toshorten)) {
                   17820:21):                 my $symb = $resources{$item};
                   17821:21):                 if ($symb) {
                   17822:21):                     $tocreate{$cnum.'&'.$symb} = 1;
                   17823:21):                 }
                   17824:21):             }
                   17825:21):             if (keys(%tocreate)) {
                   17826:21):                 ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
                   17827:21):                                                       \%tocreate);
                   17828:21):             }
                   17829:21):         }
                   17830:21):     }
                   17831:21):     return ($numnew,$errors);
                   17832:21): }
                   17833:21): 
                   17834:21): sub make_short_symbs {
                   17835:21):     my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
                   17836:21):     my ($numnew,@errors);
                   17837:21):     if (ref($tocreateref) eq 'HASH') {
                   17838:21):         my %tocreate = %{$tocreateref};
                   17839:21):         if (keys(%tocreate)) {
                   17840:21):             my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
                   17841:21):             my $su = Short::URL->new(no_vowels => 1);
                   17842:21):             my $init = '';
                   17843:21):             my (%newunique,%addcourse,%courseonly,%failed);
                   17844:21):             # get lock on tiny db
                   17845:21):             my $now = time;
                   17846:21):             if ($lockuser eq '') {
                   17847:21):                 $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
                   17848:21):             }
                   17849:21):             my $lockhash = {
                   17850:21):                                 "lock\0$now" => $lockuser,
                   17851:21):                             };
                   17852:21):             my $tries = 0;
                   17853:21):             my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
                   17854:21):             my ($code,$error);
                   17855:21):             while (($gotlock ne 'ok') && ($tries<3)) {
                   17856:21):                 $tries ++;
                   17857:21):                 sleep 1;
                   17858:21):                 $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
                   17859:21):             }
                   17860:21):             if ($gotlock eq 'ok') {
                   17861:21):                 $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
                   17862:21):                                        \%addcourse,\%courseonly,\%failed);
                   17863:21):                 if (keys(%failed)) {
                   17864:21):                     my $numfailed = scalar(keys(%failed));
                   17865:21):                     push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
                   17866:21):                 }
                   17867:21):                 if (keys(%newunique)) {
                   17868:21):                     my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
                   17869:21):                     if ($putres eq 'ok') {
                   17870:21):                         $numnew = scalar(keys(%newunique));
                   17871:21):                         my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
                   17872:21):                         unless ($newputres eq 'ok') {
                   17873:21):                             push(@errors,&mt('error: could not store course look-up of short URLs'));
                   17874:21):                         }
                   17875:21):                     } else {
                   17876:21):                         push(@errors,&mt('error: could not store unique six character URLs'));
                   17877:21):                     }
                   17878:21):                 }
                   17879:21):                 my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
                   17880:21):                 unless ($dellockres eq 'ok') {
                   17881:21):                     push(@errors,&mt('error: could not release lockfile'));
                   17882:21):                 }
                   17883:21):             } else {
                   17884:21):                 push(@errors,&mt('error: could not obtain lockfile'));
                   17885:21):             }
                   17886:21):             if (keys(%courseonly)) {
                   17887:21):                 my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
                   17888:21):                 if ($result ne 'ok') {
                   17889:21):                     push(@errors,&mt('error: could not update course look-up of short URLs'));
                   17890:21):                 }
                   17891:21):             }
                   17892:21):         }
                   17893:21):     }
                   17894:21):     return ($numnew,\@errors);
                   17895:21): }
                   17896:21): 
                   17897:21): sub shorten_symbs {
                   17898:21):     my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
                   17899:21):     return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
                   17900:21):                    (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
                   17901:21):                    (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
                   17902:21):     my (%possibles,%collisions);
                   17903:21):     foreach my $key (keys(%{$tocreate})) {
                   17904:21):         my $num = String::CRC32::crc32($key);
                   17905:21):         my $tiny = $su->encode($num,$init);
                   17906:21):         if ($tiny) {
                   17907:21):             $possibles{$tiny} = $key;
                   17908:21):         }
                   17909:21):     }
                   17910:21):     if (!$init) {
                   17911:21):         $init = 1;
                   17912:21):     } else {
                   17913:21):         $init ++;
                   17914:21):     }
                   17915:21):     if (keys(%possibles)) {
                   17916:21):         my @posstiny = keys(%possibles);
                   17917:21):         my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
                   17918:21):         my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
                   17919:21):         if (keys(%currtiny)) {
                   17920:21):             foreach my $key (keys(%currtiny)) {
                   17921:21):                 next if ($currtiny{$key} eq '');
                   17922:21):                 if ($currtiny{$key} eq $possibles{$key}) {
                   17923:21):                     my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
                   17924:21):                     unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   17925:21):                         $courseonly->{$tsymb} = $key;
                   17926:21):                     }
                   17927:21):                 } else {
                   17928:21):                     $collisions{$possibles{$key}} = 1;
                   17929:21):                 }
                   17930:21):                 delete($possibles{$key});
                   17931:21):             }
                   17932:21):         }
                   17933:21):         foreach my $key (keys(%possibles)) {
                   17934:21):             $newunique->{$key} = $possibles{$key};
                   17935:21):             my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
                   17936:21):             unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   17937:21):                 $addcourse->{$tsymb} = $key;
                   17938:21):             }
                   17939:21):         }
                   17940:21):     }
                   17941:21):     if (keys(%collisions)) {
                   17942:21):         if ($init <5) {
                   17943:21):             if (!$init) {
                   17944:21):                 $init = 1;
                   17945:21):             } else {
                   17946:21):                 $init ++;
                   17947:21):             }
                   17948:21):             $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
                   17949:21):                                    $newunique,$addcourse,$courseonly,$failed);
                   17950:21):         } else {
                   17951:21):             foreach my $key (keys(%collisions)) {
                   17952:21):                 $failed->{$key} = 1;
                   17953:21):                 $failed->{$key} = 1;
                   17954:21):             }
                   17955:21):         }
                   17956:21):     }
                   17957:21):     return $init;
                   17958:21): }
                   17959:21): 
1.1075.2.135  raeburn  17960: sub is_nonframeable {
                   17961:     my ($url,$absolute,$hostname,$ip,$nocache) = @_;
                   17962:     my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
                   17963:     return if (($remprotocol eq '') || ($remhost eq ''));
                   17964: 
                   17965:     $remprotocol = lc($remprotocol);
                   17966:     $remhost = lc($remhost);
                   17967:     my $remport = 80;
                   17968:     if ($remprotocol eq 'https') {
                   17969:         $remport = 443;
                   17970:     }
                   17971:     my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
                   17972:     if ($cached) {
                   17973:         unless ($nocache) {
                   17974:             if ($result) {
                   17975:                 return 1;
                   17976:             } else {
                   17977:                 return 0;
                   17978:             }
                   17979:         }
                   17980:     }
                   17981:     my $uselink;
                   17982:     my $request = new HTTP::Request('HEAD',$url);
1.1075.2.142  raeburn  17983:     my $ua = LWP::UserAgent->new;
                   17984:     $ua->timeout(5);
                   17985:     my $response=$ua->request($request);
1.1075.2.135  raeburn  17986:     if ($response->is_success()) {
                   17987:         my $secpolicy = lc($response->header('content-security-policy'));
                   17988:         my $xframeop = lc($response->header('x-frame-options'));
                   17989:         $secpolicy =~ s/^\s+|\s+$//g;
                   17990:         $xframeop =~ s/^\s+|\s+$//g;
                   17991:         if (($secpolicy ne '') || ($xframeop ne '')) {
                   17992:             my $remotehost = $remprotocol.'://'.$remhost;
                   17993:             my ($origin,$protocol,$port);
                   17994:             if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
                   17995:                 $port = $ENV{'SERVER_PORT'};
                   17996:             } else {
                   17997:                 $port = 80;
                   17998:             }
                   17999:             if ($absolute eq '') {
                   18000:                 $protocol = 'http:';
                   18001:                 if ($port == 443) {
                   18002:                     $protocol = 'https:';
                   18003:                 }
                   18004:                 $origin = $protocol.'//'.lc($hostname);
                   18005:             } else {
                   18006:                 $origin = lc($absolute);
                   18007:                 ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
                   18008:             }
                   18009:             if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
                   18010:                 my $framepolicy = $1;
                   18011:                 $framepolicy =~ s/^\s+|\s+$//g;
                   18012:                 my @policies = split(/\s+/,$framepolicy);
                   18013:                 if (@policies) {
                   18014:                     if (grep(/^\Q'none'\E$/,@policies)) {
                   18015:                         $uselink = 1;
                   18016:                     } else {
                   18017:                         $uselink = 1;
                   18018:                         if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
                   18019:                                 (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
                   18020:                                 (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
                   18021:                             undef($uselink);
                   18022:                         }
                   18023:                         if ($uselink) {
                   18024:                             if (grep(/^\Q'self'\E$/,@policies)) {
                   18025:                                 if (($origin ne '') && ($remotehost eq $origin)) {
                   18026:                                     undef($uselink);
                   18027:                                 }
                   18028:                             }
                   18029:                         }
                   18030:                         if ($uselink) {
                   18031:                             my @possok;
                   18032:                             if ($ip ne '') {
                   18033:                                 push(@possok,$ip);
                   18034:                             }
                   18035:                             my $hoststr = '';
                   18036:                             foreach my $part (reverse(split(/\./,$hostname))) {
                   18037:                                 if ($hoststr eq '') {
                   18038:                                     $hoststr = $part;
                   18039:                                 } else {
                   18040:                                     $hoststr = "$part.$hoststr";
                   18041:                                 }
                   18042:                                 if ($hoststr eq $hostname) {
                   18043:                                     push(@possok,$hostname);
                   18044:                                 } else {
                   18045:                                     push(@possok,"*.$hoststr");
                   18046:                                 }
                   18047:                             }
                   18048:                             if (@possok) {
                   18049:                                 foreach my $poss (@possok) {
                   18050:                                     last if (!$uselink);
                   18051:                                     foreach my $policy (@policies) {
                   18052:                                         if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
                   18053:                                             undef($uselink);
                   18054:                                             last;
                   18055:                                         }
                   18056:                                     }
                   18057:                                 }
                   18058:                             }
                   18059:                         }
                   18060:                     }
                   18061:                 }
                   18062:             } elsif ($xframeop ne '') {
                   18063:                 $uselink = 1;
                   18064:                 my @policies = split(/\s*,\s*/,$xframeop);
                   18065:                 if (@policies) {
                   18066:                     unless (grep(/^deny$/,@policies)) {
                   18067:                         if ($origin ne '') {
                   18068:                             if (grep(/^sameorigin$/,@policies)) {
                   18069:                                 if ($remotehost eq $origin) {
                   18070:                                     undef($uselink);
                   18071:                                 }
                   18072:                             }
                   18073:                             if ($uselink) {
                   18074:                                 foreach my $policy (@policies) {
                   18075:                                     if ($policy =~ /^allow-from\s*(.+)$/) {
                   18076:                                         my $allowfrom = $1;
                   18077:                                         if (($allowfrom ne '') && ($allowfrom eq $origin)) {
                   18078:                                             undef($uselink);
                   18079:                                             last;
                   18080:                                         }
                   18081:                                     }
                   18082:                                 }
                   18083:                             }
                   18084:                         }
                   18085:                     }
                   18086:                 }
                   18087:             }
                   18088:         }
                   18089:     }
                   18090:     if ($nocache) {
                   18091:         if ($cached) {
                   18092:             my $devalidate;
                   18093:             if ($uselink && !$result) {
                   18094:                 $devalidate = 1;
                   18095:             } elsif (!$uselink && $result) {
                   18096:                 $devalidate = 1;
                   18097:             }
                   18098:             if ($devalidate) {
                   18099:                 &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
                   18100:             }
                   18101:         }
                   18102:     } else {
                   18103:         if ($uselink) {
                   18104:             $result = 1;
                   18105:         } else {
                   18106:             $result = 0;
                   18107:         }
                   18108:         &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
                   18109:     }
                   18110:     return $uselink;
                   18111: }
                   18112: 
1.1075.2.161.  .1(raebu 18113:21): sub page_menu {
                   18114:21):     my ($menucolls,$menunum) = @_;
                   18115:21):     my %menu;
                   18116:21):     foreach my $item (split(/;/,$menucolls)) {
                   18117:21):         my ($num,$value) = split(/\%/,$item);
                   18118:21):         if ($num eq $menunum) {
                   18119:21):             my @entries = split(/\&/,$value);
                   18120:21):             foreach my $entry (@entries) {
                   18121:21):                 my ($name,$fields) = split(/=/,$entry);
                   18122:21):                 if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
                   18123:21):                     $menu{$name} = $fields;
                   18124:21):                 } else {
                   18125:21):                     my @shown;
                   18126:21):                     if ($fields =~ /,/) {
                   18127:21):                         @shown = split(/,/,$fields);
                   18128:21):                     } else {
                   18129:21):                         @shown = ($fields);
                   18130:21):                     }
                   18131:21):                     if (@shown) {
                   18132:21):                         foreach my $field (@shown) {
                   18133:21):                             next if ($field eq '');
                   18134:21):                             $menu{$field} = 1;
                   18135:21):                         }
                   18136:21):                     }
                   18137:21):                 }
                   18138:21):             }
                   18139:21):         }
                   18140:21):     }
                   18141:21):     return %menu;
                   18142:21): }
                   18143:21): 
1.112     bowersj2 18144: 1;
                   18145: __END__;
1.41      ng       18146: 

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