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

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.  .9(raebu    4:22): # $Id: loncommon.pm,v 1.1075.2.161.2.8 2022/07/08 16:01:54 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.1075.2.161.  .7(raebu   64:22): use Apache::lonnavmaps();
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.1075.2.161.  .6(raebu 1224:22): =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid,$links_target)
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: 
1.1075.2.161.  .6(raebu 1248:22): $links_target will optionally be set to a target (_top, _parent or _self).
                   1249:22): 
1.44      bowersj2 1250: =cut
                   1251: 
                   1252: sub help_open_topic {
1.1075.2.161.  .6(raebu 1253:22):     my ($topic, $text, $stayOnPage, $width, $height, $imgid, $links_target) = @_;
1.48      bowersj2 1254:     $text = "" if (not defined $text);
1.44      bowersj2 1255:     $stayOnPage = 0 if (not defined $stayOnPage);
1.1033    www      1256:     $width = 500 if (not defined $width);
1.44      bowersj2 1257:     $height = 400 if (not defined $height);
                   1258:     my $filename = $topic;
                   1259:     $filename =~ s/ /_/g;
                   1260: 
1.48      bowersj2 1261:     my $template = "";
                   1262:     my $link;
1.572     banghart 1263:     
1.159     www      1264:     $topic=~s/\W/\_/g;
1.44      bowersj2 1265: 
1.572     banghart 1266:     if (!$stayOnPage) {
1.1075.2.50  raeburn  1267:         if ($env{'browser.mobile'}) {
                   1268: 	    $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
                   1269:         } else {
                   1270:             $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1271:         }
1.1037    www      1272:     } elsif ($stayOnPage eq 'popup') {
                   1273:         $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 1274:     } else {
1.48      bowersj2 1275: 	$link = "/adm/help/${filename}.hlp";
                   1276:     }
                   1277: 
                   1278:     # Add the text
1.1075.2.161.  .6(raebu 1279:22):     my $target = ' target="_top"';
                   1280:22):     if ($links_target) {
                   1281:22):         $target = ' target="'.$links_target.'"';
                   1282:22):     } elsif (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self')) {
                   1283:22):         $target = '';
                   1284:22):     }
1.755     neumanie 1285:     if ($text ne "") {	
1.763     bisitz   1286: 	$template.='<span class="LC_help_open_topic">'
1.1075.2.161.  .6(raebu 1287:22):                   .'<a'.$target.' href="'.$link.'">'
1.763     bisitz   1288:                   .$text.'</a>';
1.48      bowersj2 1289:     }
                   1290: 
1.763     bisitz   1291:     # (Always) Add the graphic
1.179     matthew  1292:     my $title = &mt('Online Help');
1.667     raeburn  1293:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973     raeburn  1294:     if ($imgid ne '') {
                   1295:         $imgid = ' id="'.$imgid.'"';
                   1296:     }
1.1075.2.161.  .6(raebu 1297:22):     $template.=' <a'.$target.' href="'.$link.'" title="'.$title.'">'
1.763     bisitz   1298:               .'<img src="'.$helpicon.'" border="0"'
                   1299:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973     raeburn  1300:               .' title="'.$title.'" style="vertical-align:middle;"'.$imgid 
1.763     bisitz   1301:               .' /></a>';
                   1302:     if ($text ne "") {	
                   1303:         $template.='</span>';
                   1304:     }
1.44      bowersj2 1305:     return $template;
                   1306: 
1.106     bowersj2 1307: }
                   1308: 
                   1309: # This is a quicky function for Latex cheatsheet editing, since it 
                   1310: # appears in at least four places
                   1311: sub helpLatexCheatsheet {
1.1037    www      1312:     my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732     raeburn  1313:     my $out;
1.106     bowersj2 1314:     my $addOther = '';
1.732     raeburn  1315:     if ($topic) {
1.1037    www      1316: 	$addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763     bisitz   1317:     }
                   1318:     $out = '<span>' # Start cheatsheet
                   1319: 	  .$addOther
                   1320:           .'<span>'
1.1037    www      1321: 	  .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1322: 	  .'</span> <span>'
1.1037    www      1323: 	  .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1324: 	  .'</span>';
1.732     raeburn  1325:     unless ($not_author) {
1.763     bisitz   1326:         $out .= ' <span>'
1.1037    www      1327: 	       .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.1075.2.71  raeburn  1328: 	       .'</span> <span>'
1.1075.2.78  raeburn  1329:                .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.1075.2.71  raeburn  1330:                .'</span>';
1.732     raeburn  1331:     }
1.763     bisitz   1332:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1333:     return $out;
1.172     www      1334: }
                   1335: 
1.430     albertel 1336: sub general_help {
                   1337:     my $helptopic='Student_Intro';
                   1338:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1339: 	$helptopic='Authoring_Intro';
1.907     raeburn  1340:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1341: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1342:     } elsif ($env{'request.role'}=~/^dc/) {
                   1343:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1344:     }
                   1345:     return $helptopic;
                   1346: }
                   1347: 
                   1348: sub update_help_link {
                   1349:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1350:     my $origurl = $ENV{'REQUEST_URI'};
                   1351:     $origurl=~s|^/~|/priv/|;
                   1352:     my $timestamp = time;
                   1353:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1354:         $$datum = &escape($$datum);
                   1355:     }
                   1356: 
                   1357:     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";
                   1358:     my $output .= <<"ENDOUTPUT";
                   1359: <script type="text/javascript">
1.824     bisitz   1360: // <![CDATA[
1.430     albertel 1361: banner_link = '$banner_link';
1.824     bisitz   1362: // ]]>
1.430     albertel 1363: </script>
                   1364: ENDOUTPUT
                   1365:     return $output;
                   1366: }
                   1367: 
                   1368: # now just updates the help link and generates a blue icon
1.193     raeburn  1369: sub help_open_menu {
1.1075.2.161.  .6(raebu 1370:22):     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text,$links_target) 
1.552     banghart 1371: 	= @_;    
1.949     droeschl 1372:     $stayOnPage = 1;
1.430     albertel 1373:     my $output;
                   1374:     if ($component_help) {
                   1375: 	if (!$text) {
                   1376: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
1.1075.2.161.  .6(raebu 1377:22): 				       $width,$height,'',$links_target);
1.430     albertel 1378: 	} else {
                   1379: 	    my $help_text;
                   1380: 	    $help_text=&unescape($topic);
                   1381: 	    $output='<table><tr><td>'.
                   1382: 		&help_open_topic($component_help,$help_text,$stayOnPage,
1.1075.2.161.  .6(raebu 1383:22): 				 $width,$height,'',$links_target).'</td></tr></table>';
1.430     albertel 1384: 	}
                   1385:     }
                   1386:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1387:     return $output.$banner_link;
                   1388: }
                   1389: 
                   1390: sub top_nav_help {
1.1075.2.158  raeburn  1391:     my ($text,$linkattr) = @_;
1.436     albertel 1392:     $text = &mt($text);
1.1075.2.60  raeburn  1393:     my $stay_on_page;
                   1394:     unless ($env{'environment.remote'} eq 'on') {
                   1395:         $stay_on_page = 1;
                   1396:     }
1.1075.2.61  raeburn  1397:     my ($link,$banner_link);
                   1398:     unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
                   1399:         $link = ($stay_on_page) ? "javascript:helpMenu('display')"
                   1400: 	                         : "javascript:helpMenu('open')";
                   1401:         $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
                   1402:     }
1.201     raeburn  1403:     my $title = &mt('Get help');
1.1075.2.61  raeburn  1404:     if ($link) {
                   1405:         return <<"END";
1.436     albertel 1406: $banner_link
1.1075.2.158  raeburn  1407: <a href="$link" title="$title" $linkattr>$text</a>
1.436     albertel 1408: END
1.1075.2.61  raeburn  1409:     } else {
                   1410:         return '&nbsp;'.$text.'&nbsp;';
                   1411:     }
1.436     albertel 1412: }
                   1413: 
                   1414: sub help_menu_js {
1.1075.2.52  raeburn  1415:     my ($httphost) = @_;
1.949     droeschl 1416:     my $stayOnPage = 1;
1.436     albertel 1417:     my $width = 620;
                   1418:     my $height = 600;
1.430     albertel 1419:     my $helptopic=&general_help();
1.1075.2.52  raeburn  1420:     my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1421:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1422:     my $start_page =
                   1423:         &Apache::loncommon::start_page('Help Menu', undef,
                   1424: 				       {'frameset'    => 1,
                   1425: 					'js_ready'    => 1,
1.1075.2.136  raeburn  1426:                                         'use_absolute' => $httphost,
1.331     albertel 1427: 					'add_entries' => {
                   1428: 					    'border' => '0',
1.579     raeburn  1429: 					    'rows'   => "110,*",},});
1.331     albertel 1430:     my $end_page =
                   1431:         &Apache::loncommon::end_page({'frameset' => 1,
                   1432: 				      'js_ready' => 1,});
                   1433: 
1.436     albertel 1434:     my $template .= <<"ENDTEMPLATE";
                   1435: <script type="text/javascript">
1.877     bisitz   1436: // <![CDATA[
1.253     albertel 1437: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1438: var banner_link = '';
1.243     raeburn  1439: function helpMenu(target) {
                   1440:     var caller = this;
                   1441:     if (target == 'open') {
                   1442:         var newWindow = null;
                   1443:         try {
1.262     albertel 1444:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1445:         }
                   1446:         catch(error) {
                   1447:             writeHelp(caller);
                   1448:             return;
                   1449:         }
                   1450:         if (newWindow) {
                   1451:             caller = newWindow;
                   1452:         }
1.193     raeburn  1453:     }
1.243     raeburn  1454:     writeHelp(caller);
                   1455:     return;
                   1456: }
                   1457: function writeHelp(caller) {
1.1075.2.61  raeburn  1458:     caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
                   1459:     caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
                   1460:     caller.document.close();
                   1461:     caller.focus();
1.193     raeburn  1462: }
1.877     bisitz   1463: // END LON-CAPA Internal -->
1.253     albertel 1464: // ]]>
1.436     albertel 1465: </script>
1.193     raeburn  1466: ENDTEMPLATE
                   1467:     return $template;
                   1468: }
                   1469: 
1.172     www      1470: sub help_open_bug {
                   1471:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1472:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1473:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1474:     $text = "" if (not defined $text);
                   1475: 	$stayOnPage=1;
1.184     albertel 1476:     $width = 600 if (not defined $width);
                   1477:     $height = 600 if (not defined $height);
1.172     www      1478: 
                   1479:     $topic=~s/\W+/\+/g;
                   1480:     my $link='';
                   1481:     my $template='';
1.379     albertel 1482:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1483: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1484:     if (!$stayOnPage)
                   1485:     {
                   1486: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1487:     }
                   1488:     else
                   1489:     {
                   1490: 	$link = $url;
                   1491:     }
1.1075.2.161.  .6(raebu 1492:22): 
                   1493:22):     my $target = '_top';
                   1494:22):     if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
                   1495:22):         (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
                   1496:22):         $target = '_blank';
                   1497:22):     }
                   1498:22): 
1.172     www      1499:     # Add the text
                   1500:     if ($text ne "")
                   1501:     {
                   1502: 	$template .= 
                   1503:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.1075.2.161.  .6(raebu 1504:22):   "<td bgcolor='#FF5555'><a target=\"$target\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1505:     }
                   1506: 
                   1507:     # Add the graphic
1.179     matthew  1508:     my $title = &mt('Report a Bug');
1.215     albertel 1509:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1510:     $template .= <<"ENDTEMPLATE";
1.1075.2.161.  .6(raebu 1511:22):  <a target="$target" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1512: ENDTEMPLATE
                   1513:     if ($text ne '') { $template.='</td></tr></table>' };
                   1514:     return $template;
                   1515: 
                   1516: }
                   1517: 
                   1518: sub help_open_faq {
                   1519:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1520:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1521:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1522:     $text = "" if (not defined $text);
                   1523: 	$stayOnPage=1;
                   1524:     $width = 350 if (not defined $width);
                   1525:     $height = 400 if (not defined $height);
                   1526: 
                   1527:     $topic=~s/\W+/\+/g;
                   1528:     my $link='';
                   1529:     my $template='';
                   1530:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1531:     if (!$stayOnPage)
                   1532:     {
                   1533: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1534:     }
                   1535:     else
                   1536:     {
                   1537: 	$link = $url;
                   1538:     }
                   1539: 
                   1540:     # Add the text
                   1541:     if ($text ne "")
                   1542:     {
                   1543: 	$template .= 
1.173     www      1544:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1545:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1546:     }
                   1547: 
                   1548:     # Add the graphic
1.179     matthew  1549:     my $title = &mt('View the FAQ');
1.215     albertel 1550:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1551:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1552:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1553: ENDTEMPLATE
                   1554:     if ($text ne '') { $template.='</td></tr></table>' };
                   1555:     return $template;
                   1556: 
1.44      bowersj2 1557: }
1.37      matthew  1558: 
1.180     matthew  1559: ###############################################################
                   1560: ###############################################################
                   1561: 
1.45      matthew  1562: =pod
                   1563: 
1.648     raeburn  1564: =item * &change_content_javascript():
1.256     matthew  1565: 
                   1566: This and the next function allow you to create small sections of an
                   1567: otherwise static HTML page that you can update on the fly with
                   1568: Javascript, even in Netscape 4.
                   1569: 
                   1570: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1571: must be written to the HTML page once. It will prove the Javascript
                   1572: function "change(name, content)". Calling the change function with the
                   1573: name of the section 
                   1574: you want to update, matching the name passed to C<changable_area>, and
                   1575: the new content you want to put in there, will put the content into
                   1576: that area.
                   1577: 
                   1578: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1579: to contain room for the original contents. You need to "make space"
                   1580: for whatever changes you wish to make, and be B<sure> to check your
                   1581: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1582: it's adequate for updating a one-line status display, but little more.
                   1583: This script will set the space to 100% width, so you only need to
                   1584: worry about height in Netscape 4.
                   1585: 
                   1586: Modern browsers are much less limiting, and if you can commit to the
                   1587: user not using Netscape 4, this feature may be used freely with
                   1588: pretty much any HTML.
                   1589: 
                   1590: =cut
                   1591: 
                   1592: sub change_content_javascript {
                   1593:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1594:     if ($env{'browser.type'} eq 'netscape' &&
                   1595: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1596: 	return (<<NETSCAPE4);
                   1597: 	function change(name, content) {
                   1598: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1599: 	    doc.open();
                   1600: 	    doc.write(content);
                   1601: 	    doc.close();
                   1602: 	}
                   1603: NETSCAPE4
                   1604:     } else {
                   1605: 	# Otherwise, we need to use semi-standards-compliant code
                   1606: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1607: 	# is really scary, and every useful browser supports it
                   1608: 	return (<<DOMBASED);
                   1609: 	function change(name, content) {
                   1610: 	    element = document.getElementById(name);
                   1611: 	    element.innerHTML = content;
                   1612: 	}
                   1613: DOMBASED
                   1614:     }
                   1615: }
                   1616: 
                   1617: =pod
                   1618: 
1.648     raeburn  1619: =item * &changable_area($name,$origContent):
1.256     matthew  1620: 
                   1621: This provides a "changable area" that can be modified on the fly via
                   1622: the Javascript code provided in C<change_content_javascript>. $name is
                   1623: the name you will use to reference the area later; do not repeat the
                   1624: same name on a given HTML page more then once. $origContent is what
                   1625: the area will originally contain, which can be left blank.
                   1626: 
                   1627: =cut
                   1628: 
                   1629: sub changable_area {
                   1630:     my ($name, $origContent) = @_;
                   1631: 
1.258     albertel 1632:     if ($env{'browser.type'} eq 'netscape' &&
                   1633: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1634: 	# If this is netscape 4, we need to use the Layer tag
                   1635: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1636:     } else {
                   1637: 	return "<span id='$name'>$origContent</span>";
                   1638:     }
                   1639: }
                   1640: 
                   1641: =pod
                   1642: 
1.648     raeburn  1643: =item * &viewport_geometry_js 
1.590     raeburn  1644: 
                   1645: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1646: 
                   1647: =cut
                   1648: 
                   1649: 
                   1650: sub viewport_geometry_js { 
                   1651:     return <<"GEOMETRY";
                   1652: var Geometry = {};
                   1653: function init_geometry() {
                   1654:     if (Geometry.init) { return };
                   1655:     Geometry.init=1;
                   1656:     if (window.innerHeight) {
                   1657:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1658:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1659:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1660:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1661:     }
                   1662:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1663:         Geometry.getViewportHeight =
                   1664:             function() { return document.documentElement.clientHeight; };
                   1665:         Geometry.getViewportWidth =
                   1666:             function() { return document.documentElement.clientWidth; };
                   1667: 
                   1668:         Geometry.getHorizontalScroll =
                   1669:             function() { return document.documentElement.scrollLeft; };
                   1670:         Geometry.getVerticalScroll =
                   1671:             function() { return document.documentElement.scrollTop; };
                   1672:     }
                   1673:     else if (document.body.clientHeight) {
                   1674:         Geometry.getViewportHeight =
                   1675:             function() { return document.body.clientHeight; };
                   1676:         Geometry.getViewportWidth =
                   1677:             function() { return document.body.clientWidth; };
                   1678:         Geometry.getHorizontalScroll =
                   1679:             function() { return document.body.scrollLeft; };
                   1680:         Geometry.getVerticalScroll =
                   1681:             function() { return document.body.scrollTop; };
                   1682:     }
                   1683: }
                   1684: 
                   1685: GEOMETRY
                   1686: }
                   1687: 
                   1688: =pod
                   1689: 
1.648     raeburn  1690: =item * &viewport_size_js()
1.590     raeburn  1691: 
                   1692: 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. 
                   1693: 
                   1694: =cut
                   1695: 
                   1696: sub viewport_size_js {
                   1697:     my $geometry = &viewport_geometry_js();
                   1698:     return <<"DIMS";
                   1699: 
                   1700: $geometry
                   1701: 
                   1702: function getViewportDims(width,height) {
                   1703:     init_geometry();
                   1704:     width.value = Geometry.getViewportWidth();
                   1705:     height.value = Geometry.getViewportHeight();
                   1706:     return;
                   1707: }
                   1708: 
                   1709: DIMS
                   1710: }
                   1711: 
                   1712: =pod
                   1713: 
1.648     raeburn  1714: =item * &resize_textarea_js()
1.565     albertel 1715: 
                   1716: emits the needed javascript to resize a textarea to be as big as possible
                   1717: 
                   1718: creates a function resize_textrea that takes two IDs first should be
                   1719: the id of the element to resize, second should be the id of a div that
                   1720: surrounds everything that comes after the textarea, this routine needs
                   1721: to be attached to the <body> for the onload and onresize events.
                   1722: 
1.648     raeburn  1723: =back
1.565     albertel 1724: 
                   1725: =cut
                   1726: 
                   1727: sub resize_textarea_js {
1.590     raeburn  1728:     my $geometry = &viewport_geometry_js();
1.565     albertel 1729:     return <<"RESIZE";
                   1730:     <script type="text/javascript">
1.824     bisitz   1731: // <![CDATA[
1.590     raeburn  1732: $geometry
1.565     albertel 1733: 
1.588     albertel 1734: function getX(element) {
                   1735:     var x = 0;
                   1736:     while (element) {
                   1737: 	x += element.offsetLeft;
                   1738: 	element = element.offsetParent;
                   1739:     }
                   1740:     return x;
                   1741: }
                   1742: function getY(element) {
                   1743:     var y = 0;
                   1744:     while (element) {
                   1745: 	y += element.offsetTop;
                   1746: 	element = element.offsetParent;
                   1747:     }
                   1748:     return y;
                   1749: }
                   1750: 
                   1751: 
1.565     albertel 1752: function resize_textarea(textarea_id,bottom_id) {
                   1753:     init_geometry();
                   1754:     var textarea        = document.getElementById(textarea_id);
                   1755:     //alert(textarea);
                   1756: 
1.588     albertel 1757:     var textarea_top    = getY(textarea);
1.565     albertel 1758:     var textarea_height = textarea.offsetHeight;
                   1759:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1760:     var bottom_top      = getY(bottom);
1.565     albertel 1761:     var bottom_height   = bottom.offsetHeight;
                   1762:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1763:     var fudge           = 23;
1.565     albertel 1764:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1765:     if (new_height < 300) {
                   1766: 	new_height = 300;
                   1767:     }
                   1768:     textarea.style.height=new_height+'px';
                   1769: }
1.824     bisitz   1770: // ]]>
1.565     albertel 1771: </script>
                   1772: RESIZE
                   1773: 
                   1774: }
                   1775: 
1.1075.2.112  raeburn  1776: sub colorfuleditor_js {
                   1777:     return <<"COLORFULEDIT"
                   1778: <script type="text/javascript">
                   1779: // <![CDATA[>
                   1780:     function fold_box(curDepth, lastresource){
                   1781: 
                   1782:     // we need a list because there can be several blocks you need to fold in one tag
                   1783:         var block = document.getElementsByName('foldblock_'+curDepth);
                   1784:     // but there is only one folding button per tag
                   1785:         var foldbutton = document.getElementById('folding_btn_'+curDepth);
                   1786: 
                   1787:         if(block.item(0).style.display == 'none'){
                   1788: 
                   1789:             foldbutton.value = '@{[&mt("Hide")]}';
                   1790:             for (i = 0; i < block.length; i++){
                   1791:                 block.item(i).style.display = '';
                   1792:             }
                   1793:         }else{
                   1794: 
                   1795:             foldbutton.value = '@{[&mt("Show")]}';
                   1796:             for (i = 0; i < block.length; i++){
                   1797:                 // block.item(i).style.visibility = 'collapse';
                   1798:                 block.item(i).style.display = 'none';
                   1799:             }
                   1800:         };
                   1801:         saveState(lastresource);
                   1802:     }
                   1803: 
                   1804:     function saveState (lastresource) {
                   1805: 
                   1806:         var tag_list = getTagList();
                   1807:         if(tag_list != null){
                   1808:             var timestamp = new Date().getTime();
                   1809:             var key = lastresource;
                   1810: 
                   1811:             // the value pattern is: 'time;key1,value1;key2,value2; ... '
                   1812:             // starting with timestamp
                   1813:             var value = timestamp+';';
                   1814: 
                   1815:             // building the list of key-value pairs
                   1816:             for(var i = 0; i < tag_list.length; i++){
                   1817:                 value += tag_list[i]+',';
                   1818:                 value += document.getElementsByName(tag_list[i])[0].style.display+';';
                   1819:             }
                   1820: 
                   1821:             // only iterate whole storage if nothing to override
                   1822:             if(localStorage.getItem(key) == null){
                   1823: 
                   1824:                 // prevent storage from growing large
                   1825:                 if(localStorage.length > 50){
                   1826:                     var regex_getTimestamp = /^(?:\d)+;/;
                   1827:                     var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
                   1828:                     var oldest_key;
                   1829: 
                   1830:                     for(var i = 1; i < localStorage.length; i++){
                   1831:                         if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
                   1832:                             oldest_key = localStorage.key(i);
                   1833:                             oldest_timestamp = regex_getTimestamp.exec(oldest_key);
                   1834:                         }
                   1835:                     }
                   1836:                     localStorage.removeItem(oldest_key);
                   1837:                 }
                   1838:             }
                   1839:             localStorage.setItem(key,value);
                   1840:         }
                   1841:     }
                   1842: 
                   1843:     // restore folding status of blocks (on page load)
                   1844:     function restoreState (lastresource) {
                   1845:         if(localStorage.getItem(lastresource) != null){
                   1846:             var key = lastresource;
                   1847:             var value = localStorage.getItem(key);
                   1848:             var regex_delTimestamp = /^\d+;/;
                   1849: 
                   1850:             value.replace(regex_delTimestamp, '');
                   1851: 
                   1852:             var valueArr = value.split(';');
                   1853:             var pairs;
                   1854:             var elements;
                   1855:             for (var i = 0; i < valueArr.length; i++){
                   1856:                 pairs = valueArr[i].split(',');
                   1857:                 elements = document.getElementsByName(pairs[0]);
                   1858: 
                   1859:                 for (var j = 0; j < elements.length; j++){
                   1860:                     elements[j].style.display = pairs[1];
                   1861:                     if (pairs[1] == "none"){
                   1862:                         var regex_id = /([_\\d]+)\$/;
                   1863:                         regex_id.exec(pairs[0]);
                   1864:                         document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
                   1865:                     }
                   1866:                 }
                   1867:             }
                   1868:         }
                   1869:     }
                   1870: 
                   1871:     function getTagList () {
                   1872: 
                   1873:         var stringToSearch = document.lonhomework.innerHTML;
                   1874: 
                   1875:         var ret = new Array();
                   1876:         var regex_findBlock = /(foldblock_.*?)"/g;
                   1877:         var tag_list = stringToSearch.match(regex_findBlock);
                   1878: 
                   1879:         if(tag_list != null){
                   1880:             for(var i = 0; i < tag_list.length; i++){
                   1881:                 ret.push(tag_list[i].replace(/"/, ''));
                   1882:             }
                   1883:         }
                   1884:         return ret;
                   1885:     }
                   1886: 
                   1887:     function saveScrollPosition (resource) {
                   1888:         var tag_list = getTagList();
                   1889: 
                   1890:         // we dont always want to jump to the first block
                   1891:         // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
                   1892:         if(\$(window).scrollTop() > 170){
                   1893:             if(tag_list != null){
                   1894:                 var result;
                   1895:                 for(var i = 0; i < tag_list.length; i++){
                   1896:                     if(isElementInViewport(tag_list[i])){
                   1897:                         result += tag_list[i]+';';
                   1898:                     }
                   1899:                 }
                   1900:                 sessionStorage.setItem('anchor_'+resource, result);
                   1901:             }
                   1902:         } else {
                   1903:             // we dont need to save zero, just delete the item to leave everything tidy
                   1904:             sessionStorage.removeItem('anchor_'+resource);
                   1905:         }
                   1906:     }
                   1907: 
                   1908:     function restoreScrollPosition(resource){
                   1909: 
                   1910:         var elem = sessionStorage.getItem('anchor_'+resource);
                   1911:         if(elem != null){
                   1912:             var tag_list = elem.split(';');
                   1913:             var elem_list;
                   1914: 
                   1915:             for(var i = 0; i < tag_list.length; i++){
                   1916:                 elem_list = document.getElementsByName(tag_list[i]);
                   1917: 
                   1918:                 if(elem_list.length > 0){
                   1919:                     elem = elem_list[0];
                   1920:                     break;
                   1921:                 }
                   1922:             }
                   1923:             elem.scrollIntoView();
                   1924:         }
                   1925:     }
                   1926: 
                   1927:     function isElementInViewport(el) {
                   1928: 
                   1929:         // change to last element instead of first
                   1930:         var elem = document.getElementsByName(el);
                   1931:         var rect = elem[0].getBoundingClientRect();
                   1932: 
                   1933:         return (
                   1934:             rect.top >= 0 &&
                   1935:             rect.left >= 0 &&
                   1936:             rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
                   1937:             rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
                   1938:         );
                   1939:     }
                   1940: 
                   1941:     function autosize(depth){
                   1942:         var cmInst = window['cm'+depth];
                   1943:         var fitsizeButton = document.getElementById('fitsize'+depth);
                   1944: 
                   1945:         // is fixed size, switching to dynamic
                   1946:         if (sessionStorage.getItem("autosized_"+depth) == null) {
                   1947:             cmInst.setSize("","auto");
                   1948:             fitsizeButton.value = "@{[&mt('Fixed size')]}";
                   1949:             sessionStorage.setItem("autosized_"+depth, "yes");
                   1950: 
                   1951:         // is dynamic size, switching to fixed
                   1952:         } else {
                   1953:             cmInst.setSize("","300px");
                   1954:             fitsizeButton.value = "@{[&mt('Dynamic size')]}";
                   1955:             sessionStorage.removeItem("autosized_"+depth);
                   1956:         }
                   1957:     }
                   1958: 
                   1959: 
                   1960: 
                   1961: // ]]>
                   1962: </script>
                   1963: COLORFULEDIT
                   1964: }
                   1965: 
                   1966: sub xmleditor_js {
                   1967:     return <<XMLEDIT
                   1968: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
                   1969: <script type="text/javascript">
                   1970: // <![CDATA[>
                   1971: 
                   1972:     function saveScrollPosition (resource) {
                   1973: 
                   1974:         var scrollPos = \$(window).scrollTop();
                   1975:         sessionStorage.setItem(resource,scrollPos);
                   1976:     }
                   1977: 
                   1978:     function restoreScrollPosition(resource){
                   1979: 
                   1980:         var scrollPos = sessionStorage.getItem(resource);
                   1981:         \$(window).scrollTop(scrollPos);
                   1982:     }
                   1983: 
                   1984:     // unless internet explorer
                   1985:     if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
                   1986: 
                   1987:         \$(document).ready(function() {
                   1988:              \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
                   1989:         });
                   1990:     }
                   1991: 
                   1992:     // inserts text at cursor position into codemirror (xml editor only)
                   1993:     function insertText(text){
                   1994:         cm.focus();
                   1995:         var curPos = cm.getCursor();
                   1996:         cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
                   1997:     }
                   1998: // ]]>
                   1999: </script>
                   2000: XMLEDIT
                   2001: }
                   2002: 
                   2003: sub insert_folding_button {
                   2004:     my $curDepth = $Apache::lonxml::curdepth;
                   2005:     my $lastresource = $env{'request.ambiguous'};
                   2006: 
                   2007:     return "<input type=\"button\" id=\"folding_btn_$curDepth\"
                   2008:             value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
                   2009: }
                   2010: 
                   2011: 
1.565     albertel 2012: =pod
                   2013: 
1.256     matthew  2014: =head1 Excel and CSV file utility routines
                   2015: 
                   2016: =cut
                   2017: 
                   2018: ###############################################################
                   2019: ###############################################################
                   2020: 
                   2021: =pod
                   2022: 
1.1075.2.56  raeburn  2023: =over 4
                   2024: 
1.648     raeburn  2025: =item * &csv_translate($text) 
1.37      matthew  2026: 
1.185     www      2027: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  2028: format.
                   2029: 
                   2030: =cut
                   2031: 
1.180     matthew  2032: ###############################################################
                   2033: ###############################################################
1.37      matthew  2034: sub csv_translate {
                   2035:     my $text = shift;
                   2036:     $text =~ s/\"/\"\"/g;
1.209     albertel 2037:     $text =~ s/\n/ /g;
1.37      matthew  2038:     return $text;
                   2039: }
1.180     matthew  2040: 
                   2041: ###############################################################
                   2042: ###############################################################
                   2043: 
                   2044: =pod
                   2045: 
1.648     raeburn  2046: =item * &define_excel_formats()
1.180     matthew  2047: 
                   2048: Define some commonly used Excel cell formats.
                   2049: 
                   2050: Currently supported formats:
                   2051: 
                   2052: =over 4
                   2053: 
                   2054: =item header
                   2055: 
                   2056: =item bold
                   2057: 
                   2058: =item h1
                   2059: 
                   2060: =item h2
                   2061: 
                   2062: =item h3
                   2063: 
1.256     matthew  2064: =item h4
                   2065: 
                   2066: =item i
                   2067: 
1.180     matthew  2068: =item date
                   2069: 
                   2070: =back
                   2071: 
                   2072: Inputs: $workbook
                   2073: 
                   2074: Returns: $format, a hash reference.
                   2075: 
1.1057    foxr     2076: 
1.180     matthew  2077: =cut
                   2078: 
                   2079: ###############################################################
                   2080: ###############################################################
                   2081: sub define_excel_formats {
                   2082:     my ($workbook) = @_;
                   2083:     my $format;
                   2084:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   2085:                                                 bottom    => 1,
                   2086:                                                 align     => 'center');
                   2087:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   2088:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   2089:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   2090:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  2091:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  2092:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  2093:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  2094:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  2095:     return $format;
                   2096: }
                   2097: 
                   2098: ###############################################################
                   2099: ###############################################################
1.113     bowersj2 2100: 
                   2101: =pod
                   2102: 
1.648     raeburn  2103: =item * &create_workbook()
1.255     matthew  2104: 
                   2105: Create an Excel worksheet.  If it fails, output message on the
                   2106: request object and return undefs.
                   2107: 
                   2108: Inputs: Apache request object
                   2109: 
                   2110: Returns (undef) on failure, 
                   2111:     Excel worksheet object, scalar with filename, and formats 
                   2112:     from &Apache::loncommon::define_excel_formats on success
                   2113: 
                   2114: =cut
                   2115: 
                   2116: ###############################################################
                   2117: ###############################################################
                   2118: sub create_workbook {
                   2119:     my ($r) = @_;
                   2120:         #
                   2121:     # Create the excel spreadsheet
                   2122:     my $filename = '/prtspool/'.
1.258     albertel 2123:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  2124:         time.'_'.rand(1000000000).'.xls';
                   2125:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   2126:     if (! defined($workbook)) {
                   2127:         $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928     bisitz   2128:         $r->print(
                   2129:             '<p class="LC_error">'
                   2130:            .&mt('Problems occurred in creating the new Excel file.')
                   2131:            .' '.&mt('This error has been logged.')
                   2132:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2133:            .'</p>'
                   2134:         );
1.255     matthew  2135:         return (undef);
                   2136:     }
                   2137:     #
1.1014    foxr     2138:     $workbook->set_tempdir(LONCAPA::tempdir());
1.255     matthew  2139:     #
                   2140:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   2141:     return ($workbook,$filename,$format);
                   2142: }
                   2143: 
                   2144: ###############################################################
                   2145: ###############################################################
                   2146: 
                   2147: =pod
                   2148: 
1.648     raeburn  2149: =item * &create_text_file()
1.113     bowersj2 2150: 
1.542     raeburn  2151: Create a file to write to and eventually make available to the user.
1.256     matthew  2152: If file creation fails, outputs an error message on the request object and 
                   2153: return undefs.
1.113     bowersj2 2154: 
1.256     matthew  2155: Inputs: Apache request object, and file suffix
1.113     bowersj2 2156: 
1.256     matthew  2157: Returns (undef) on failure, 
                   2158:     Filehandle and filename on success.
1.113     bowersj2 2159: 
                   2160: =cut
                   2161: 
1.256     matthew  2162: ###############################################################
                   2163: ###############################################################
                   2164: sub create_text_file {
                   2165:     my ($r,$suffix) = @_;
                   2166:     if (! defined($suffix)) { $suffix = 'txt'; };
                   2167:     my $fh;
                   2168:     my $filename = '/prtspool/'.
1.258     albertel 2169:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  2170:         time.'_'.rand(1000000000).'.'.$suffix;
                   2171:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   2172:     if (! defined($fh)) {
                   2173:         $r->log_error("Couldn't open $filename for output $!");
1.928     bisitz   2174:         $r->print(
                   2175:             '<p class="LC_error">'
                   2176:            .&mt('Problems occurred in creating the output file.')
                   2177:            .' '.&mt('This error has been logged.')
                   2178:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2179:            .'</p>'
                   2180:         );
1.113     bowersj2 2181:     }
1.256     matthew  2182:     return ($fh,$filename)
1.113     bowersj2 2183: }
                   2184: 
                   2185: 
1.256     matthew  2186: =pod 
1.113     bowersj2 2187: 
                   2188: =back
                   2189: 
                   2190: =cut
1.37      matthew  2191: 
                   2192: ###############################################################
1.33      matthew  2193: ##        Home server <option> list generating code          ##
                   2194: ###############################################################
1.35      matthew  2195: 
1.169     www      2196: # ------------------------------------------
                   2197: 
                   2198: sub domain_select {
                   2199:     my ($name,$value,$multiple)=@_;
                   2200:     my %domains=map { 
1.514     albertel 2201: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 2202:     } &Apache::lonnet::all_domains();
1.169     www      2203:     if ($multiple) {
                   2204: 	$domains{''}=&mt('Any domain');
1.550     albertel 2205: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 2206: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      2207:     } else {
1.550     albertel 2208: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970     raeburn  2209: 	return &select_form($name,$value,\%domains);
1.169     www      2210:     }
                   2211: }
                   2212: 
1.282     albertel 2213: #-------------------------------------------
                   2214: 
                   2215: =pod
                   2216: 
1.519     raeburn  2217: =head1 Routines for form select boxes
                   2218: 
                   2219: =over 4
                   2220: 
1.648     raeburn  2221: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 2222: 
                   2223: Returns a string containing a <select> element int multiple mode
                   2224: 
                   2225: 
                   2226: Args:
                   2227:   $name - name of the <select> element
1.506     raeburn  2228:   $value - scalar or array ref of values that should already be selected
1.282     albertel 2229:   $size - number of rows long the select element is
1.283     albertel 2230:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 2231:           (shown text should already have been &mt())
1.506     raeburn  2232:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 2233: 
1.282     albertel 2234: =cut
                   2235: 
                   2236: #-------------------------------------------
1.169     www      2237: sub multiple_select_form {
1.284     albertel 2238:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      2239:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   2240:     my $output='';
1.191     matthew  2241:     if (! defined($size)) {
                   2242:         $size = 4;
1.283     albertel 2243:         if (scalar(keys(%$hash))<4) {
                   2244:             $size = scalar(keys(%$hash));
1.191     matthew  2245:         }
                   2246:     }
1.734     bisitz   2247:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 2248:     my @order;
1.506     raeburn  2249:     if (ref($order) eq 'ARRAY')  {
                   2250:         @order = @{$order};
                   2251:     } else {
                   2252:         @order = sort(keys(%$hash));
1.501     banghart 2253:     }
                   2254:     if (exists($$hash{'select_form_order'})) {
                   2255:         @order = @{$$hash{'select_form_order'}};
                   2256:     }
                   2257:         
1.284     albertel 2258:     foreach my $key (@order) {
1.356     albertel 2259:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 2260:         $output.='selected="selected" ' if ($selected{$key});
                   2261:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      2262:     }
                   2263:     $output.="</select>\n";
                   2264:     return $output;
                   2265: }
                   2266: 
1.88      www      2267: #-------------------------------------------
                   2268: 
                   2269: =pod
                   2270: 
1.1075.2.115  raeburn  2271: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88      www      2272: 
                   2273: Returns a string containing a <select name='$name' size='1'> form to 
1.970     raeburn  2274: allow a user to select options from a ref to a hash containing:
                   2275: option_name => displayed text. An optional $onchange can include
1.1075.2.115  raeburn  2276: a javascript onchange item, e.g., onchange="this.form.submit();".
                   2277: An optional arg -- $readonly -- if true will cause the select form
                   2278: to be disabled, e.g., for the case where an instructor has a section-
                   2279: specific role, and is viewing/modifying parameters.  
1.970     raeburn  2280: 
1.88      www      2281: See lonrights.pm for an example invocation and use.
                   2282: 
                   2283: =cut
                   2284: 
                   2285: #-------------------------------------------
                   2286: sub select_form {
1.1075.2.115  raeburn  2287:     my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970     raeburn  2288:     return unless (ref($hashref) eq 'HASH');
                   2289:     if ($onchange) {
                   2290:         $onchange = ' onchange="'.$onchange.'"';
                   2291:     }
1.1075.2.129  raeburn  2292:     my $disabled;
                   2293:     if ($readonly) {
                   2294:         $disabled = ' disabled="disabled"';
                   2295:     }
                   2296:     my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128     albertel 2297:     my @keys;
1.970     raeburn  2298:     if (exists($hashref->{'select_form_order'})) {
                   2299: 	@keys=@{$hashref->{'select_form_order'}};
1.128     albertel 2300:     } else {
1.970     raeburn  2301: 	@keys=sort(keys(%{$hashref}));
1.128     albertel 2302:     }
1.356     albertel 2303:     foreach my $key (@keys) {
                   2304:         $selectform.=
                   2305: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   2306:             ($key eq $def ? 'selected="selected" ' : '').
1.970     raeburn  2307:                 ">".$hashref->{$key}."</option>\n";
1.88      www      2308:     }
                   2309:     $selectform.="</select>";
                   2310:     return $selectform;
                   2311: }
                   2312: 
1.475     www      2313: # For display filters
                   2314: 
                   2315: sub display_filter {
1.1074    raeburn  2316:     my ($context) = @_;
1.475     www      2317:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      2318:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074    raeburn  2319:     my $phraseinput = 'hidden';
                   2320:     my $includeinput = 'hidden';
                   2321:     my ($checked,$includetypestext);
                   2322:     if ($env{'form.displayfilter'} eq 'containing') {
                   2323:         $phraseinput = 'text'; 
                   2324:         if ($context eq 'parmslog') {
                   2325:             $includeinput = 'checkbox';
                   2326:             if ($env{'form.includetypes'}) {
                   2327:                 $checked = ' checked="checked"';
                   2328:             }
                   2329:             $includetypestext = &mt('Include parameter types');
                   2330:         }
                   2331:     } else {
                   2332:         $includetypestext = '&nbsp;';
                   2333:     }
                   2334:     my ($additional,$secondid,$thirdid);
                   2335:     if ($context eq 'parmslog') {
                   2336:         $additional = 
                   2337:             '<label><input type="'.$includeinput.'" name="includetypes"'. 
                   2338:             $checked.' name="includetypes" value="1" id="includetypes" />'.
                   2339:             '&nbsp;<span id="includetypestext">'.$includetypestext.'</span>'.
                   2340:             '</label>';
                   2341:         $secondid = 'includetypes';
                   2342:         $thirdid = 'includetypestext';
                   2343:     }
                   2344:     my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
                   2345:                                                     '$secondid','$thirdid')";
                   2346:     return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475     www      2347: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   2348: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   2349: 	   '</label></span> <span class="LC_nobreak">'.
1.1074    raeburn  2350:            &mt('Filter: [_1]',
1.477     www      2351: 	   &select_form($env{'form.displayfilter'},
                   2352: 			'displayfilter',
1.970     raeburn  2353: 			{'currentfolder' => 'Current folder/page',
1.477     www      2354: 			 'containing' => 'Containing phrase',
1.1074    raeburn  2355: 			 'none' => 'None'},$onchange)).'&nbsp;'.
                   2356: 			 '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
                   2357:                          &HTML::Entities::encode($env{'form.containingphrase'}).
                   2358:                          '" />'.$additional;
                   2359: }
                   2360: 
                   2361: sub display_filter_js {
                   2362:     my $includetext = &mt('Include parameter types');
                   2363:     return <<"ENDJS";
                   2364:   
                   2365: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
                   2366:     var firstType = 'hidden';
                   2367:     if (setter.options[setter.selectedIndex].value == 'containing') {
                   2368:         firstType = 'text';
                   2369:     }
                   2370:     firstObject = document.getElementById(firstid);
                   2371:     if (typeof(firstObject) == 'object') {
                   2372:         if (firstObject.type != firstType) {
                   2373:             changeInputType(firstObject,firstType);
                   2374:         }
                   2375:     }
                   2376:     if (context == 'parmslog') {
                   2377:         var secondType = 'hidden';
                   2378:         if (firstType == 'text') {
                   2379:             secondType = 'checkbox';
                   2380:         }
                   2381:         secondObject = document.getElementById(secondid);  
                   2382:         if (typeof(secondObject) == 'object') {
                   2383:             if (secondObject.type != secondType) {
                   2384:                 changeInputType(secondObject,secondType);
                   2385:             }
                   2386:         }
                   2387:         var textItem = document.getElementById(thirdid);
                   2388:         var currtext = textItem.innerHTML;
                   2389:         var newtext;
                   2390:         if (firstType == 'text') {
                   2391:             newtext = '$includetext';
                   2392:         } else {
                   2393:             newtext = '&nbsp;';
                   2394:         }
                   2395:         if (currtext != newtext) {
                   2396:             textItem.innerHTML = newtext;
                   2397:         }
                   2398:     }
                   2399:     return;
                   2400: }
                   2401: 
                   2402: function changeInputType(oldObject,newType) {
                   2403:     var newObject = document.createElement('input');
                   2404:     newObject.type = newType;
                   2405:     if (oldObject.size) {
                   2406:         newObject.size = oldObject.size;
                   2407:     }
                   2408:     if (oldObject.value) {
                   2409:         newObject.value = oldObject.value;
                   2410:     }
                   2411:     if (oldObject.name) {
                   2412:         newObject.name = oldObject.name;
                   2413:     }
                   2414:     if (oldObject.id) {
                   2415:         newObject.id = oldObject.id;
                   2416:     }
                   2417:     oldObject.parentNode.replaceChild(newObject,oldObject);
                   2418:     return;
                   2419: }
                   2420: 
                   2421: ENDJS
1.475     www      2422: }
                   2423: 
1.167     www      2424: sub gradeleveldescription {
                   2425:     my $gradelevel=shift;
                   2426:     my %gradelevels=(0 => 'Not specified',
                   2427: 		     1 => 'Grade 1',
                   2428: 		     2 => 'Grade 2',
                   2429: 		     3 => 'Grade 3',
                   2430: 		     4 => 'Grade 4',
                   2431: 		     5 => 'Grade 5',
                   2432: 		     6 => 'Grade 6',
                   2433: 		     7 => 'Grade 7',
                   2434: 		     8 => 'Grade 8',
                   2435: 		     9 => 'Grade 9',
                   2436: 		     10 => 'Grade 10',
                   2437: 		     11 => 'Grade 11',
                   2438: 		     12 => 'Grade 12',
                   2439: 		     13 => 'Grade 13',
                   2440: 		     14 => '100 Level',
                   2441: 		     15 => '200 Level',
                   2442: 		     16 => '300 Level',
                   2443: 		     17 => '400 Level',
                   2444: 		     18 => 'Graduate Level');
                   2445:     return &mt($gradelevels{$gradelevel});
                   2446: }
                   2447: 
1.163     www      2448: sub select_level_form {
                   2449:     my ($deflevel,$name)=@_;
                   2450:     unless ($deflevel) { $deflevel=0; }
1.167     www      2451:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   2452:     for (my $i=0; $i<=18; $i++) {
                   2453:         $selectform.="<option value=\"$i\" ".
1.253     albertel 2454:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      2455:                 ">".&gradeleveldescription($i)."</option>\n";
                   2456:     }
                   2457:     $selectform.="</select>";
                   2458:     return $selectform;
1.163     www      2459: }
1.167     www      2460: 
1.35      matthew  2461: #-------------------------------------------
                   2462: 
1.45      matthew  2463: =pod
                   2464: 
1.1075.2.115  raeburn  2465: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35      matthew  2466: 
                   2467: Returns a string containing a <select name='$name' size='1'> form to 
                   2468: allow a user to select the domain to preform an operation in.  
                   2469: See loncreateuser.pm for an example invocation and use.
                   2470: 
1.90      www      2471: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   2472: selected");
                   2473: 
1.743     raeburn  2474: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   2475: 
1.910     raeburn  2476: 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.
                   2477: 
1.1075.2.36  raeburn  2478: The optional $incdoms is a reference to an array of domains which will be the only available options.
                   2479: 
1.1075.2.115  raeburn  2480: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
                   2481: 
                   2482: The optional $disabled argument, if true, adds the disabled attribute to the select tag. 
1.563     raeburn  2483: 
1.35      matthew  2484: =cut
                   2485: 
                   2486: #-------------------------------------------
1.34      matthew  2487: sub select_dom_form {
1.1075.2.115  raeburn  2488:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872     raeburn  2489:     if ($onchange) {
1.874     raeburn  2490:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  2491:     }
1.1075.2.115  raeburn  2492:     if ($disabled) {
                   2493:         $disabled = ' disabled="disabled"';
                   2494:     }
1.1075.2.36  raeburn  2495:     my (@domains,%exclude);
1.910     raeburn  2496:     if (ref($incdoms) eq 'ARRAY') {
                   2497:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   2498:     } else {
                   2499:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   2500:     }
1.90      www      2501:     if ($includeempty) { @domains=('',@domains); }
1.1075.2.36  raeburn  2502:     if (ref($excdoms) eq 'ARRAY') {
                   2503:         map { $exclude{$_} = 1; } @{$excdoms};
                   2504:     }
1.1075.2.115  raeburn  2505:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356     albertel 2506:     foreach my $dom (@domains) {
1.1075.2.36  raeburn  2507:         next if ($exclude{$dom});
1.356     albertel 2508:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  2509:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   2510:         if ($showdomdesc) {
                   2511:             if ($dom ne '') {
                   2512:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   2513:                 if ($domdesc ne '') {
                   2514:                     $selectdomain .= ' ('.$domdesc.')';
                   2515:                 }
                   2516:             } 
                   2517:         }
                   2518:         $selectdomain .= "</option>\n";
1.34      matthew  2519:     }
                   2520:     $selectdomain.="</select>";
                   2521:     return $selectdomain;
                   2522: }
                   2523: 
1.35      matthew  2524: #-------------------------------------------
                   2525: 
1.45      matthew  2526: =pod
                   2527: 
1.648     raeburn  2528: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2529: 
1.586     raeburn  2530: input: 4 arguments (two required, two optional) - 
                   2531:     $domain - domain of new user
                   2532:     $name - name of form element
                   2533:     $default - Value of 'default' causes a default item to be first 
                   2534:                             option, and selected by default. 
                   2535:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2536:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2537: output: returns 2 items: 
1.586     raeburn  2538: (a) form element which contains either:
                   2539:    (i) <select name="$name">
                   2540:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2541:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2542:        </select>
                   2543:        form item if there are multiple library servers in $domain, or
                   2544:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2545:        if there is only one library server in $domain.
                   2546: 
                   2547: (b) number of library servers found.
                   2548: 
                   2549: See loncreateuser.pm for example of use.
1.35      matthew  2550: 
                   2551: =cut
                   2552: 
                   2553: #-------------------------------------------
1.586     raeburn  2554: sub home_server_form_item {
                   2555:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2556:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2557:     my $result;
                   2558:     my $numlib = keys(%servers);
                   2559:     if ($numlib > 1) {
                   2560:         $result .= '<select name="'.$name.'" />'."\n";
                   2561:         if ($default) {
1.804     bisitz   2562:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2563:                        '</option>'."\n";
                   2564:         }
                   2565:         foreach my $hostid (sort(keys(%servers))) {
                   2566:             $result.= '<option value="'.$hostid.'">'.
                   2567: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2568:         }
                   2569:         $result .= '</select>'."\n";
                   2570:     } elsif ($numlib == 1) {
                   2571:         my $hostid;
                   2572:         foreach my $item (keys(%servers)) {
                   2573:             $hostid = $item;
                   2574:         }
                   2575:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2576:                    $hostid.'" />';
                   2577:                    if (!$hide) {
                   2578:                        $result .= $hostid.' '.$servers{$hostid};
                   2579:                    }
                   2580:                    $result .= "\n";
                   2581:     } elsif ($default) {
                   2582:         $result .= '<input type="hidden" name="'.$name.
                   2583:                    '" value="default" />';
                   2584:                    if (!$hide) {
                   2585:                        $result .= &mt('default');
                   2586:                    }
                   2587:                    $result .= "\n";
1.33      matthew  2588:     }
1.586     raeburn  2589:     return ($result,$numlib);
1.33      matthew  2590: }
1.112     bowersj2 2591: 
                   2592: =pod
                   2593: 
1.534     albertel 2594: =back 
                   2595: 
1.112     bowersj2 2596: =cut
1.87      matthew  2597: 
                   2598: ###############################################################
1.112     bowersj2 2599: ##                  Decoding User Agent                      ##
1.87      matthew  2600: ###############################################################
                   2601: 
                   2602: =pod
                   2603: 
1.112     bowersj2 2604: =head1 Decoding the User Agent
                   2605: 
                   2606: =over 4
                   2607: 
                   2608: =item * &decode_user_agent()
1.87      matthew  2609: 
                   2610: Inputs: $r
                   2611: 
                   2612: Outputs:
                   2613: 
                   2614: =over 4
                   2615: 
1.112     bowersj2 2616: =item * $httpbrowser
1.87      matthew  2617: 
1.112     bowersj2 2618: =item * $clientbrowser
1.87      matthew  2619: 
1.112     bowersj2 2620: =item * $clientversion
1.87      matthew  2621: 
1.112     bowersj2 2622: =item * $clientmathml
1.87      matthew  2623: 
1.112     bowersj2 2624: =item * $clientunicode
1.87      matthew  2625: 
1.112     bowersj2 2626: =item * $clientos
1.87      matthew  2627: 
1.1075.2.42  raeburn  2628: =item * $clientmobile
                   2629: 
                   2630: =item * $clientinfo
                   2631: 
1.1075.2.77  raeburn  2632: =item * $clientosversion
                   2633: 
1.87      matthew  2634: =back
                   2635: 
1.157     matthew  2636: =back 
                   2637: 
1.87      matthew  2638: =cut
                   2639: 
                   2640: ###############################################################
                   2641: ###############################################################
                   2642: sub decode_user_agent {
1.247     albertel 2643:     my ($r)=@_;
1.87      matthew  2644:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2645:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2646:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2647:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2648:     my $clientbrowser='unknown';
                   2649:     my $clientversion='0';
                   2650:     my $clientmathml='';
                   2651:     my $clientunicode='0';
1.1075.2.42  raeburn  2652:     my $clientmobile=0;
1.1075.2.77  raeburn  2653:     my $clientosversion='';
1.87      matthew  2654:     for (my $i=0;$i<=$#browsertype;$i++) {
1.1075.2.76  raeburn  2655:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87      matthew  2656: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2657: 	    $clientbrowser=$bname;
                   2658:             $httpbrowser=~/$vreg/i;
                   2659: 	    $clientversion=$1;
                   2660:             $clientmathml=($clientversion>=$minv);
                   2661:             $clientunicode=($clientversion>=$univ);
                   2662: 	}
                   2663:     }
                   2664:     my $clientos='unknown';
1.1075.2.42  raeburn  2665:     my $clientinfo;
1.87      matthew  2666:     if (($httpbrowser=~/linux/i) ||
                   2667:         ($httpbrowser=~/unix/i) ||
                   2668:         ($httpbrowser=~/ux/i) ||
                   2669:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2670:     if (($httpbrowser=~/vax/i) ||
                   2671:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2672:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2673:     if (($httpbrowser=~/mac/i) ||
                   2674:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1075.2.77  raeburn  2675:     if ($httpbrowser=~/win/i) {
                   2676:         $clientos='win';
                   2677:         if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
                   2678:             $clientosversion = $1;
                   2679:         }
                   2680:     }
1.87      matthew  2681:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1075.2.42  raeburn  2682:     if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
                   2683:         $clientmobile=lc($1);
                   2684:     }
                   2685:     if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
                   2686:         $clientinfo = 'firefox-'.$1;
                   2687:     } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
                   2688:         $clientinfo = 'chromeframe-'.$1;
                   2689:     }
1.87      matthew  2690:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1075.2.77  raeburn  2691:             $clientunicode,$clientos,$clientmobile,$clientinfo,
                   2692:             $clientosversion);
1.87      matthew  2693: }
                   2694: 
1.32      matthew  2695: ###############################################################
                   2696: ##    Authentication changing form generation subroutines    ##
                   2697: ###############################################################
                   2698: ##
                   2699: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2700: ## hash, and have reasonable default values.
                   2701: ##
                   2702: ##    formname = the name given in the <form> tag.
1.35      matthew  2703: #-------------------------------------------
                   2704: 
1.45      matthew  2705: =pod
                   2706: 
1.112     bowersj2 2707: =head1 Authentication Routines
                   2708: 
                   2709: =over 4
                   2710: 
1.648     raeburn  2711: =item * &authform_xxxxxx()
1.35      matthew  2712: 
                   2713: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2714: handle some of the conveniences required for authentication forms.  
                   2715: This is not an optimal method, but it works.  
                   2716: 
                   2717: =over 4
                   2718: 
1.112     bowersj2 2719: =item * authform_header
1.35      matthew  2720: 
1.112     bowersj2 2721: =item * authform_authorwarning
1.35      matthew  2722: 
1.112     bowersj2 2723: =item * authform_nochange
1.35      matthew  2724: 
1.112     bowersj2 2725: =item * authform_kerberos
1.35      matthew  2726: 
1.112     bowersj2 2727: =item * authform_internal
1.35      matthew  2728: 
1.112     bowersj2 2729: =item * authform_filesystem
1.35      matthew  2730: 
                   2731: =back
                   2732: 
1.648     raeburn  2733: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2734: 
1.35      matthew  2735: =cut
                   2736: 
                   2737: #-------------------------------------------
1.32      matthew  2738: sub authform_header{  
                   2739:     my %in = (
                   2740:         formname => 'cu',
1.80      albertel 2741:         kerb_def_dom => '',
1.32      matthew  2742:         @_,
                   2743:     );
                   2744:     $in{'formname'} = 'document.' . $in{'formname'};
                   2745:     my $result='';
1.80      albertel 2746: 
                   2747: #---------------------------------------------- Code for upper case translation
                   2748:     my $Javascript_toUpperCase;
                   2749:     unless ($in{kerb_def_dom}) {
                   2750:         $Javascript_toUpperCase =<<"END";
                   2751:         switch (choice) {
                   2752:            case 'krb': currentform.elements[choicearg].value =
                   2753:                currentform.elements[choicearg].value.toUpperCase();
                   2754:                break;
                   2755:            default:
                   2756:         }
                   2757: END
                   2758:     } else {
                   2759:         $Javascript_toUpperCase = "";
                   2760:     }
                   2761: 
1.165     raeburn  2762:     my $radioval = "'nochange'";
1.591     raeburn  2763:     if (defined($in{'curr_authtype'})) {
                   2764:         if ($in{'curr_authtype'} ne '') {
                   2765:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2766:         }
1.174     matthew  2767:     }
1.165     raeburn  2768:     my $argfield = 'null';
1.591     raeburn  2769:     if (defined($in{'mode'})) {
1.165     raeburn  2770:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2771:             if (defined($in{'curr_autharg'})) {
                   2772:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2773:                     $argfield = "'$in{'curr_autharg'}'";
                   2774:                 }
                   2775:             }
                   2776:         }
                   2777:     }
                   2778: 
1.32      matthew  2779:     $result.=<<"END";
                   2780: var current = new Object();
1.165     raeburn  2781: current.radiovalue = $radioval;
                   2782: current.argfield = $argfield;
1.32      matthew  2783: 
                   2784: function changed_radio(choice,currentform) {
                   2785:     var choicearg = choice + 'arg';
                   2786:     // If a radio button in changed, we need to change the argfield
                   2787:     if (current.radiovalue != choice) {
                   2788:         current.radiovalue = choice;
                   2789:         if (current.argfield != null) {
                   2790:             currentform.elements[current.argfield].value = '';
                   2791:         }
                   2792:         if (choice == 'nochange') {
                   2793:             current.argfield = null;
                   2794:         } else {
                   2795:             current.argfield = choicearg;
                   2796:             switch(choice) {
                   2797:                 case 'krb': 
                   2798:                     currentform.elements[current.argfield].value = 
                   2799:                         "$in{'kerb_def_dom'}";
                   2800:                 break;
                   2801:               default:
                   2802:                 break;
                   2803:             }
                   2804:         }
                   2805:     }
                   2806:     return;
                   2807: }
1.22      www      2808: 
1.32      matthew  2809: function changed_text(choice,currentform) {
                   2810:     var choicearg = choice + 'arg';
                   2811:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2812:         $Javascript_toUpperCase
1.32      matthew  2813:         // clear old field
                   2814:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2815:             currentform.elements[current.argfield].value = '';
                   2816:         }
                   2817:         current.argfield = choicearg;
                   2818:     }
                   2819:     set_auth_radio_buttons(choice,currentform);
                   2820:     return;
1.20      www      2821: }
1.32      matthew  2822: 
                   2823: function set_auth_radio_buttons(newvalue,currentform) {
1.986     raeburn  2824:     var numauthchoices = currentform.login.length;
                   2825:     if (typeof numauthchoices  == "undefined") {
                   2826:         return;
                   2827:     } 
1.32      matthew  2828:     var i=0;
1.986     raeburn  2829:     while (i < numauthchoices) {
1.32      matthew  2830:         if (currentform.login[i].value == newvalue) { break; }
                   2831:         i++;
                   2832:     }
1.986     raeburn  2833:     if (i == numauthchoices) {
1.32      matthew  2834:         return;
                   2835:     }
                   2836:     current.radiovalue = newvalue;
                   2837:     currentform.login[i].checked = true;
                   2838:     return;
                   2839: }
                   2840: END
                   2841:     return $result;
                   2842: }
                   2843: 
1.1075.2.20  raeburn  2844: sub authform_authorwarning {
1.32      matthew  2845:     my $result='';
1.144     matthew  2846:     $result='<i>'.
                   2847:         &mt('As a general rule, only authors or co-authors should be '.
                   2848:             'filesystem authenticated '.
                   2849:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2850:     return $result;
                   2851: }
                   2852: 
1.1075.2.20  raeburn  2853: sub authform_nochange {
1.32      matthew  2854:     my %in = (
                   2855:               formname => 'document.cu',
                   2856:               kerb_def_dom => 'MSU.EDU',
                   2857:               @_,
                   2858:           );
1.1075.2.20  raeburn  2859:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'}); 
1.586     raeburn  2860:     my $result;
1.1075.2.20  raeburn  2861:     if (!$authnum) {
                   2862:         $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586     raeburn  2863:     } else {
                   2864:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2865:                   '<input type="radio" name="login" value="nochange" '.
                   2866:                   'checked="checked" onclick="'.
1.281     albertel 2867:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2868: 	    '</label>';
1.586     raeburn  2869:     }
1.32      matthew  2870:     return $result;
                   2871: }
                   2872: 
1.591     raeburn  2873: sub authform_kerberos {
1.32      matthew  2874:     my %in = (
                   2875:               formname => 'document.cu',
                   2876:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2877:               kerb_def_auth => 'krb4',
1.32      matthew  2878:               @_,
                   2879:               );
1.586     raeburn  2880:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1075.2.117  raeburn  2881:         $autharg,$jscall,$disabled);
1.1075.2.20  raeburn  2882:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80      albertel 2883:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2884:        $check5 = ' checked="checked"';
1.80      albertel 2885:     } else {
1.772     bisitz   2886:        $check4 = ' checked="checked"';
1.80      albertel 2887:     }
1.1075.2.117  raeburn  2888:     if ($in{'readonly'}) {
                   2889:         $disabled = ' disabled="disabled"';
                   2890:     }
1.165     raeburn  2891:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2892:     if (defined($in{'curr_authtype'})) {
                   2893:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2894:             $krbcheck = ' checked="checked"';
1.623     raeburn  2895:             if (defined($in{'mode'})) {
                   2896:                 if ($in{'mode'} eq 'modifyuser') {
                   2897:                     $krbcheck = '';
                   2898:                 }
                   2899:             }
1.591     raeburn  2900:             if (defined($in{'curr_kerb_ver'})) {
                   2901:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2902:                     $check5 = ' checked="checked"';
1.591     raeburn  2903:                     $check4 = '';
                   2904:                 } else {
1.772     bisitz   2905:                     $check4 = ' checked="checked"';
1.591     raeburn  2906:                     $check5 = '';
                   2907:                 }
1.586     raeburn  2908:             }
1.591     raeburn  2909:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2910:                 $krbarg = $in{'curr_autharg'};
                   2911:             }
1.586     raeburn  2912:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2913:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2914:                     $result = 
                   2915:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2916:         $in{'curr_autharg'},$krbver);
                   2917:                 } else {
                   2918:                     $result =
                   2919:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2920:                 }
                   2921:                 return $result; 
                   2922:             }
                   2923:         }
                   2924:     } else {
                   2925:         if ($authnum == 1) {
1.784     bisitz   2926:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2927:         }
                   2928:     }
1.586     raeburn  2929:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2930:         return;
1.587     raeburn  2931:     } elsif ($authtype eq '') {
1.591     raeburn  2932:         if (defined($in{'mode'})) {
1.587     raeburn  2933:             if ($in{'mode'} eq 'modifycourse') {
                   2934:                 if ($authnum == 1) {
1.1075.2.117  raeburn  2935:                     $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587     raeburn  2936:                 }
                   2937:             }
                   2938:         }
1.586     raeburn  2939:     }
                   2940:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2941:     if ($authtype eq '') {
                   2942:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2943:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1075.2.117  raeburn  2944:                     $krbcheck.$disabled.' />';
1.586     raeburn  2945:     }
                   2946:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1075.2.20  raeburn  2947:         ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586     raeburn  2948:          $in{'curr_authtype'} eq 'krb5') ||
1.1075.2.20  raeburn  2949:         (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586     raeburn  2950:          $in{'curr_authtype'} eq 'krb4')) {
                   2951:         $result .= &mt
1.144     matthew  2952:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2953:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2954:          '<label>'.$authtype,
1.281     albertel 2955:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2956:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2957:              'onchange="'.$jscall.'"'.$disabled.' />',
                   2958:          '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
                   2959:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281     albertel 2960: 	 '</label>');
1.586     raeburn  2961:     } elsif ($can_assign{'krb4'}) {
                   2962:         $result .= &mt
                   2963:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2964:          '[_3] Version 4 [_4]',
                   2965:          '<label>'.$authtype,
                   2966:          '</label><input type="text" size="10" name="krbarg" '.
                   2967:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2968:              'onchange="'.$jscall.'"'.$disabled.' />',
1.586     raeburn  2969:          '<label><input type="hidden" name="krbver" value="4" />',
                   2970:          '</label>');
                   2971:     } elsif ($can_assign{'krb5'}) {
                   2972:         $result .= &mt
                   2973:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2974:          '[_3] Version 5 [_4]',
                   2975:          '<label>'.$authtype,
                   2976:          '</label><input type="text" size="10" name="krbarg" '.
                   2977:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2978:              'onchange="'.$jscall.'"'.$disabled.' />',
1.586     raeburn  2979:          '<label><input type="hidden" name="krbver" value="5" />',
                   2980:          '</label>');
                   2981:     }
1.32      matthew  2982:     return $result;
                   2983: }
                   2984: 
1.1075.2.20  raeburn  2985: sub authform_internal {
1.586     raeburn  2986:     my %in = (
1.32      matthew  2987:                 formname => 'document.cu',
                   2988:                 kerb_def_dom => 'MSU.EDU',
                   2989:                 @_,
                   2990:                 );
1.1075.2.117  raeburn  2991:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  2992:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  2993:     if ($in{'readonly'}) {
                   2994:         $disabled = ' disabled="disabled"';
                   2995:     }
1.591     raeburn  2996:     if (defined($in{'curr_authtype'})) {
                   2997:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2998:             if ($can_assign{'int'}) {
1.772     bisitz   2999:                 $intcheck = 'checked="checked" ';
1.623     raeburn  3000:                 if (defined($in{'mode'})) {
                   3001:                     if ($in{'mode'} eq 'modifyuser') {
                   3002:                         $intcheck = '';
                   3003:                     }
                   3004:                 }
1.591     raeburn  3005:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  3006:                     $intarg = $in{'curr_autharg'};
                   3007:                 }
                   3008:             } else {
                   3009:                 $result = &mt('Currently internally authenticated.');
                   3010:                 return $result;
1.165     raeburn  3011:             }
                   3012:         }
1.586     raeburn  3013:     } else {
                   3014:         if ($authnum == 1) {
1.784     bisitz   3015:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  3016:         }
                   3017:     }
                   3018:     if (!$can_assign{'int'}) {
                   3019:         return;
1.587     raeburn  3020:     } elsif ($authtype eq '') {
1.591     raeburn  3021:         if (defined($in{'mode'})) {
1.587     raeburn  3022:             if ($in{'mode'} eq 'modifycourse') {
                   3023:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3024:                     $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587     raeburn  3025:                 }
                   3026:             }
                   3027:         }
1.165     raeburn  3028:     }
1.586     raeburn  3029:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   3030:     if ($authtype eq '') {
                   3031:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1075.2.117  raeburn  3032:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3033:     }
1.605     bisitz   3034:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1075.2.117  raeburn  3035:                $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3036:     $result = &mt
1.144     matthew  3037:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  3038:          '<label>'.$authtype,'</label>'.$autharg);
1.1075.2.118  raeburn  3039:     $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  3040:     return $result;
                   3041: }
                   3042: 
1.1075.2.20  raeburn  3043: sub authform_local {
1.32      matthew  3044:     my %in = (
                   3045:               formname => 'document.cu',
                   3046:               kerb_def_dom => 'MSU.EDU',
                   3047:               @_,
                   3048:               );
1.1075.2.117  raeburn  3049:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  3050:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  3051:     if ($in{'readonly'}) {
                   3052:         $disabled = ' disabled="disabled"';
                   3053:     }
1.591     raeburn  3054:     if (defined($in{'curr_authtype'})) {
                   3055:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  3056:             if ($can_assign{'loc'}) {
1.772     bisitz   3057:                 $loccheck = 'checked="checked" ';
1.623     raeburn  3058:                 if (defined($in{'mode'})) {
                   3059:                     if ($in{'mode'} eq 'modifyuser') {
                   3060:                         $loccheck = '';
                   3061:                     }
                   3062:                 }
1.591     raeburn  3063:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  3064:                     $locarg = $in{'curr_autharg'};
                   3065:                 }
                   3066:             } else {
                   3067:                 $result = &mt('Currently using local (institutional) authentication.');
                   3068:                 return $result;
1.165     raeburn  3069:             }
                   3070:         }
1.586     raeburn  3071:     } else {
                   3072:         if ($authnum == 1) {
1.784     bisitz   3073:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  3074:         }
                   3075:     }
                   3076:     if (!$can_assign{'loc'}) {
                   3077:         return;
1.587     raeburn  3078:     } elsif ($authtype eq '') {
1.591     raeburn  3079:         if (defined($in{'mode'})) {
1.587     raeburn  3080:             if ($in{'mode'} eq 'modifycourse') {
                   3081:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3082:                     $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587     raeburn  3083:                 }
                   3084:             }
                   3085:         }
1.165     raeburn  3086:     }
1.586     raeburn  3087:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   3088:     if ($authtype eq '') {
                   3089:         $authtype = '<input type="radio" name="login" value="loc" '.
                   3090:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1075.2.117  raeburn  3091:                     $jscall.'"'.$disabled.' />';
1.586     raeburn  3092:     }
                   3093:     $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1075.2.117  raeburn  3094:                $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3095:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   3096:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  3097:     return $result;
                   3098: }
                   3099: 
1.1075.2.20  raeburn  3100: sub authform_filesystem {
1.32      matthew  3101:     my %in = (
                   3102:               formname => 'document.cu',
                   3103:               kerb_def_dom => 'MSU.EDU',
                   3104:               @_,
                   3105:               );
1.1075.2.117  raeburn  3106:     my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  3107:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  3108:     if ($in{'readonly'}) {
                   3109:         $disabled = ' disabled="disabled"';
                   3110:     }
1.591     raeburn  3111:     if (defined($in{'curr_authtype'})) {
                   3112:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  3113:             if ($can_assign{'fsys'}) {
1.772     bisitz   3114:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  3115:                 if (defined($in{'mode'})) {
                   3116:                     if ($in{'mode'} eq 'modifyuser') {
                   3117:                         $fsyscheck = '';
                   3118:                     }
                   3119:                 }
1.586     raeburn  3120:             } else {
                   3121:                 $result = &mt('Currently Filesystem Authenticated.');
                   3122:                 return $result;
                   3123:             }           
                   3124:         }
                   3125:     } else {
                   3126:         if ($authnum == 1) {
1.784     bisitz   3127:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  3128:         }
                   3129:     }
                   3130:     if (!$can_assign{'fsys'}) {
                   3131:         return;
1.587     raeburn  3132:     } elsif ($authtype eq '') {
1.591     raeburn  3133:         if (defined($in{'mode'})) {
1.587     raeburn  3134:             if ($in{'mode'} eq 'modifycourse') {
                   3135:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3136:                     $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587     raeburn  3137:                 }
                   3138:             }
                   3139:         }
1.586     raeburn  3140:     }
                   3141:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   3142:     if ($authtype eq '') {
                   3143:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   3144:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1075.2.117  raeburn  3145:                     $jscall.'"'.$disabled.' />';
1.586     raeburn  3146:     }
1.1075.2.158  raeburn  3147:     $autharg = '<input type="password" size="10" name="fsysarg" value=""'.
1.1075.2.117  raeburn  3148:                ' onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3149:     $result = &mt
1.144     matthew  3150:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.1075.2.158  raeburn  3151:          '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  3152:     return $result;
                   3153: }
                   3154: 
1.586     raeburn  3155: sub get_assignable_auth {
                   3156:     my ($dom) = @_;
                   3157:     if ($dom eq '') {
                   3158:         $dom = $env{'request.role.domain'};
                   3159:     }
                   3160:     my %can_assign = (
                   3161:                           krb4 => 1,
                   3162:                           krb5 => 1,
                   3163:                           int  => 1,
                   3164:                           loc  => 1,
                   3165:                      );
                   3166:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   3167:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   3168:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   3169:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   3170:             my $context;
                   3171:             if ($env{'request.role'} =~ /^au/) {
                   3172:                 $context = 'author';
1.1075.2.117  raeburn  3173:             } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586     raeburn  3174:                 $context = 'domain';
                   3175:             } elsif ($env{'request.course.id'}) {
                   3176:                 $context = 'course';
                   3177:             }
                   3178:             if ($context) {
                   3179:                 if (ref($authhash->{$context}) eq 'HASH') {
                   3180:                    %can_assign = %{$authhash->{$context}}; 
                   3181:                 }
                   3182:             }
                   3183:         }
                   3184:     }
                   3185:     my $authnum = 0;
                   3186:     foreach my $key (keys(%can_assign)) {
                   3187:         if ($can_assign{$key}) {
                   3188:             $authnum ++;
                   3189:         }
                   3190:     }
                   3191:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   3192:         $authnum --;
                   3193:     }
                   3194:     return ($authnum,%can_assign);
                   3195: }
                   3196: 
1.1075.2.137  raeburn  3197: sub check_passwd_rules {
                   3198:     my ($domain,$plainpass) = @_;
                   3199:     my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
                   3200:     my ($min,$max,@chars,@brokerule,$warning);
1.1075.2.138  raeburn  3201:     $min = $Apache::lonnet::passwdmin;
1.1075.2.137  raeburn  3202:     if (ref($passwdconf{'chars'}) eq 'ARRAY') {
                   3203:         if ($passwdconf{'min'} =~ /^\d+$/) {
1.1075.2.138  raeburn  3204:             if ($passwdconf{'min'} > $min) {
                   3205:                 $min = $passwdconf{'min'};
                   3206:             }
1.1075.2.137  raeburn  3207:         }
                   3208:         if ($passwdconf{'max'} =~ /^\d+$/) {
                   3209:             $max = $passwdconf{'max'};
                   3210:         }
                   3211:         @chars = @{$passwdconf{'chars'}};
                   3212:     }
                   3213:     if (($min) && (length($plainpass) < $min)) {
                   3214:         push(@brokerule,'min');
                   3215:     }
                   3216:     if (($max) && (length($plainpass) > $max)) {
                   3217:         push(@brokerule,'max');
                   3218:     }
                   3219:     if (@chars) {
                   3220:         my %rules;
                   3221:         map { $rules{$_} = 1; } @chars;
                   3222:         if ($rules{'uc'}) {
                   3223:             unless ($plainpass =~ /[A-Z]/) {
                   3224:                 push(@brokerule,'uc');
                   3225:             }
                   3226:         }
                   3227:         if ($rules{'lc'}) {
                   3228:             unless ($plainpass =~ /[a-z]/) {
                   3229:                 push(@brokerule,'lc');
                   3230:             }
                   3231:         }
                   3232:         if ($rules{'num'}) {
                   3233:             unless ($plainpass =~ /\d/) {
                   3234:                 push(@brokerule,'num');
                   3235:             }
                   3236:         }
                   3237:         if ($rules{'spec'}) {
                   3238:             unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
                   3239:                 push(@brokerule,'spec');
                   3240:             }
                   3241:         }
                   3242:     }
                   3243:     if (@brokerule) {
                   3244:         my %rulenames = &Apache::lonlocal::texthash(
                   3245:             uc   => 'At least one upper case letter',
                   3246:             lc   => 'At least one lower case letter',
                   3247:             num  => 'At least one number',
                   3248:             spec => 'At least one non-alphanumeric',
                   3249:         );
                   3250:         $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
                   3251:         $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
                   3252:         $rulenames{'num'} .= ': 0123456789';
                   3253:         $rulenames{'spec'} .= ': !&quot;\#$%&amp;\'()*+,-./:;&lt;=&gt;?@[\]^_\`{|}~';
                   3254:         $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
                   3255:         $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
                   3256:         $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1075.2.143  raeburn  3257:         foreach my $rule ('min','max','uc','lc','num','spec') {
1.1075.2.137  raeburn  3258:             if (grep(/^$rule$/,@brokerule)) {
                   3259:                 $warning .= '<li>'.$rulenames{$rule}.'</li>';
                   3260:             }
                   3261:         }
                   3262:         $warning .= '</ul>';
                   3263:     }
                   3264:     if (wantarray) {
                   3265:         return @brokerule;
                   3266:     }
                   3267:     return $warning;
                   3268: }
                   3269: 
1.1075.2.161.  .5(raebu 3270:22): sub passwd_validation_js {
                   3271:22):     my ($currpasswdval,$domain,$context,$id) = @_;
                   3272:22):     my (%passwdconf,$alertmsg);
                   3273:22):     if ($context eq 'linkprot') {
                   3274:22):         my %domconfig = &Apache::lonnet::get_dom('configuration',['ltisec'],$domain);
                   3275:22):         if (ref($domconfig{'ltisec'}) eq 'HASH') {
                   3276:22):             if (ref($domconfig{'ltisec'}{'rules'}) eq 'HASH') {
                   3277:22):                 %passwdconf = %{$domconfig{'ltisec'}{'rules'}};
                   3278:22):             }
                   3279:22):         }
                   3280:22):         if ($id eq 'add') {
                   3281:22):             $alertmsg = &mt('Secret for added launcher did not satisfy requirement(s):').'\n\n';
                   3282:22):         } elsif ($id =~ /^\d+$/) {
                   3283:22):             my $pos = $id+1;
                   3284:22):             $alertmsg = &mt('Secret for launcher [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
                   3285:22):         } else {
                   3286:22):             $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
                   3287:22):         }
                   3288:22):     } else {
                   3289:22):         %passwdconf = &Apache::lonnet::get_passwdconf($domain);
                   3290:22):         $alertmsg = &mt('Initial password did not satisfy requirement(s):').'\n\n';
                   3291:22):     }
                   3292:22):     my ($min,$max,@chars,$numrules,$intargjs,%alert);
                   3293:22):     $numrules = 0;
                   3294:22):     $min = $Apache::lonnet::passwdmin;
                   3295:22):     if (ref($passwdconf{'chars'}) eq 'ARRAY') {
                   3296:22):         if ($passwdconf{'min'} =~ /^\d+$/) {
                   3297:22):             if ($passwdconf{'min'} > $min) {
                   3298:22):                 $min = $passwdconf{'min'};
                   3299:22):             }
                   3300:22):         }
                   3301:22):         if ($passwdconf{'max'} =~ /^\d+$/) {
                   3302:22):             $max = $passwdconf{'max'};
                   3303:22):             $numrules ++;
                   3304:22):         }
                   3305:22):         @chars = @{$passwdconf{'chars'}};
                   3306:22):         if (@chars) {
                   3307:22):             $numrules ++;
                   3308:22):         }
                   3309:22):     }
                   3310:22):     if ($min > 0) {
                   3311:22):         $numrules ++;
                   3312:22):     }
                   3313:22):     if (($min > 0) || ($max ne '') || (@chars > 0)) {
                   3314:22):         if ($min) {
                   3315:22):             $alert{'min'} = &mt('minimum [quant,_1,character]',$min).'\n';
                   3316:22):         }
                   3317:22):         if ($max) {
                   3318:22):             $alert{'max'} = &mt('maximum [quant,_1,character]',$max).'\n';
                   3319:22):         }
                   3320:22):         my (@charalerts,@charrules);
                   3321:22):         if (@chars) {
                   3322:22):             if (grep(/^uc$/,@chars)) {
                   3323:22):                 push(@charalerts,&mt('contain at least one upper case letter'));
                   3324:22):                 push(@charrules,'uc');
                   3325:22):             }
                   3326:22):             if (grep(/^lc$/,@chars)) {
                   3327:22):                 push(@charalerts,&mt('contain at least one lower case letter'));
                   3328:22):                 push(@charrules,'lc');
                   3329:22):             }
                   3330:22):             if (grep(/^num$/,@chars)) {
                   3331:22):                 push(@charalerts,&mt('contain at least one number'));
                   3332:22):                 push(@charrules,'num');
                   3333:22):             }
                   3334:22):             if (grep(/^spec$/,@chars)) {
                   3335:22):                 push(@charalerts,&mt('contain at least one non-alphanumeric'));
                   3336:22):                 push(@charrules,'spec');
                   3337:22):             }
                   3338:22):         }
                   3339:22):         $intargjs = qq|            var rulesmsg = '';\n|.
                   3340:22):                     qq|            var currpwval = $currpasswdval;\n|;
                   3341:22):             if ($min) {
                   3342:22):                 $intargjs .= qq|
                   3343:22):             if (currpwval.length < $min) {
                   3344:22):                 rulesmsg += ' - $alert{min}';
                   3345:22):             }
                   3346:22): |;
                   3347:22):             }
                   3348:22):             if ($max) {
                   3349:22):                 $intargjs .= qq|
                   3350:22):             if (currpwval.length > $max) {
                   3351:22):                 rulesmsg += ' - $alert{max}';
                   3352:22):             }
                   3353:22): |;
                   3354:22):             }
                   3355:22):             if (@chars > 0) {
                   3356:22):                 my $charrulestr = '"'.join('","',@charrules).'"';
                   3357:22):                 my $charalertstr = '"'.join('","',@charalerts).'"';
                   3358:22):                 $intargjs .= qq|            var brokerules = new Array();\n|.
                   3359:22):                              qq|            var charrules = new Array($charrulestr);\n|.
                   3360:22):                              qq|            var charalerts = new Array($charalertstr);\n|;
                   3361:22):                 my %rules;
                   3362:22):                 map { $rules{$_} = 1; } @chars;
                   3363:22):                 if ($rules{'uc'}) {
                   3364:22):                     $intargjs .= qq|
                   3365:22):             var ucRegExp = /[A-Z]/;
                   3366:22):             if (!ucRegExp.test(currpwval)) {
                   3367:22):                 brokerules.push('uc');
                   3368:22):             }
                   3369:22): |;
                   3370:22):                 }
                   3371:22):                 if ($rules{'lc'}) {
                   3372:22):                     $intargjs .= qq|
                   3373:22):             var lcRegExp = /[a-z]/;
                   3374:22):             if (!lcRegExp.test(currpwval)) {
                   3375:22):                 brokerules.push('lc');
                   3376:22):             }
                   3377:22): |;
                   3378:22):                 }
                   3379:22):                 if ($rules{'num'}) {
                   3380:22):                      $intargjs .= qq|
                   3381:22):             var numRegExp = /[0-9]/;
                   3382:22):             if (!numRegExp.test(currpwval)) {
                   3383:22):                 brokerules.push('num');
                   3384:22):             }
                   3385:22): |;
                   3386:22):                 }
                   3387:22):                 if ($rules{'spec'}) {
                   3388:22):                      $intargjs .= q|
                   3389:22):             var specRegExp = /[!"#$%&'()*+,\-.\/:;<=>?@[\\^\]_`{\|}~]/;
                   3390:22):             if (!specRegExp.test(currpwval)) {
                   3391:22):                 brokerules.push('spec');
                   3392:22):             }
                   3393:22): |;
                   3394:22):                 }
                   3395:22):                 $intargjs .= qq|
                   3396:22):             if (brokerules.length > 0) {
                   3397:22):                 for (var i=0; i<brokerules.length; i++) {
                   3398:22):                     for (var j=0; j<charrules.length; j++) {
                   3399:22):                         if (brokerules[i] == charrules[j]) {
                   3400:22):                             rulesmsg += ' - '+charalerts[j]+'\\n';
                   3401:22):                             break;
                   3402:22):                         }
                   3403:22):                     }
                   3404:22):                 }
                   3405:22):             }
                   3406:22): |;
                   3407:22):             }
                   3408:22):             $intargjs .= qq|
                   3409:22):             if (rulesmsg != '') {
                   3410:22):                 rulesmsg = '$alertmsg'+rulesmsg;
                   3411:22):                 alert(rulesmsg);
                   3412:22):                 return false;
                   3413:22):             }
                   3414:22): |;
                   3415:22):     }
                   3416:22):     return ($numrules,$intargjs);
                   3417:22): }
                   3418:22): 
1.80      albertel 3419: ###############################################################
                   3420: ##    Get Kerberos Defaults for Domain                 ##
                   3421: ###############################################################
                   3422: ##
                   3423: ## Returns default kerberos version and an associated argument
                   3424: ## as listed in file domain.tab. If not listed, provides
                   3425: ## appropriate default domain and kerberos version.
                   3426: ##
                   3427: #-------------------------------------------
                   3428: 
                   3429: =pod
                   3430: 
1.648     raeburn  3431: =item * &get_kerberos_defaults()
1.80      albertel 3432: 
                   3433: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  3434: version and domain. If not found, it defaults to version 4 and the 
                   3435: domain of the server.
1.80      albertel 3436: 
1.648     raeburn  3437: =over 4
                   3438: 
1.80      albertel 3439: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   3440: 
1.648     raeburn  3441: =back
                   3442: 
                   3443: =back
                   3444: 
1.80      albertel 3445: =cut
                   3446: 
                   3447: #-------------------------------------------
                   3448: sub get_kerberos_defaults {
                   3449:     my $domain=shift;
1.641     raeburn  3450:     my ($krbdef,$krbdefdom);
                   3451:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   3452:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   3453:         $krbdef = $domdefaults{'auth_def'};
                   3454:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   3455:     } else {
1.80      albertel 3456:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   3457:         my $krbdefdom=$1;
                   3458:         $krbdefdom=~tr/a-z/A-Z/;
                   3459:         $krbdef = "krb4";
                   3460:     }
                   3461:     return ($krbdef,$krbdefdom);
                   3462: }
1.112     bowersj2 3463: 
1.32      matthew  3464: 
1.46      matthew  3465: ###############################################################
                   3466: ##                Thesaurus Functions                        ##
                   3467: ###############################################################
1.20      www      3468: 
1.46      matthew  3469: =pod
1.20      www      3470: 
1.112     bowersj2 3471: =head1 Thesaurus Functions
                   3472: 
                   3473: =over 4
                   3474: 
1.648     raeburn  3475: =item * &initialize_keywords()
1.46      matthew  3476: 
                   3477: Initializes the package variable %Keywords if it is empty.  Uses the
                   3478: package variable $thesaurus_db_file.
                   3479: 
                   3480: =cut
                   3481: 
                   3482: ###################################################
                   3483: 
                   3484: sub initialize_keywords {
                   3485:     return 1 if (scalar keys(%Keywords));
                   3486:     # If we are here, %Keywords is empty, so fill it up
                   3487:     #   Make sure the file we need exists...
                   3488:     if (! -e $thesaurus_db_file) {
                   3489:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   3490:                                  " failed because it does not exist");
                   3491:         return 0;
                   3492:     }
                   3493:     #   Set up the hash as a database
                   3494:     my %thesaurus_db;
                   3495:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3496:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3497:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   3498:                                  $thesaurus_db_file);
                   3499:         return 0;
                   3500:     } 
                   3501:     #  Get the average number of appearances of a word.
                   3502:     my $avecount = $thesaurus_db{'average.count'};
                   3503:     #  Put keywords (those that appear > average) into %Keywords
                   3504:     while (my ($word,$data)=each (%thesaurus_db)) {
                   3505:         my ($count,undef) = split /:/,$data;
                   3506:         $Keywords{$word}++ if ($count > $avecount);
                   3507:     }
                   3508:     untie %thesaurus_db;
                   3509:     # Remove special values from %Keywords.
1.356     albertel 3510:     foreach my $value ('total.count','average.count') {
                   3511:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  3512:   }
1.46      matthew  3513:     return 1;
                   3514: }
                   3515: 
                   3516: ###################################################
                   3517: 
                   3518: =pod
                   3519: 
1.648     raeburn  3520: =item * &keyword($word)
1.46      matthew  3521: 
                   3522: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   3523: than the average number of times in the thesaurus database.  Calls 
                   3524: &initialize_keywords
                   3525: 
                   3526: =cut
                   3527: 
                   3528: ###################################################
1.20      www      3529: 
                   3530: sub keyword {
1.46      matthew  3531:     return if (!&initialize_keywords());
                   3532:     my $word=lc(shift());
                   3533:     $word=~s/\W//g;
                   3534:     return exists($Keywords{$word});
1.20      www      3535: }
1.46      matthew  3536: 
                   3537: ###############################################################
                   3538: 
                   3539: =pod 
1.20      www      3540: 
1.648     raeburn  3541: =item * &get_related_words()
1.46      matthew  3542: 
1.160     matthew  3543: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  3544: an array of words.  If the keyword is not in the thesaurus, an empty array
                   3545: will be returned.  The order of the words returned is determined by the
                   3546: database which holds them.
                   3547: 
                   3548: Uses global $thesaurus_db_file.
                   3549: 
1.1057    foxr     3550: 
1.46      matthew  3551: =cut
                   3552: 
                   3553: ###############################################################
                   3554: sub get_related_words {
                   3555:     my $keyword = shift;
                   3556:     my %thesaurus_db;
                   3557:     if (! -e $thesaurus_db_file) {
                   3558:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   3559:                                  "failed because the file does not exist");
                   3560:         return ();
                   3561:     }
                   3562:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3563:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3564:         return ();
                   3565:     } 
                   3566:     my @Words=();
1.429     www      3567:     my $count=0;
1.46      matthew  3568:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 3569: 	# The first element is the number of times
                   3570: 	# the word appears.  We do not need it now.
1.429     www      3571: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   3572: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   3573: 	my $threshold=$mostfrequentcount/10;
                   3574:         foreach my $possibleword (@RelatedWords) {
                   3575:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   3576:             if ($wordcount>$threshold) {
                   3577: 		push(@Words,$word);
                   3578:                 $count++;
                   3579:                 if ($count>10) { last; }
                   3580: 	    }
1.20      www      3581:         }
                   3582:     }
1.46      matthew  3583:     untie %thesaurus_db;
                   3584:     return @Words;
1.14      harris41 3585: }
1.46      matthew  3586: 
1.112     bowersj2 3587: =pod
                   3588: 
                   3589: =back
                   3590: 
                   3591: =cut
1.61      www      3592: 
                   3593: # -------------------------------------------------------------- Plaintext name
1.81      albertel 3594: =pod
                   3595: 
1.112     bowersj2 3596: =head1 User Name Functions
                   3597: 
                   3598: =over 4
                   3599: 
1.648     raeburn  3600: =item * &plainname($uname,$udom,$first)
1.81      albertel 3601: 
1.112     bowersj2 3602: Takes a users logon name and returns it as a string in
1.226     albertel 3603: "first middle last generation" form 
                   3604: if $first is set to 'lastname' then it returns it as
                   3605: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 3606: 
                   3607: =cut
1.61      www      3608: 
1.295     www      3609: 
1.81      albertel 3610: ###############################################################
1.61      www      3611: sub plainname {
1.226     albertel 3612:     my ($uname,$udom,$first)=@_;
1.537     albertel 3613:     return if (!defined($uname) || !defined($udom));
1.295     www      3614:     my %names=&getnames($uname,$udom);
1.226     albertel 3615:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   3616: 					  $names{'middlename'},
                   3617: 					  $names{'lastname'},
                   3618: 					  $names{'generation'},$first);
                   3619:     $name=~s/^\s+//;
1.62      www      3620:     $name=~s/\s+$//;
                   3621:     $name=~s/\s+/ /g;
1.353     albertel 3622:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      3623:     return $name;
1.61      www      3624: }
1.66      www      3625: 
                   3626: # -------------------------------------------------------------------- Nickname
1.81      albertel 3627: =pod
                   3628: 
1.648     raeburn  3629: =item * &nickname($uname,$udom)
1.81      albertel 3630: 
                   3631: Gets a users name and returns it as a string as
                   3632: 
                   3633: "&quot;nickname&quot;"
1.66      www      3634: 
1.81      albertel 3635: if the user has a nickname or
                   3636: 
                   3637: "first middle last generation"
                   3638: 
                   3639: if the user does not
                   3640: 
                   3641: =cut
1.66      www      3642: 
                   3643: sub nickname {
                   3644:     my ($uname,$udom)=@_;
1.537     albertel 3645:     return if (!defined($uname) || !defined($udom));
1.295     www      3646:     my %names=&getnames($uname,$udom);
1.68      albertel 3647:     my $name=$names{'nickname'};
1.66      www      3648:     if ($name) {
                   3649:        $name='&quot;'.$name.'&quot;'; 
                   3650:     } else {
                   3651:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   3652: 	     $names{'lastname'}.' '.$names{'generation'};
                   3653:        $name=~s/\s+$//;
                   3654:        $name=~s/\s+/ /g;
                   3655:     }
                   3656:     return $name;
                   3657: }
                   3658: 
1.295     www      3659: sub getnames {
                   3660:     my ($uname,$udom)=@_;
1.537     albertel 3661:     return if (!defined($uname) || !defined($udom));
1.433     albertel 3662:     if ($udom eq 'public' && $uname eq 'public') {
                   3663: 	return ('lastname' => &mt('Public'));
                   3664:     }
1.295     www      3665:     my $id=$uname.':'.$udom;
                   3666:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   3667:     if ($cached) {
                   3668: 	return %{$names};
                   3669:     } else {
                   3670: 	my %loadnames=&Apache::lonnet::get('environment',
                   3671:                     ['firstname','middlename','lastname','generation','nickname'],
                   3672: 					 $udom,$uname);
                   3673: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   3674: 	return %loadnames;
                   3675:     }
                   3676: }
1.61      www      3677: 
1.542     raeburn  3678: # -------------------------------------------------------------------- getemails
1.648     raeburn  3679: 
1.542     raeburn  3680: =pod
                   3681: 
1.648     raeburn  3682: =item * &getemails($uname,$udom)
1.542     raeburn  3683: 
                   3684: Gets a user's email information and returns it as a hash with keys:
                   3685: notification, critnotification, permanentemail
                   3686: 
                   3687: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  3688: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  3689:  
1.648     raeburn  3690: 
1.542     raeburn  3691: =cut
                   3692: 
1.648     raeburn  3693: 
1.466     albertel 3694: sub getemails {
                   3695:     my ($uname,$udom)=@_;
                   3696:     if ($udom eq 'public' && $uname eq 'public') {
                   3697: 	return;
                   3698:     }
1.467     www      3699:     if (!$udom) { $udom=$env{'user.domain'}; }
                   3700:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 3701:     my $id=$uname.':'.$udom;
                   3702:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   3703:     if ($cached) {
                   3704: 	return %{$names};
                   3705:     } else {
                   3706: 	my %loadnames=&Apache::lonnet::get('environment',
                   3707:                     			   ['notification','critnotification',
                   3708: 					    'permanentemail'],
                   3709: 					   $udom,$uname);
                   3710: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   3711: 	return %loadnames;
                   3712:     }
                   3713: }
                   3714: 
1.551     albertel 3715: sub flush_email_cache {
                   3716:     my ($uname,$udom)=@_;
                   3717:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3718:     if (!$uname) { $uname=$env{'user.name'};   }
                   3719:     return if ($udom eq 'public' && $uname eq 'public');
                   3720:     my $id=$uname.':'.$udom;
                   3721:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   3722: }
                   3723: 
1.728     raeburn  3724: # -------------------------------------------------------------------- getlangs
                   3725: 
                   3726: =pod
                   3727: 
                   3728: =item * &getlangs($uname,$udom)
                   3729: 
                   3730: Gets a user's language preference and returns it as a hash with key:
                   3731: language.
                   3732: 
                   3733: =cut
                   3734: 
                   3735: 
                   3736: sub getlangs {
                   3737:     my ($uname,$udom) = @_;
                   3738:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3739:     if (!$uname) { $uname=$env{'user.name'};   }
                   3740:     my $id=$uname.':'.$udom;
                   3741:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   3742:     if ($cached) {
                   3743:         return %{$langs};
                   3744:     } else {
                   3745:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   3746:                                            $udom,$uname);
                   3747:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   3748:         return %loadlangs;
                   3749:     }
                   3750: }
                   3751: 
                   3752: sub flush_langs_cache {
                   3753:     my ($uname,$udom)=@_;
                   3754:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3755:     if (!$uname) { $uname=$env{'user.name'};   }
                   3756:     return if ($udom eq 'public' && $uname eq 'public');
                   3757:     my $id=$uname.':'.$udom;
                   3758:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   3759: }
                   3760: 
1.61      www      3761: # ------------------------------------------------------------------ Screenname
1.81      albertel 3762: 
                   3763: =pod
                   3764: 
1.648     raeburn  3765: =item * &screenname($uname,$udom)
1.81      albertel 3766: 
                   3767: Gets a users screenname and returns it as a string
                   3768: 
                   3769: =cut
1.61      www      3770: 
                   3771: sub screenname {
                   3772:     my ($uname,$udom)=@_;
1.258     albertel 3773:     if ($uname eq $env{'user.name'} &&
                   3774: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 3775:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 3776:     return $names{'screenname'};
1.62      www      3777: }
                   3778: 
1.212     albertel 3779: 
1.802     bisitz   3780: # ------------------------------------------------------------- Confirm Wrapper
                   3781: =pod
                   3782: 
1.1075.2.42  raeburn  3783: =item * &confirmwrapper($message)
1.802     bisitz   3784: 
                   3785: Wrap messages about completion of operation in box
                   3786: 
                   3787: =cut
                   3788: 
                   3789: sub confirmwrapper {
                   3790:     my ($message)=@_;
                   3791:     if ($message) {
                   3792:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3793:                .$message."\n"
                   3794:                .'</div>'."\n";
                   3795:     } else {
                   3796:         return $message;
                   3797:     }
                   3798: }
                   3799: 
1.62      www      3800: # ------------------------------------------------------------- Message Wrapper
                   3801: 
                   3802: sub messagewrapper {
1.369     www      3803:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3804:     return 
1.441     albertel 3805:         '<a href="/adm/email?compose=individual&amp;'.
                   3806:         'recname='.$username.'&amp;recdom='.$domain.
                   3807: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3808:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3809: }
1.802     bisitz   3810: 
1.74      www      3811: # --------------------------------------------------------------- Notes Wrapper
                   3812: 
                   3813: sub noteswrapper {
                   3814:     my ($link,$un,$do)=@_;
                   3815:     return 
1.896     amueller 3816: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3817: }
1.802     bisitz   3818: 
1.62      www      3819: # ------------------------------------------------------------- Aboutme Wrapper
                   3820: 
                   3821: sub aboutmewrapper {
1.1070    raeburn  3822:     my ($link,$username,$domain,$target,$class)=@_;
1.447     raeburn  3823:     if (!defined($username)  && !defined($domain)) {
                   3824:         return;
                   3825:     }
1.1075.2.15  raeburn  3826:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070    raeburn  3827: 	($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3828: }
                   3829: 
                   3830: # ------------------------------------------------------------ Syllabus Wrapper
                   3831: 
                   3832: sub syllabuswrapper {
1.707     bisitz   3833:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3834:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3835: }
1.14      harris41 3836: 
1.802     bisitz   3837: # -----------------------------------------------------------------------------
                   3838: 
1.208     matthew  3839: sub track_student_link {
1.887     raeburn  3840:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3841:     my $link ="/adm/trackstudent?";
1.208     matthew  3842:     my $title = 'View recent activity';
                   3843:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3844:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3845:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3846:         $title .= ' of this student';
1.268     albertel 3847:     } 
1.208     matthew  3848:     if (defined($target) && $target !~ /^\s*$/) {
                   3849:         $target = qq{target="$target"};
                   3850:     } else {
                   3851:         $target = '';
                   3852:     }
1.268     albertel 3853:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3854:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3855:     $title = &mt($title);
                   3856:     $linktext = &mt($linktext);
1.448     albertel 3857:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3858: 	&help_open_topic('View_recent_activity');
1.208     matthew  3859: }
                   3860: 
1.781     raeburn  3861: sub slot_reservations_link {
                   3862:     my ($linktext,$sname,$sdom,$target) = @_;
                   3863:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3864:     my $title = 'View slot reservation history';
                   3865:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3866:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3867:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3868:         $title .= ' of this student';
                   3869:     }
                   3870:     if (defined($target) && $target !~ /^\s*$/) {
                   3871:         $target = qq{target="$target"};
                   3872:     } else {
                   3873:         $target = '';
                   3874:     }
                   3875:     $title = &mt($title);
                   3876:     $linktext = &mt($linktext);
                   3877:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3878: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3879: 
                   3880: }
                   3881: 
1.508     www      3882: # ===================================================== Display a student photo
                   3883: 
                   3884: 
1.509     albertel 3885: sub student_image_tag {
1.508     www      3886:     my ($domain,$user)=@_;
                   3887:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3888:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3889: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3890:     } else {
                   3891: 	return '';
                   3892:     }
                   3893: }
                   3894: 
1.112     bowersj2 3895: =pod
                   3896: 
                   3897: =back
                   3898: 
                   3899: =head1 Access .tab File Data
                   3900: 
                   3901: =over 4
                   3902: 
1.648     raeburn  3903: =item * &languageids() 
1.112     bowersj2 3904: 
                   3905: returns list of all language ids
                   3906: 
                   3907: =cut
                   3908: 
1.14      harris41 3909: sub languageids {
1.16      harris41 3910:     return sort(keys(%language));
1.14      harris41 3911: }
                   3912: 
1.112     bowersj2 3913: =pod
                   3914: 
1.648     raeburn  3915: =item * &languagedescription() 
1.112     bowersj2 3916: 
                   3917: returns description of a specified language id
                   3918: 
                   3919: =cut
                   3920: 
1.14      harris41 3921: sub languagedescription {
1.125     www      3922:     my $code=shift;
                   3923:     return  ($supported_language{$code}?'* ':'').
                   3924:             $language{$code}.
1.126     www      3925: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3926: }
                   3927: 
1.1048    foxr     3928: =pod
                   3929: 
                   3930: =item * &plainlanguagedescription
                   3931: 
                   3932: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
                   3933: and the language character encoding (e.g. ISO) separated by a ' - ' string.
                   3934: 
                   3935: =cut
                   3936: 
1.145     www      3937: sub plainlanguagedescription {
                   3938:     my $code=shift;
                   3939:     return $language{$code};
                   3940: }
                   3941: 
1.1048    foxr     3942: =pod
                   3943: 
                   3944: =item * &supportedlanguagecode
                   3945: 
                   3946: Returns the supported language code (e.g. sptutf maps to pt) given a language
                   3947: code.
                   3948: 
                   3949: =cut
                   3950: 
1.145     www      3951: sub supportedlanguagecode {
                   3952:     my $code=shift;
                   3953:     return $supported_language{$code};
1.97      www      3954: }
                   3955: 
1.112     bowersj2 3956: =pod
                   3957: 
1.1048    foxr     3958: =item * &latexlanguage()
                   3959: 
                   3960: Given a language key code returns the correspondnig language to use
                   3961: to select the correct hyphenation on LaTeX printouts.  This is undef if there
                   3962: is no supported hyphenation for the language code.
                   3963: 
                   3964: =cut
                   3965: 
                   3966: sub latexlanguage {
                   3967:     my $code = shift;
                   3968:     return $latex_language{$code};
                   3969: }
                   3970: 
                   3971: =pod
                   3972: 
                   3973: =item * &latexhyphenation()
                   3974: 
                   3975: Same as above but what's supplied is the language as it might be stored
                   3976: in the metadata.
                   3977: 
                   3978: =cut
                   3979: 
                   3980: sub latexhyphenation {
                   3981:     my $key = shift;
                   3982:     return $latex_language_bykey{$key};
                   3983: }
                   3984: 
                   3985: =pod
                   3986: 
1.648     raeburn  3987: =item * &copyrightids() 
1.112     bowersj2 3988: 
                   3989: returns list of all copyrights
                   3990: 
                   3991: =cut
                   3992: 
                   3993: sub copyrightids {
                   3994:     return sort(keys(%cprtag));
                   3995: }
                   3996: 
                   3997: =pod
                   3998: 
1.648     raeburn  3999: =item * &copyrightdescription() 
1.112     bowersj2 4000: 
                   4001: returns description of a specified copyright id
                   4002: 
                   4003: =cut
                   4004: 
                   4005: sub copyrightdescription {
1.166     www      4006:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 4007: }
1.197     matthew  4008: 
                   4009: =pod
                   4010: 
1.648     raeburn  4011: =item * &source_copyrightids() 
1.192     taceyjo1 4012: 
                   4013: returns list of all source copyrights
                   4014: 
                   4015: =cut
                   4016: 
                   4017: sub source_copyrightids {
                   4018:     return sort(keys(%scprtag));
                   4019: }
                   4020: 
                   4021: =pod
                   4022: 
1.648     raeburn  4023: =item * &source_copyrightdescription() 
1.192     taceyjo1 4024: 
                   4025: returns description of a specified source copyright id
                   4026: 
                   4027: =cut
                   4028: 
                   4029: sub source_copyrightdescription {
                   4030:     return &mt($scprtag{shift(@_)});
                   4031: }
1.112     bowersj2 4032: 
                   4033: =pod
                   4034: 
1.648     raeburn  4035: =item * &filecategories() 
1.112     bowersj2 4036: 
                   4037: returns list of all file categories
                   4038: 
                   4039: =cut
                   4040: 
                   4041: sub filecategories {
                   4042:     return sort(keys(%category_extensions));
                   4043: }
                   4044: 
                   4045: =pod
                   4046: 
1.648     raeburn  4047: =item * &filecategorytypes() 
1.112     bowersj2 4048: 
                   4049: returns list of file types belonging to a given file
                   4050: category
                   4051: 
                   4052: =cut
                   4053: 
                   4054: sub filecategorytypes {
1.356     albertel 4055:     my ($cat) = @_;
                   4056:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 4057: }
                   4058: 
                   4059: =pod
                   4060: 
1.648     raeburn  4061: =item * &fileembstyle() 
1.112     bowersj2 4062: 
                   4063: returns embedding style for a specified file type
                   4064: 
                   4065: =cut
                   4066: 
                   4067: sub fileembstyle {
                   4068:     return $fe{lc(shift(@_))};
1.169     www      4069: }
                   4070: 
1.351     www      4071: sub filemimetype {
                   4072:     return $fm{lc(shift(@_))};
                   4073: }
                   4074: 
1.169     www      4075: 
                   4076: sub filecategoryselect {
                   4077:     my ($name,$value)=@_;
1.189     matthew  4078:     return &select_form($value,$name,
1.970     raeburn  4079:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112     bowersj2 4080: }
                   4081: 
                   4082: =pod
                   4083: 
1.648     raeburn  4084: =item * &filedescription() 
1.112     bowersj2 4085: 
                   4086: returns description for a specified file type
                   4087: 
                   4088: =cut
                   4089: 
                   4090: sub filedescription {
1.188     matthew  4091:     my $file_description = $fd{lc(shift())};
                   4092:     $file_description =~ s:([\[\]]):~$1:g;
                   4093:     return &mt($file_description);
1.112     bowersj2 4094: }
                   4095: 
                   4096: =pod
                   4097: 
1.648     raeburn  4098: =item * &filedescriptionex() 
1.112     bowersj2 4099: 
                   4100: returns description for a specified file type with
                   4101: extra formatting
                   4102: 
                   4103: =cut
                   4104: 
                   4105: sub filedescriptionex {
                   4106:     my $ex=shift;
1.188     matthew  4107:     my $file_description = $fd{lc($ex)};
                   4108:     $file_description =~ s:([\[\]]):~$1:g;
                   4109:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 4110: }
                   4111: 
                   4112: # End of .tab access
                   4113: =pod
                   4114: 
                   4115: =back
                   4116: 
                   4117: =cut
                   4118: 
                   4119: # ------------------------------------------------------------------ File Types
                   4120: sub fileextensions {
                   4121:     return sort(keys(%fe));
                   4122: }
                   4123: 
1.97      www      4124: # ----------------------------------------------------------- Display Languages
                   4125: # returns a hash with all desired display languages
                   4126: #
                   4127: 
                   4128: sub display_languages {
                   4129:     my %languages=();
1.695     raeburn  4130:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 4131: 	$languages{$lang}=1;
1.97      www      4132:     }
                   4133:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 4134:     if ($env{'form.displaylanguage'}) {
1.356     albertel 4135: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   4136: 	    $languages{$lang}=1;
1.97      www      4137:         }
                   4138:     }
                   4139:     return %languages;
1.14      harris41 4140: }
                   4141: 
1.582     albertel 4142: sub languages {
                   4143:     my ($possible_langs) = @_;
1.695     raeburn  4144:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 4145:     if (!ref($possible_langs)) {
                   4146: 	if( wantarray ) {
                   4147: 	    return @preferred_langs;
                   4148: 	} else {
                   4149: 	    return $preferred_langs[0];
                   4150: 	}
                   4151:     }
                   4152:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   4153:     my @preferred_possibilities;
                   4154:     foreach my $preferred_lang (@preferred_langs) {
                   4155: 	if (exists($possibilities{$preferred_lang})) {
                   4156: 	    push(@preferred_possibilities, $preferred_lang);
                   4157: 	}
                   4158:     }
                   4159:     if( wantarray ) {
                   4160: 	return @preferred_possibilities;
                   4161:     }
                   4162:     return $preferred_possibilities[0];
                   4163: }
                   4164: 
1.742     raeburn  4165: sub user_lang {
                   4166:     my ($touname,$toudom,$fromcid) = @_;
                   4167:     my @userlangs;
                   4168:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   4169:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   4170:                     $env{'course.'.$fromcid.'.languages'}));
                   4171:     } else {
                   4172:         my %langhash = &getlangs($touname,$toudom);
                   4173:         if ($langhash{'languages'} ne '') {
                   4174:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   4175:         } else {
                   4176:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   4177:             if ($domdefs{'lang_def'} ne '') {
                   4178:                 @userlangs = ($domdefs{'lang_def'});
                   4179:             }
                   4180:         }
                   4181:     }
                   4182:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   4183:     my $user_lh = Apache::localize->get_handle(@languages);
                   4184:     return $user_lh;
                   4185: }
                   4186: 
                   4187: 
1.112     bowersj2 4188: ###############################################################
                   4189: ##               Student Answer Attempts                     ##
                   4190: ###############################################################
                   4191: 
                   4192: =pod
                   4193: 
                   4194: =head1 Alternate Problem Views
                   4195: 
                   4196: =over 4
                   4197: 
1.648     raeburn  4198: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1075.2.86  raeburn  4199:     $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112     bowersj2 4200: 
                   4201: Return string with previous attempt on problem. Arguments:
                   4202: 
                   4203: =over 4
                   4204: 
                   4205: =item * $symb: Problem, including path
                   4206: 
                   4207: =item * $username: username of the desired student
                   4208: 
                   4209: =item * $domain: domain of the desired student
1.14      harris41 4210: 
1.112     bowersj2 4211: =item * $course: Course ID
1.14      harris41 4212: 
1.112     bowersj2 4213: =item * $getattempt: Leave blank for all attempts, otherwise put
                   4214:     something
1.14      harris41 4215: 
1.112     bowersj2 4216: =item * $regexp: if string matches this regexp, the string will be
                   4217:     sent to $gradesub
1.14      harris41 4218: 
1.112     bowersj2 4219: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 4220: 
1.1075.2.86  raeburn  4221: =item * $usec: section of the desired student
                   4222: 
                   4223: =item * $identifier: counter for student (multiple students one problem) or
                   4224:     problem (one student; whole sequence).
                   4225: 
1.112     bowersj2 4226: =back
1.14      harris41 4227: 
1.112     bowersj2 4228: The output string is a table containing all desired attempts, if any.
1.16      harris41 4229: 
1.112     bowersj2 4230: =cut
1.1       albertel 4231: 
                   4232: sub get_previous_attempt {
1.1075.2.86  raeburn  4233:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1       albertel 4234:   my $prevattempts='';
1.43      ng       4235:   no strict 'refs';
1.1       albertel 4236:   if ($symb) {
1.3       albertel 4237:     my (%returnhash)=
                   4238:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 4239:     if ($returnhash{'version'}) {
                   4240:       my %lasthash=();
                   4241:       my $version;
                   4242:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.91  raeburn  4243:         foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
                   4244:             if ($key =~ /\.rawrndseed$/) {
                   4245:                 my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
                   4246:                 $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
                   4247:             } else {
                   4248:                 $lasthash{$key}=$returnhash{$version.':'.$key};
                   4249:             }
1.19      harris41 4250:         }
1.1       albertel 4251:       }
1.596     albertel 4252:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   4253:       $prevattempts.='<th>'.&mt('History').'</th>';
1.1075.2.86  raeburn  4254:       my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945     raeburn  4255:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 4256:       foreach my $key (sort(keys(%lasthash))) {
                   4257: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       4258: 	if ($#parts > 0) {
1.31      albertel 4259: 	  my $data=$parts[-1];
1.989     raeburn  4260:           next if ($data eq 'foilorder');
1.31      albertel 4261: 	  pop(@parts);
1.1010    www      4262:           $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.945     raeburn  4263:           if ($data eq 'type') {
                   4264:               unless ($showsurv) {
                   4265:                   my $id = join(',',@parts);
                   4266:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978     raeburn  4267:                   if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                   4268:                       $lasthidden{$ign.'.'.$id} = 1;
                   4269:                   }
1.945     raeburn  4270:               }
1.1075.2.86  raeburn  4271:               if ($identifier ne '') {
                   4272:                   my $id = join(',',@parts);
                   4273:                   if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
                   4274:                                                $domain,$username,$usec,undef,$course) =~ /^no/) {
                   4275:                       $hidestatus{$ign.'.'.$id} = 1;
                   4276:                   }
                   4277:               }
                   4278:           } elsif ($data eq 'regrader') {
                   4279:               if (($identifier ne '') && (@parts)) {
                   4280:                   my $id = join(',',@parts);
                   4281:                   $regraded{$ign.'.'.$id} = 1;
                   4282:               }
1.1010    www      4283:           } 
1.31      albertel 4284: 	} else {
1.41      ng       4285: 	  if ($#parts == 0) {
                   4286: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   4287: 	  } else {
                   4288: 	    $prevattempts.='<th>'.$ign.'</th>';
                   4289: 	  }
1.31      albertel 4290: 	}
1.16      harris41 4291:       }
1.596     albertel 4292:       $prevattempts.=&end_data_table_header_row();
1.40      ng       4293:       if ($getattempt eq '') {
1.1075.2.86  raeburn  4294:         my (%solved,%resets,%probstatus);
                   4295:         if (($identifier ne '') && (keys(%regraded) > 0)) {
                   4296:             for ($version=1;$version<=$returnhash{'version'};$version++) {
                   4297:                 foreach my $id (keys(%regraded)) {
                   4298:                     if (($returnhash{$version.':'.$id.'.regrader'}) &&
                   4299:                         ($returnhash{$version.':'.$id.'.tries'} eq '') &&
                   4300:                         ($returnhash{$version.':'.$id.'.award'} eq '')) {
                   4301:                         push(@{$resets{$id}},$version);
                   4302:                     }
                   4303:                 }
                   4304:             }
                   4305:         }
1.40      ng       4306: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.86  raeburn  4307:             my (@hidden,@unsolved);
1.945     raeburn  4308:             if (%typeparts) {
                   4309:                 foreach my $id (keys(%typeparts)) {
1.1075.2.86  raeburn  4310:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
                   4311:                         ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945     raeburn  4312:                         push(@hidden,$id);
1.1075.2.86  raeburn  4313:                     } elsif ($identifier ne '') {
                   4314:                         unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
                   4315:                                 ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
                   4316:                                 ($hidestatus{$id})) {
                   4317:                             next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
                   4318:                             if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
                   4319:                                 push(@{$solved{$id}},$version);
                   4320:                             } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
                   4321:                                      (ref($solved{$id}) eq 'ARRAY')) {
                   4322:                                 my $skip;
                   4323:                                 if (ref($resets{$id}) eq 'ARRAY') {
                   4324:                                     foreach my $reset (@{$resets{$id}}) {
                   4325:                                         if ($reset > $solved{$id}[-1]) {
                   4326:                                             $skip=1;
                   4327:                                             last;
                   4328:                                         }
                   4329:                                     }
                   4330:                                 }
                   4331:                                 unless ($skip) {
                   4332:                                     my ($ign,$partslist) = split(/\./,$id,2);
                   4333:                                     push(@unsolved,$partslist);
                   4334:                                 }
                   4335:                             }
                   4336:                         }
1.945     raeburn  4337:                     }
                   4338:                 }
                   4339:             }
                   4340:             $prevattempts.=&start_data_table_row().
1.1075.2.86  raeburn  4341:                            '<td>'.&mt('Transaction [_1]',$version);
                   4342:             if (@unsolved) {
                   4343:                 $prevattempts .= '<span class="LC_nobreak"><label>'.
                   4344:                                  '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
                   4345:                                  &mt('Hide').'</label></span>';
                   4346:             }
                   4347:             $prevattempts .= '</td>';
1.945     raeburn  4348:             if (@hidden) {
                   4349:                 foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4350:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  4351:                     my $hide;
                   4352:                     foreach my $id (@hidden) {
                   4353:                         if ($key =~ /^\Q$id\E/) {
                   4354:                             $hide = 1;
                   4355:                             last;
                   4356:                         }
                   4357:                     }
                   4358:                     if ($hide) {
                   4359:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   4360:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   4361:                             my $value = &format_previous_attempt_value($key,
                   4362:                                              $returnhash{$version.':'.$key});
                   4363:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4364:                         } else {
                   4365:                             $prevattempts.='<td>&nbsp;</td>';
                   4366:                         }
                   4367:                     } else {
                   4368:                         if ($key =~ /\./) {
1.1075.2.91  raeburn  4369:                             my $value = $returnhash{$version.':'.$key};
                   4370:                             if ($key =~ /\.rndseed$/) {
                   4371:                                 my ($id) = ($key =~ /^(.+)\.rndseed$/);
                   4372:                                 if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   4373:                                     $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   4374:                                 }
                   4375:                             }
                   4376:                             $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   4377:                                            '&nbsp;</td>';
1.945     raeburn  4378:                         } else {
                   4379:                             $prevattempts.='<td>&nbsp;</td>';
                   4380:                         }
                   4381:                     }
                   4382:                 }
                   4383:             } else {
                   4384: 	        foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4385:                     next if ($key =~ /\.foilorder$/);
1.1075.2.91  raeburn  4386:                     my $value = $returnhash{$version.':'.$key};
                   4387:                     if ($key =~ /\.rndseed$/) {
                   4388:                         my ($id) = ($key =~ /^(.+)\.rndseed$/);
                   4389:                         if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   4390:                             $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   4391:                         }
                   4392:                     }
                   4393:                     $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   4394:                                    '&nbsp;</td>';
1.945     raeburn  4395: 	        }
                   4396:             }
                   4397: 	    $prevattempts.=&end_data_table_row();
1.40      ng       4398: 	 }
1.1       albertel 4399:       }
1.945     raeburn  4400:       my @currhidden = keys(%lasthidden);
1.596     albertel 4401:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 4402:       foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4403:           next if ($key =~ /\.foilorder$/);
1.945     raeburn  4404:           if (%typeparts) {
                   4405:               my $hidden;
                   4406:               foreach my $id (@currhidden) {
                   4407:                   if ($key =~ /^\Q$id\E/) {
                   4408:                       $hidden = 1;
                   4409:                       last;
                   4410:                   }
                   4411:               }
                   4412:               if ($hidden) {
                   4413:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   4414:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   4415:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4416:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4417:                           $value = &$gradesub($value);
                   4418:                       }
                   4419:                       $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4420:                   } else {
                   4421:                       $prevattempts.='<td>&nbsp;</td>';
                   4422:                   }
                   4423:               } else {
                   4424:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4425:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4426:                       $value = &$gradesub($value);
                   4427:                   }
                   4428:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4429:               }
                   4430:           } else {
                   4431: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4432: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4433:                   $value = &$gradesub($value);
                   4434:               }
                   4435: 	      $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4436:           }
1.16      harris41 4437:       }
1.596     albertel 4438:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 4439:     } else {
1.596     albertel 4440:       $prevattempts=
                   4441: 	  &start_data_table().&start_data_table_row().
                   4442: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   4443: 	  &end_data_table_row().&end_data_table();
1.1       albertel 4444:     }
                   4445:   } else {
1.596     albertel 4446:     $prevattempts=
                   4447: 	  &start_data_table().&start_data_table_row().
                   4448: 	  '<td>'.&mt('No data.').'</td>'.
                   4449: 	  &end_data_table_row().&end_data_table();
1.1       albertel 4450:   }
1.10      albertel 4451: }
                   4452: 
1.581     albertel 4453: sub format_previous_attempt_value {
                   4454:     my ($key,$value) = @_;
1.1011    www      4455:     if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581     albertel 4456: 	$value = &Apache::lonlocal::locallocaltime($value);
                   4457:     } elsif (ref($value) eq 'ARRAY') {
                   4458: 	$value = '('.join(', ', @{ $value }).')';
1.988     raeburn  4459:     } elsif ($key =~ /answerstring$/) {
                   4460:         my %answers = &Apache::lonnet::str2hash($value);
                   4461:         my @anskeys = sort(keys(%answers));
                   4462:         if (@anskeys == 1) {
                   4463:             my $answer = $answers{$anskeys[0]};
1.1001    raeburn  4464:             if ($answer =~ m{\0}) {
                   4465:                 $answer =~ s{\0}{,}g;
1.988     raeburn  4466:             }
                   4467:             my $tag_internal_answer_name = 'INTERNAL';
                   4468:             if ($anskeys[0] eq $tag_internal_answer_name) {
                   4469:                 $value = $answer; 
                   4470:             } else {
                   4471:                 $value = $anskeys[0].'='.$answer;
                   4472:             }
                   4473:         } else {
                   4474:             foreach my $ans (@anskeys) {
                   4475:                 my $answer = $answers{$ans};
1.1001    raeburn  4476:                 if ($answer =~ m{\0}) {
                   4477:                     $answer =~ s{\0}{,}g;
1.988     raeburn  4478:                 }
                   4479:                 $value .=  $ans.'='.$answer.'<br />';;
                   4480:             } 
                   4481:         }
1.581     albertel 4482:     } else {
                   4483: 	$value = &unescape($value);
                   4484:     }
                   4485:     return $value;
                   4486: }
                   4487: 
                   4488: 
1.107     albertel 4489: sub relative_to_absolute {
                   4490:     my ($url,$output)=@_;
                   4491:     my $parser=HTML::TokeParser->new(\$output);
                   4492:     my $token;
                   4493:     my $thisdir=$url;
                   4494:     my @rlinks=();
                   4495:     while ($token=$parser->get_token) {
                   4496: 	if ($token->[0] eq 'S') {
                   4497: 	    if ($token->[1] eq 'a') {
                   4498: 		if ($token->[2]->{'href'}) {
                   4499: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   4500: 		}
                   4501: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   4502: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   4503: 	    } elsif ($token->[1] eq 'base') {
                   4504: 		$thisdir=$token->[2]->{'href'};
                   4505: 	    }
                   4506: 	}
                   4507:     }
                   4508:     $thisdir=~s-/[^/]*$--;
1.356     albertel 4509:     foreach my $link (@rlinks) {
1.726     raeburn  4510: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 4511: 		($link=~/^\//) ||
                   4512: 		($link=~/^javascript:/i) ||
                   4513: 		($link=~/^mailto:/i) ||
                   4514: 		($link=~/^\#/)) {
                   4515: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   4516: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 4517: 	}
                   4518:     }
                   4519: # -------------------------------------------------- Deal with Applet codebases
                   4520:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   4521:     return $output;
                   4522: }
                   4523: 
1.112     bowersj2 4524: =pod
                   4525: 
1.648     raeburn  4526: =item * &get_student_view()
1.112     bowersj2 4527: 
                   4528: show a snapshot of what student was looking at
                   4529: 
                   4530: =cut
                   4531: 
1.10      albertel 4532: sub get_student_view {
1.186     albertel 4533:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      4534:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4535:   my (%form);
1.10      albertel 4536:   my @elements=('symb','courseid','domain','username');
                   4537:   foreach my $element (@elements) {
1.186     albertel 4538:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4539:   }
1.186     albertel 4540:   if (defined($moreenv)) {
                   4541:       %form=(%form,%{$moreenv});
                   4542:   }
1.236     albertel 4543:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 4544:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      4545:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 4546:   $userview=~s/\<body[^\>]*\>//gi;
                   4547:   $userview=~s/\<\/body\>//gi;
                   4548:   $userview=~s/\<html\>//gi;
                   4549:   $userview=~s/\<\/html\>//gi;
                   4550:   $userview=~s/\<head\>//gi;
                   4551:   $userview=~s/\<\/head\>//gi;
                   4552:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 4553:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      4554:   if (wantarray) {
                   4555:      return ($userview,$response);
                   4556:   } else {
                   4557:      return $userview;
                   4558:   }
                   4559: }
                   4560: 
                   4561: sub get_student_view_with_retries {
                   4562:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   4563: 
                   4564:     my $ok = 0;                 # True if we got a good response.
                   4565:     my $content;
                   4566:     my $response;
                   4567: 
                   4568:     # Try to get the student_view done. within the retries count:
                   4569:     
                   4570:     do {
                   4571:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   4572:          $ok      = $response->is_success;
                   4573:          if (!$ok) {
                   4574:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   4575:          }
                   4576:          $retries--;
                   4577:     } while (!$ok && ($retries > 0));
                   4578:     
                   4579:     if (!$ok) {
                   4580:        $content = '';          # On error return an empty content.
                   4581:     }
1.651     www      4582:     if (wantarray) {
                   4583:        return ($content, $response);
                   4584:     } else {
                   4585:        return $content;
                   4586:     }
1.11      albertel 4587: }
                   4588: 
1.1075.2.149  raeburn  4589: sub css_links {
                   4590:     my ($currsymb,$level) = @_;
                   4591:     my ($links,@symbs,%cssrefs,%httpref);
                   4592:     if ($level eq 'map') {
                   4593:         my $navmap = Apache::lonnavmaps::navmap->new();
                   4594:         if (ref($navmap)) {
                   4595:             my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
                   4596:             my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
                   4597:             foreach my $res (@resources) {
                   4598:                 if (ref($res) && $res->symb()) {
                   4599:                     push(@symbs,$res->symb());
                   4600:                 }
                   4601:             }
                   4602:         }
                   4603:     } else {
                   4604:         @symbs = ($currsymb);
                   4605:     }
                   4606:     foreach my $symb (@symbs) {
                   4607:         my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
                   4608:         if ($css_href =~ /\S/) {
                   4609:             unless ($css_href =~ m{https?://}) {
                   4610:                 my $url = (&Apache::lonnet::decode_symb($symb))[-1];
                   4611:                 my $proburl =  &Apache::lonnet::clutter($url);
                   4612:                 my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
                   4613:                 unless ($css_href =~ m{^/}) {
                   4614:                     $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
                   4615:                 }
                   4616:                 if ($css_href =~ m{^/(res|uploaded)/}) {
                   4617:                     unless (($httpref{'httpref.'.$css_href}) ||
                   4618:                             (&Apache::lonnet::is_on_map($css_href))) {
                   4619:                         my $thisurl = $proburl;
                   4620:                         if ($env{'httpref.'.$proburl}) {
                   4621:                             $thisurl = $env{'httpref.'.$proburl};
                   4622:                         }
                   4623:                         $httpref{'httpref.'.$css_href} = $thisurl;
                   4624:                     }
                   4625:                 }
                   4626:             }
                   4627:             $cssrefs{$css_href} = 1;
                   4628:         }
                   4629:     }
                   4630:     if (keys(%httpref)) {
                   4631:         &Apache::lonnet::appenv(\%httpref);
                   4632:     }
                   4633:     if (keys(%cssrefs)) {
                   4634:         foreach my $css_href (keys(%cssrefs)) {
                   4635:             next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
                   4636:             $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
                   4637:         }
                   4638:     }
                   4639:     return $links;
                   4640: }
                   4641: 
1.112     bowersj2 4642: =pod
                   4643: 
1.648     raeburn  4644: =item * &get_student_answers() 
1.112     bowersj2 4645: 
                   4646: show a snapshot of how student was answering problem
                   4647: 
                   4648: =cut
                   4649: 
1.11      albertel 4650: sub get_student_answers {
1.100     sakharuk 4651:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      4652:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4653:   my (%moreenv);
1.11      albertel 4654:   my @elements=('symb','courseid','domain','username');
                   4655:   foreach my $element (@elements) {
1.186     albertel 4656:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4657:   }
1.186     albertel 4658:   $moreenv{'grade_target'}='answer';
                   4659:   %moreenv=(%form,%moreenv);
1.497     raeburn  4660:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   4661:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 4662:   return $userview;
1.1       albertel 4663: }
1.116     albertel 4664: 
                   4665: =pod
                   4666: 
                   4667: =item * &submlink()
                   4668: 
1.242     albertel 4669: Inputs: $text $uname $udom $symb $target
1.116     albertel 4670: 
                   4671: Returns: A link to grades.pm such as to see the SUBM view of a student
                   4672: 
                   4673: =cut
                   4674: 
                   4675: ###############################################
                   4676: sub submlink {
1.242     albertel 4677:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 4678:     if (!($uname && $udom)) {
                   4679: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4680: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 4681: 	if (!$symb) { $symb=$cursymb; }
                   4682:     }
1.254     matthew  4683:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4684:     $symb=&escape($symb);
1.960     bisitz   4685:     if ($target) { $target=" target=\"$target\""; }
                   4686:     return
                   4687:         '<a href="/adm/grades?command=submission'.
                   4688:         '&amp;symb='.$symb.
                   4689:         '&amp;student='.$uname.
                   4690:         '&amp;userdom='.$udom.'"'.
                   4691:         $target.'>'.$text.'</a>';
1.242     albertel 4692: }
                   4693: ##############################################
                   4694: 
                   4695: =pod
                   4696: 
                   4697: =item * &pgrdlink()
                   4698: 
                   4699: Inputs: $text $uname $udom $symb $target
                   4700: 
                   4701: Returns: A link to grades.pm such as to see the PGRD view of a student
                   4702: 
                   4703: =cut
                   4704: 
                   4705: ###############################################
                   4706: sub pgrdlink {
                   4707:     my $link=&submlink(@_);
                   4708:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   4709:     return $link;
                   4710: }
                   4711: ##############################################
                   4712: 
                   4713: =pod
                   4714: 
                   4715: =item * &pprmlink()
                   4716: 
                   4717: Inputs: $text $uname $udom $symb $target
                   4718: 
                   4719: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 4720: student and a specific resource
1.242     albertel 4721: 
                   4722: =cut
                   4723: 
                   4724: ###############################################
                   4725: sub pprmlink {
                   4726:     my ($text,$uname,$udom,$symb,$target)=@_;
                   4727:     if (!($uname && $udom)) {
                   4728: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4729: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 4730: 	if (!$symb) { $symb=$cursymb; }
                   4731:     }
1.254     matthew  4732:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4733:     $symb=&escape($symb);
1.242     albertel 4734:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 4735:     return '<a href="/adm/parmset?command=set&amp;'.
                   4736: 	'symb='.$symb.'&amp;uname='.$uname.
                   4737: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 4738: }
                   4739: ##############################################
1.37      matthew  4740: 
1.112     bowersj2 4741: =pod
                   4742: 
                   4743: =back
                   4744: 
                   4745: =cut
                   4746: 
1.37      matthew  4747: ###############################################
1.51      www      4748: 
                   4749: 
                   4750: sub timehash {
1.687     raeburn  4751:     my ($thistime) = @_;
                   4752:     my $timezone = &Apache::lonlocal::gettimezone();
                   4753:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   4754:                      ->set_time_zone($timezone);
                   4755:     my $wday = $dt->day_of_week();
                   4756:     if ($wday == 7) { $wday = 0; }
                   4757:     return ( 'second' => $dt->second(),
                   4758:              'minute' => $dt->minute(),
                   4759:              'hour'   => $dt->hour(),
                   4760:              'day'     => $dt->day_of_month(),
                   4761:              'month'   => $dt->month(),
                   4762:              'year'    => $dt->year(),
                   4763:              'weekday' => $wday,
                   4764:              'dayyear' => $dt->day_of_year(),
                   4765:              'dlsav'   => $dt->is_dst() );
1.51      www      4766: }
                   4767: 
1.370     www      4768: sub utc_string {
                   4769:     my ($date)=@_;
1.371     www      4770:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      4771: }
                   4772: 
1.51      www      4773: sub maketime {
                   4774:     my %th=@_;
1.687     raeburn  4775:     my ($epoch_time,$timezone,$dt);
                   4776:     $timezone = &Apache::lonlocal::gettimezone();
                   4777:     eval {
                   4778:         $dt = DateTime->new( year   => $th{'year'},
                   4779:                              month  => $th{'month'},
                   4780:                              day    => $th{'day'},
                   4781:                              hour   => $th{'hour'},
                   4782:                              minute => $th{'minute'},
                   4783:                              second => $th{'second'},
                   4784:                              time_zone => $timezone,
                   4785:                          );
                   4786:     };
                   4787:     if (!$@) {
                   4788:         $epoch_time = $dt->epoch;
                   4789:         if ($epoch_time) {
                   4790:             return $epoch_time;
                   4791:         }
                   4792:     }
1.51      www      4793:     return POSIX::mktime(
                   4794:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      4795:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      4796: }
                   4797: 
                   4798: #########################################
1.51      www      4799: 
                   4800: sub findallcourses {
1.482     raeburn  4801:     my ($roles,$uname,$udom) = @_;
1.355     albertel 4802:     my %roles;
                   4803:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 4804:     my %courses;
1.51      www      4805:     my $now=time;
1.482     raeburn  4806:     if (!defined($uname)) {
                   4807:         $uname = $env{'user.name'};
                   4808:     }
                   4809:     if (!defined($udom)) {
                   4810:         $udom = $env{'user.domain'};
                   4811:     }
                   4812:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073    raeburn  4813:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482     raeburn  4814:         if (!%roles) {
                   4815:             %roles = (
                   4816:                        cc => 1,
1.907     raeburn  4817:                        co => 1,
1.482     raeburn  4818:                        in => 1,
                   4819:                        ep => 1,
                   4820:                        ta => 1,
                   4821:                        cr => 1,
                   4822:                        st => 1,
                   4823:              );
                   4824:         }
                   4825:         foreach my $entry (keys(%roleshash)) {
                   4826:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   4827:             if ($trole =~ /^cr/) { 
                   4828:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   4829:             } else {
                   4830:                 next if (!exists($roles{$trole}));
                   4831:             }
                   4832:             if ($tend) {
                   4833:                 next if ($tend < $now);
                   4834:             }
                   4835:             if ($tstart) {
                   4836:                 next if ($tstart > $now);
                   4837:             }
1.1058    raeburn  4838:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482     raeburn  4839:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058    raeburn  4840:             my $value = $trole.'/'.$cdom.'/';
1.482     raeburn  4841:             if ($secpart eq '') {
                   4842:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   4843:                 $sec = 'none';
1.1058    raeburn  4844:                 $value .= $cnum.'/';
1.482     raeburn  4845:             } else {
                   4846:                 $cnum = $cnumpart;
                   4847:                 ($sec,$role) = split(/_/,$secpart);
1.1058    raeburn  4848:                 $value .= $cnum.'/'.$sec;
                   4849:             }
                   4850:             if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4851:                 unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4852:                     push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4853:                 }
                   4854:             } else {
                   4855:                 @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490     raeburn  4856:             }
1.482     raeburn  4857:         }
                   4858:     } else {
                   4859:         foreach my $key (keys(%env)) {
1.483     albertel 4860: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   4861:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  4862: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   4863: 	        next if ($role eq 'ca' || $role eq 'aa');
                   4864: 	        next if (%roles && !exists($roles{$role}));
                   4865: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   4866:                 my $active=1;
                   4867:                 if ($starttime) {
                   4868: 		    if ($now<$starttime) { $active=0; }
                   4869:                 }
                   4870:                 if ($endtime) {
                   4871:                     if ($now>$endtime) { $active=0; }
                   4872:                 }
                   4873:                 if ($active) {
1.1058    raeburn  4874:                     my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482     raeburn  4875:                     if ($sec eq '') {
                   4876:                         $sec = 'none';
1.1058    raeburn  4877:                     } else {
                   4878:                         $value .= $sec;
                   4879:                     }
                   4880:                     if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4881:                         unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4882:                             push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4883:                         }
                   4884:                     } else {
                   4885:                         @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482     raeburn  4886:                     }
1.474     raeburn  4887:                 }
                   4888:             }
1.51      www      4889:         }
                   4890:     }
1.474     raeburn  4891:     return %courses;
1.51      www      4892: }
1.37      matthew  4893: 
1.54      www      4894: ###############################################
1.474     raeburn  4895: 
                   4896: sub blockcheck {
1.1075.2.158  raeburn  4897:     my ($setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.490     raeburn  4898: 
1.1075.2.161.  .4(raebu 4899:22):     unless (($activity eq 'docs') || ($activity eq 'reinit') || ($activity eq 'alert')) {
1.1075.2.158  raeburn  4900:         my ($has_evb,$check_ipaccess);
                   4901:         my $dom = $env{'user.domain'};
                   4902:         if ($env{'request.course.id'}) {
                   4903:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   4904:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   4905:             my $checkrole = "cm./$cdom/$cnum";
                   4906:             my $sec = $env{'request.course.sec'};
                   4907:             if ($sec ne '') {
                   4908:                 $checkrole .= "/$sec";
                   4909:             }
                   4910:             if ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   4911:                 ($env{'request.role'} !~ /^st/)) {
                   4912:                 $has_evb = 1;
                   4913:             }
                   4914:             unless ($has_evb) {
                   4915:                 if (($activity eq 'printout') || ($activity eq 'grades') || ($activity eq 'search') ||
                   4916:                     ($activity eq 'boards') || ($activity eq 'groups') || ($activity eq 'chat')) {
                   4917:                     if ($udom eq $cdom) {
                   4918:                         $check_ipaccess = 1;
                   4919:                     }
                   4920:                 }
                   4921:             }
1.1075.2.161.  .3(raebu 4922:22):         } elsif (($activity eq 'com') || ($activity eq 'port') || ($activity eq 'blogs') ||
                   4923:22):                 ($activity eq 'about') || ($activity eq 'wishlist') || ($activity eq 'passwd')) {
                   4924:22):             my $checkrole;
                   4925:22):             if ($env{'request.role.domain'} eq '') {
                   4926:22):                 $checkrole = "cm./$env{'user.domain'}/";
                   4927:22):             } else {
                   4928:22):                 $checkrole = "cm./$env{'request.role.domain'}/";
                   4929:22):             }
                   4930:22):             if (($checkrole) && (&Apache::lonnet::allowed('evb',undef,undef,$checkrole))) {
                   4931:22):                 $has_evb = 1;
                   4932:22):             }
1.1075.2.158  raeburn  4933:         }
                   4934:         unless ($has_evb || $check_ipaccess) {
                   4935:             my @machinedoms = &Apache::lonnet::current_machine_domains();
                   4936:             if (($dom eq 'public') && ($activity eq 'port')) {
                   4937:                 $dom = $udom;
                   4938:             }
                   4939:             if (($dom ne '') && (grep(/^\Q$dom\E$/,@machinedoms))) {
                   4940:                 $check_ipaccess = 1;
                   4941:             } else {
                   4942:                 my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   4943:                 my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
                   4944:                 my $prim = &Apache::lonnet::domain($dom,'primary');
                   4945:                 my $intdom = &Apache::lonnet::internet_dom($prim);
                   4946:                 if (($intdom ne '') && (ref($internet_names) eq 'ARRAY')) {
                   4947:                     if (grep(/^\Q$intdom\E$/,@{$internet_names})) {
                   4948:                         $check_ipaccess = 1;
                   4949:                     }
                   4950:                 }
                   4951:             }
                   4952:         }
                   4953:         if ($check_ipaccess) {
                   4954:             my ($ipaccessref,$cached)=&Apache::lonnet::is_cached_new('ipaccess',$dom);
                   4955:             unless (defined($cached)) {
                   4956:                 my %domconfig =
                   4957:                     &Apache::lonnet::get_dom('configuration',['ipaccess'],$dom);
                   4958:                 $ipaccessref = &Apache::lonnet::do_cache_new('ipaccess',$dom,$domconfig{'ipaccess'},1800);
                   4959:             }
                   4960:             if ((ref($ipaccessref) eq 'HASH') && ($clientip)) {
                   4961:                 foreach my $id (keys(%{$ipaccessref})) {
                   4962:                     if (ref($ipaccessref->{$id}) eq 'HASH') {
                   4963:                         my $range = $ipaccessref->{$id}->{'ip'};
                   4964:                         if ($range) {
                   4965:                             if (&Apache::lonnet::ip_match($clientip,$range)) {
                   4966:                                 if (ref($ipaccessref->{$id}->{'commblocks'}) eq 'HASH') {
                   4967:                                     if ($ipaccessref->{$id}->{'commblocks'}->{$activity} eq 'on') {
                   4968:                                         return ('','','',$id,$dom);
                   4969:                                         last;
                   4970:                                     }
                   4971:                                 }
                   4972:                             }
                   4973:                         }
                   4974:                     }
                   4975:                 }
                   4976:             }
                   4977:         }
1.1075.2.161.  .4(raebu 4978:22):         if (($activity eq 'wishlist') || ($activity eq 'annotate')) {
                   4979:22):             return ();
                   4980:22):         }
1.1075.2.158  raeburn  4981:     }
1.1075.2.73  raeburn  4982:     if (defined($udom) && defined($uname)) {
                   4983:         # If uname and udom are for a course, check for blocks in the course.
                   4984:         if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
                   4985:             my ($startblock,$endblock,$triggerblock) =
1.1075.2.147  raeburn  4986:                 &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1075.2.73  raeburn  4987:             return ($startblock,$endblock,$triggerblock);
                   4988:         }
                   4989:     } else {
1.490     raeburn  4990:         $udom = $env{'user.domain'};
                   4991:         $uname = $env{'user.name'};
                   4992:     }
                   4993: 
1.502     raeburn  4994:     my $startblock = 0;
                   4995:     my $endblock = 0;
1.1062    raeburn  4996:     my $triggerblock = '';
1.1075.2.160  raeburn  4997:     my %live_courses;
                   4998:     unless (($activity eq 'wishlist') || ($activity eq 'annotate')) {
                   4999:         %live_courses = &findallcourses(undef,$uname,$udom);
                   5000:     }
1.474     raeburn  5001: 
1.490     raeburn  5002:     # If uname is for a user, and activity is course-specific, i.e.,
                   5003:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  5004: 
1.490     raeburn  5005:     if (($activity eq 'boards' || $activity eq 'chat' ||
1.1075.2.161.  .1(raebu 5006:21):          $activity eq 'groups' || $activity eq 'printout' ||
                   5007:21):          $activity eq 'search' || $activity eq 'reinit' ||
                   5008:21):          $activity eq 'alert') && ($env{'request.course.id'})) {
1.490     raeburn  5009:         foreach my $key (keys(%live_courses)) {
                   5010:             if ($key ne $env{'request.course.id'}) {
                   5011:                 delete($live_courses{$key});
                   5012:             }
                   5013:         }
                   5014:     }
                   5015: 
                   5016:     my $otheruser = 0;
                   5017:     my %own_courses;
                   5018:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   5019:         # Resource belongs to user other than current user.
                   5020:         $otheruser = 1;
                   5021:         # Gather courses for current user
                   5022:         %own_courses = 
                   5023:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   5024:     }
                   5025: 
                   5026:     # Gather active course roles - course coordinator, instructor, 
                   5027:     # exam proctor, ta, student, or custom role.
1.474     raeburn  5028: 
                   5029:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  5030:         my ($cdom,$cnum);
                   5031:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   5032:             $cdom = $env{'course.'.$course.'.domain'};
                   5033:             $cnum = $env{'course.'.$course.'.num'};
                   5034:         } else {
1.490     raeburn  5035:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  5036:         }
                   5037:         my $no_ownblock = 0;
                   5038:         my $no_userblock = 0;
1.533     raeburn  5039:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  5040:             # Check if current user has 'evb' priv for this
                   5041:             if (defined($own_courses{$course})) {
                   5042:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   5043:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   5044:                     if ($sec ne 'none') {
                   5045:                         $checkrole .= '/'.$sec;
                   5046:                     }
                   5047:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   5048:                         $no_ownblock = 1;
                   5049:                         last;
                   5050:                     }
                   5051:                 }
                   5052:             }
                   5053:             # if they have 'evb' priv and are currently not playing student
                   5054:             next if (($no_ownblock) &&
                   5055:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   5056:         }
1.474     raeburn  5057:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  5058:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  5059:             if ($sec ne 'none') {
1.482     raeburn  5060:                 $checkrole .= '/'.$sec;
1.474     raeburn  5061:             }
1.490     raeburn  5062:             if ($otheruser) {
                   5063:                 # Resource belongs to user other than current user.
                   5064:                 # Assemble privs for that user, and check for 'evb' priv.
1.1058    raeburn  5065:                 my (%allroles,%userroles);
                   5066:                 if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
                   5067:                     foreach my $entry (@{$live_courses{$course}{$sec}}) { 
                   5068:                         my ($trole,$tdom,$tnum,$tsec);
                   5069:                         if ($entry =~ /^cr/) {
                   5070:                             ($trole,$tdom,$tnum,$tsec) = 
                   5071:                                 ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   5072:                         } else {
                   5073:                            ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   5074:                         }
                   5075:                         my ($spec,$area,$trest);
                   5076:                         $area = '/'.$tdom.'/'.$tnum;
                   5077:                         $trest = $tnum;
                   5078:                         if ($tsec ne '') {
                   5079:                             $area .= '/'.$tsec;
                   5080:                             $trest .= '/'.$tsec;
                   5081:                         }
                   5082:                         $spec = $trole.'.'.$area;
                   5083:                         if ($trole =~ /^cr/) {
                   5084:                             &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   5085:                                                               $tdom,$spec,$trest,$area);
                   5086:                         } else {
                   5087:                             &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   5088:                                                                 $tdom,$spec,$trest,$area);
                   5089:                         }
                   5090:                     }
1.1075.2.124  raeburn  5091:                     my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058    raeburn  5092:                     if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   5093:                         if ($1) {
                   5094:                             $no_userblock = 1;
                   5095:                             last;
                   5096:                         }
1.486     raeburn  5097:                     }
                   5098:                 }
1.490     raeburn  5099:             } else {
                   5100:                 # Resource belongs to current user
                   5101:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  5102:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   5103:                     $no_ownblock = 1;
                   5104:                     last;
                   5105:                 }
1.474     raeburn  5106:             }
                   5107:         }
                   5108:         # if they have the evb priv and are currently not playing student
1.482     raeburn  5109:         next if (($no_ownblock) &&
1.491     albertel 5110:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  5111:         next if ($no_userblock);
1.474     raeburn  5112: 
1.1075.2.128  raeburn  5113:         # Retrieve blocking times and identity of blocker for course
1.490     raeburn  5114:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  5115:         
1.1062    raeburn  5116:         my ($start,$end,$trigger) = 
1.1075.2.147  raeburn  5117:             &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502     raeburn  5118:         if (($start != 0) && 
                   5119:             (($startblock == 0) || ($startblock > $start))) {
                   5120:             $startblock = $start;
1.1062    raeburn  5121:             if ($trigger ne '') {
                   5122:                 $triggerblock = $trigger;
                   5123:             }
1.502     raeburn  5124:         }
                   5125:         if (($end != 0)  &&
                   5126:             (($endblock == 0) || ($endblock < $end))) {
                   5127:             $endblock = $end;
1.1062    raeburn  5128:             if ($trigger ne '') {
                   5129:                 $triggerblock = $trigger;
                   5130:             }
1.502     raeburn  5131:         }
1.490     raeburn  5132:     }
1.1062    raeburn  5133:     return ($startblock,$endblock,$triggerblock);
1.490     raeburn  5134: }
                   5135: 
                   5136: sub get_blocks {
1.1075.2.147  raeburn  5137:     my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490     raeburn  5138:     my $startblock = 0;
                   5139:     my $endblock = 0;
1.1062    raeburn  5140:     my $triggerblock = '';
1.490     raeburn  5141:     my $course = $cdom.'_'.$cnum;
                   5142:     $setters->{$course} = {};
                   5143:     $setters->{$course}{'staff'} = [];
                   5144:     $setters->{$course}{'times'} = [];
1.1062    raeburn  5145:     $setters->{$course}{'triggers'} = [];
                   5146:     my (@blockers,%triggered);
                   5147:     my $now = time;
                   5148:     my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
                   5149:     if ($activity eq 'docs') {
1.1075.2.148  raeburn  5150:         my ($blocked,$nosymbcache,$noenccheck);
1.1075.2.147  raeburn  5151:         if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
                   5152:             $blocked = 1;
                   5153:             $nosymbcache = 1;
1.1075.2.148  raeburn  5154:             $noenccheck = 1;
1.1075.2.147  raeburn  5155:         }
1.1075.2.148  raeburn  5156:         @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062    raeburn  5157:         foreach my $block (@blockers) {
                   5158:             if ($block =~ /^firstaccess____(.+)$/) {
                   5159:                 my $item = $1;
                   5160:                 my $type = 'map';
                   5161:                 my $timersymb = $item;
                   5162:                 if ($item eq 'course') {
                   5163:                     $type = 'course';
                   5164:                 } elsif ($item =~ /___\d+___/) {
                   5165:                     $type = 'resource';
                   5166:                 } else {
                   5167:                     $timersymb = &Apache::lonnet::symbread($item);
                   5168:                 }
                   5169:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   5170:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
                   5171:                 $triggered{$block} = {
                   5172:                                        start => $start,
                   5173:                                        end   => $end,
                   5174:                                        type  => $type,
                   5175:                                      };
                   5176:             }
                   5177:         }
                   5178:     } else {
                   5179:         foreach my $block (keys(%commblocks)) {
                   5180:             if ($block =~ m/^(\d+)____(\d+)$/) { 
                   5181:                 my ($start,$end) = ($1,$2);
                   5182:                 if ($start <= time && $end >= time) {
                   5183:                     if (ref($commblocks{$block}) eq 'HASH') {
                   5184:                         if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   5185:                             if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   5186:                                 unless(grep(/^\Q$block\E$/,@blockers)) {
                   5187:                                     push(@blockers,$block);
                   5188:                                 }
                   5189:                             }
                   5190:                         }
                   5191:                     }
                   5192:                 }
                   5193:             } elsif ($block =~ /^firstaccess____(.+)$/) {
                   5194:                 my $item = $1;
                   5195:                 my $timersymb = $item; 
                   5196:                 my $type = 'map';
                   5197:                 if ($item eq 'course') {
                   5198:                     $type = 'course';
                   5199:                 } elsif ($item =~ /___\d+___/) {
                   5200:                     $type = 'resource';
                   5201:                 } else {
                   5202:                     $timersymb = &Apache::lonnet::symbread($item);
                   5203:                 }
                   5204:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   5205:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb}; 
                   5206:                 if ($start && $end) {
                   5207:                     if (($start <= time) && ($end >= time)) {
1.1075.2.158  raeburn  5208:                         if (ref($commblocks{$block}) eq 'HASH') {
                   5209:                             if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   5210:                                 if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   5211:                                     unless(grep(/^\Q$block\E$/,@blockers)) {
                   5212:                                         push(@blockers,$block);
                   5213:                                         $triggered{$block} = {
                   5214:                                                                start => $start,
                   5215:                                                                end   => $end,
                   5216:                                                                type  => $type,
                   5217:                                                              };
                   5218:                                     }
                   5219:                                 }
                   5220:                             }
1.1062    raeburn  5221:                         }
                   5222:                     }
1.490     raeburn  5223:                 }
1.1062    raeburn  5224:             }
                   5225:         }
                   5226:     }
                   5227:     foreach my $blocker (@blockers) {
                   5228:         my ($staff_name,$staff_dom,$title,$blocks) =
                   5229:             &parse_block_record($commblocks{$blocker});
                   5230:         push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   5231:         my ($start,$end,$triggertype);
                   5232:         if ($blocker =~ m/^(\d+)____(\d+)$/) {
                   5233:             ($start,$end) = ($1,$2);
                   5234:         } elsif (ref($triggered{$blocker}) eq 'HASH') {
                   5235:             $start = $triggered{$blocker}{'start'};
                   5236:             $end = $triggered{$blocker}{'end'};
                   5237:             $triggertype = $triggered{$blocker}{'type'};
                   5238:         }
                   5239:         if ($start) {
                   5240:             push(@{$$setters{$course}{'times'}}, [$start,$end]);
                   5241:             if ($triggertype) {
                   5242:                 push(@{$$setters{$course}{'triggers'}},$triggertype);
                   5243:             } else {
                   5244:                 push(@{$$setters{$course}{'triggers'}},0);
                   5245:             }
                   5246:             if ( ($startblock == 0) || ($startblock > $start) ) {
                   5247:                 $startblock = $start;
                   5248:                 if ($triggertype) {
                   5249:                     $triggerblock = $blocker;
1.474     raeburn  5250:                 }
                   5251:             }
1.1062    raeburn  5252:             if ( ($endblock == 0) || ($endblock < $end) ) {
                   5253:                $endblock = $end;
                   5254:                if ($triggertype) {
                   5255:                    $triggerblock = $blocker;
                   5256:                }
                   5257:             }
1.474     raeburn  5258:         }
                   5259:     }
1.1062    raeburn  5260:     return ($startblock,$endblock,$triggerblock);
1.474     raeburn  5261: }
                   5262: 
                   5263: sub parse_block_record {
                   5264:     my ($record) = @_;
                   5265:     my ($setuname,$setudom,$title,$blocks);
                   5266:     if (ref($record) eq 'HASH') {
                   5267:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   5268:         $title = &unescape($record->{'event'});
                   5269:         $blocks = $record->{'blocks'};
                   5270:     } else {
                   5271:         my @data = split(/:/,$record,3);
                   5272:         if (scalar(@data) eq 2) {
                   5273:             $title = $data[1];
                   5274:             ($setuname,$setudom) = split(/@/,$data[0]);
                   5275:         } else {
                   5276:             ($setuname,$setudom,$title) = @data;
                   5277:         }
                   5278:         $blocks = { 'com' => 'on' };
                   5279:     }
                   5280:     return ($setuname,$setudom,$title,$blocks);
                   5281: }
                   5282: 
1.854     kalberla 5283: sub blocking_status {
1.1075.2.158  raeburn  5284:     my ($activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061    raeburn  5285:     my %setters;
1.890     droeschl 5286: 
1.1061    raeburn  5287: # check for active blocking
1.1075.2.158  raeburn  5288:     if ($clientip eq '') {
                   5289:         $clientip = &Apache::lonnet::get_requestor_ip();
                   5290:     }
                   5291:     my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) = 
                   5292:         &blockcheck(\%setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062    raeburn  5293:     my $blocked = 0;
1.1075.2.158  raeburn  5294:     if (($startblock && $endblock) || ($by_ip)) {
1.1062    raeburn  5295:         $blocked = 1;
                   5296:     }
1.890     droeschl 5297: 
1.1061    raeburn  5298: # caller just wants to know whether a block is active
                   5299:     if (!wantarray) { return $blocked; }
                   5300: 
                   5301: # build a link to a popup window containing the details
                   5302:     my $querystring  = "?activity=$activity";
1.1075.2.158  raeburn  5303: # $uname and $udom decide whose portfolio (or information page) the user is trying to look at
                   5304:     if (($activity eq 'port') || ($activity eq 'about') || ($activity eq 'passwd')) {
1.1075.2.97  raeburn  5305:         $querystring .= "&amp;udom=$udom"      if ($udom =~ /^$match_domain$/);
                   5306:         $querystring .= "&amp;uname=$uname"    if ($uname =~ /^$match_username$/);
1.1062    raeburn  5307:     } elsif ($activity eq 'docs') {
1.1075.2.147  raeburn  5308:         my $showurl = &Apache::lonenc::check_encrypt($url);
                   5309:         $querystring .= '&amp;url='.&HTML::Entities::encode($showurl,'\'&"<>');
                   5310:         if ($symb) {
                   5311:             my $showsymb = &Apache::lonenc::check_encrypt($symb);
                   5312:             $querystring .= '&amp;symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
                   5313:         }
1.1062    raeburn  5314:     }
1.1061    raeburn  5315: 
                   5316:     my $output .= <<'END_MYBLOCK';
                   5317: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   5318:     var options = "width=" + w + ",height=" + h + ",";
                   5319:     options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   5320:     options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   5321:     var newWin = window.open(url, wdwName, options);
                   5322:     newWin.focus();
                   5323: }
1.890     droeschl 5324: END_MYBLOCK
1.854     kalberla 5325: 
1.1061    raeburn  5326:     $output = Apache::lonhtmlcommon::scripttag($output);
1.890     droeschl 5327:   
1.1061    raeburn  5328:     my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062    raeburn  5329:     my $text = &mt('Communication Blocked');
1.1075.2.93  raeburn  5330:     my $class = 'LC_comblock';
1.1062    raeburn  5331:     if ($activity eq 'docs') {
                   5332:         $text = &mt('Content Access Blocked');
1.1075.2.93  raeburn  5333:         $class = '';
1.1063    raeburn  5334:     } elsif ($activity eq 'printout') {
                   5335:         $text = &mt('Printing Blocked');
1.1075.2.97  raeburn  5336:     } elsif ($activity eq 'passwd') {
                   5337:         $text = &mt('Password Changing Blocked');
1.1075.2.158  raeburn  5338:     } elsif ($activity eq 'grades') {
                   5339:         $text = &mt('Gradebook Blocked');
                   5340:     } elsif ($activity eq 'search') {
                   5341:         $text = &mt('Search Blocked');
1.1075.2.161.  .1(raebu 5342:21):     } elsif ($activity eq 'alert') {
                   5343:21):         $text = &mt('Checking Critical Messages Blocked');
                   5344:21):     } elsif ($activity eq 'reinit') {
                   5345:21):         $text = &mt('Checking Course Update Blocked');
1.1075.2.158  raeburn  5346:     } elsif ($activity eq 'about') {
                   5347:         $text = &mt('Access to User Information Pages Blocked');
1.1075.2.160  raeburn  5348:     } elsif ($activity eq 'wishlist') {
                   5349:         $text = &mt('Access to Stored Links Blocked');
                   5350:     } elsif ($activity eq 'annotate') {
                   5351:         $text = &mt('Access to Annotations Blocked');
1.1062    raeburn  5352:     }
1.1061    raeburn  5353:     $output .= <<"END_BLOCK";
1.1075.2.93  raeburn  5354: <div class='$class'>
1.869     kalberla 5355:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 5356:   title='$text'>
                   5357:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 5358:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 5359:   title='$text'>$text</a>
1.867     kalberla 5360: </div>
                   5361: 
                   5362: END_BLOCK
1.474     raeburn  5363: 
1.1061    raeburn  5364:     return ($blocked, $output);
1.854     kalberla 5365: }
1.490     raeburn  5366: 
1.60      matthew  5367: ###############################################
                   5368: 
1.682     raeburn  5369: sub check_ip_acc {
1.1075.2.105  raeburn  5370:     my ($acc,$clientip)=@_;
1.682     raeburn  5371:     &Apache::lonxml::debug("acc is $acc");
                   5372:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   5373:         return 1;
                   5374:     }
                   5375:     my $allowed=0;
1.1075.2.144  raeburn  5376:     my $ip;
                   5377:     if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
                   5378:         ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
                   5379:         $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
                   5380:     } else {
1.1075.2.150  raeburn  5381:         my $remote_ip = &Apache::lonnet::get_requestor_ip();
                   5382:         $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1075.2.144  raeburn  5383:     }
1.682     raeburn  5384: 
                   5385:     my $name;
1.1075.2.161.  .1(raebu 5386:21):     my %access = (
                   5387:21):                      allowfrom => 1,
                   5388:21):                      denyfrom  => 0,
                   5389:21):                  );
                   5390:21):     my @allows;
                   5391:21):     my @denies;
                   5392:21):     foreach my $item (split(',',$acc)) {
                   5393:21):         $item =~ s/^\s*//;
                   5394:21):         $item =~ s/\s*$//;
                   5395:21):         if ($item =~ /^\!(.+)$/) {
                   5396:21):             push(@denies,$1);
                   5397:21):         } else {
                   5398:21):             push(@allows,$item);
                   5399:21):         }
                   5400:21):     }
                   5401:21):     my $numdenies = scalar(@denies);
                   5402:21):     my $numallows = scalar(@allows);
                   5403:21):     my $count = 0;
                   5404:21):     foreach my $pattern (@denies,@allows) {
                   5405:21):         $count ++;
                   5406:21):         my $acctype = 'allowfrom';
                   5407:21):         if ($count <= $numdenies) {
                   5408:21):             $acctype = 'denyfrom';
                   5409:21):         }
1.682     raeburn  5410:         if ($pattern =~ /\*$/) {
                   5411:             #35.8.*
                   5412:             $pattern=~s/\*//;
1.1075.2.161.  .1(raebu 5413:21):             if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682     raeburn  5414:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   5415:             #35.8.3.[34-56]
                   5416:             my $low=$2;
                   5417:             my $high=$3;
                   5418:             $pattern=$1;
                   5419:             if ($ip =~ /^\Q$pattern\E/) {
                   5420:                 my $last=(split(/\./,$ip))[3];
1.1075.2.161.  .1(raebu 5421:21):                 if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682     raeburn  5422:             }
                   5423:         } elsif ($pattern =~ /^\*/) {
                   5424:             #*.msu.edu
                   5425:             $pattern=~s/\*//;
                   5426:             if (!defined($name)) {
                   5427:                 use Socket;
                   5428:                 my $netaddr=inet_aton($ip);
                   5429:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   5430:             }
1.1075.2.161.  .1(raebu 5431:21):             if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682     raeburn  5432:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   5433:             #127.0.0.1
1.1075.2.161.  .1(raebu 5434:21):             if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682     raeburn  5435:         } else {
                   5436:             #some.name.com
                   5437:             if (!defined($name)) {
                   5438:                 use Socket;
                   5439:                 my $netaddr=inet_aton($ip);
                   5440:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   5441:             }
1.1075.2.161.  .1(raebu 5442:21):             if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
                   5443:21):         }
                   5444:21):         if ($allowed =~ /^(0|1)$/) { last; }
                   5445:21):     }
                   5446:21):     if ($allowed eq '') {
                   5447:21):         if ($numdenies && !$numallows) {
                   5448:21):             $allowed = 1;
                   5449:21):         } else {
                   5450:21):             $allowed = 0;
1.682     raeburn  5451:         }
                   5452:     }
                   5453:     return $allowed;
                   5454: }
                   5455: 
                   5456: ###############################################
                   5457: 
1.60      matthew  5458: =pod
                   5459: 
1.112     bowersj2 5460: =head1 Domain Template Functions
                   5461: 
                   5462: =over 4
                   5463: 
                   5464: =item * &determinedomain()
1.60      matthew  5465: 
                   5466: Inputs: $domain (usually will be undef)
                   5467: 
1.63      www      5468: Returns: Determines which domain should be used for designs
1.60      matthew  5469: 
                   5470: =cut
1.54      www      5471: 
1.60      matthew  5472: ###############################################
1.63      www      5473: sub determinedomain {
                   5474:     my $domain=shift;
1.531     albertel 5475:     if (! $domain) {
1.60      matthew  5476:         # Determine domain if we have not been given one
1.893     raeburn  5477:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 5478:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   5479:         if ($env{'request.role.domain'}) { 
                   5480:             $domain=$env{'request.role.domain'}; 
1.60      matthew  5481:         }
                   5482:     }
1.63      www      5483:     return $domain;
                   5484: }
                   5485: ###############################################
1.517     raeburn  5486: 
1.518     albertel 5487: sub devalidate_domconfig_cache {
                   5488:     my ($udom)=@_;
                   5489:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   5490: }
                   5491: 
                   5492: # ---------------------- Get domain configuration for a domain
                   5493: sub get_domainconf {
                   5494:     my ($udom) = @_;
                   5495:     my $cachetime=1800;
                   5496:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   5497:     if (defined($cached)) { return %{$result}; }
                   5498: 
                   5499:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  5500: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  5501:     my (%designhash,%legacy);
1.518     albertel 5502:     if (keys(%domconfig) > 0) {
                   5503:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  5504:             if (keys(%{$domconfig{'login'}})) {
                   5505:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  5506:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1075.2.87  raeburn  5507:                         if (($key eq 'loginvia') || ($key eq 'headtag')) {
                   5508:                             if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   5509:                                 foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
                   5510:                                     if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
                   5511:                                         if ($key eq 'loginvia') {
                   5512:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   5513:                                                 my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   5514:                                                 $designhash{$udom.'.login.loginvia'} = $server;
                   5515:                                                 if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   5516:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   5517:                                                 } else {
                   5518:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
                   5519:                                                 }
1.948     raeburn  5520:                                             }
1.1075.2.87  raeburn  5521:                                         } elsif ($key eq 'headtag') {
                   5522:                                             if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
                   5523:                                                 $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948     raeburn  5524:                                             }
1.946     raeburn  5525:                                         }
1.1075.2.87  raeburn  5526:                                         if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
                   5527:                                             $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
                   5528:                                         }
1.946     raeburn  5529:                                     }
                   5530:                                 }
                   5531:                             }
1.1075.2.158  raeburn  5532:                         } elsif ($key eq 'saml') {
                   5533:                             if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   5534:                                 foreach my $host (keys(%{$domconfig{'login'}{$key}})) {
                   5535:                                     if (ref($domconfig{'login'}{$key}{$host}) eq 'HASH') {
                   5536:                                         $designhash{$udom.'.login.'.$key.'_'.$host} = 1;
1.1075.2.161.  .9(raebu 5537:22):                                         foreach my $item ('text','img','alt','url','title','window','notsso') {
1.1075.2.158  raeburn  5538:                                             $designhash{$udom.'.login.'.$key.'_'.$item.'_'.$host} = $domconfig{'login'}{$key}{$host}{$item};
                   5539:                                         }
                   5540:                                     }
                   5541:                                 }
                   5542:                             }
1.946     raeburn  5543:                         } else {
                   5544:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   5545:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   5546:                                     $domconfig{'login'}{$key}{$img};
                   5547:                             }
1.699     raeburn  5548:                         }
                   5549:                     } else {
                   5550:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   5551:                     }
1.632     raeburn  5552:                 }
                   5553:             } else {
                   5554:                 $legacy{'login'} = 1;
1.518     albertel 5555:             }
1.632     raeburn  5556:         } else {
                   5557:             $legacy{'login'} = 1;
1.518     albertel 5558:         }
                   5559:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  5560:             if (keys(%{$domconfig{'rolecolors'}})) {
                   5561:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   5562:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   5563:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   5564:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   5565:                         }
1.518     albertel 5566:                     }
                   5567:                 }
1.632     raeburn  5568:             } else {
                   5569:                 $legacy{'rolecolors'} = 1;
1.518     albertel 5570:             }
1.632     raeburn  5571:         } else {
                   5572:             $legacy{'rolecolors'} = 1;
1.518     albertel 5573:         }
1.948     raeburn  5574:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   5575:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   5576:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   5577:             }
                   5578:         }
1.632     raeburn  5579:         if (keys(%legacy) > 0) {
                   5580:             my %legacyhash = &get_legacy_domconf($udom);
                   5581:             foreach my $item (keys(%legacyhash)) {
                   5582:                 if ($item =~ /^\Q$udom\E\.login/) {
                   5583:                     if ($legacy{'login'}) { 
                   5584:                         $designhash{$item} = $legacyhash{$item};
                   5585:                     }
                   5586:                 } else {
                   5587:                     if ($legacy{'rolecolors'}) {
                   5588:                         $designhash{$item} = $legacyhash{$item};
                   5589:                     }
1.518     albertel 5590:                 }
                   5591:             }
                   5592:         }
1.632     raeburn  5593:     } else {
                   5594:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 5595:     }
                   5596:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   5597: 				  $cachetime);
                   5598:     return %designhash;
                   5599: }
                   5600: 
1.632     raeburn  5601: sub get_legacy_domconf {
                   5602:     my ($udom) = @_;
                   5603:     my %legacyhash;
                   5604:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   5605:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   5606:     if (-e $designfile) {
1.1075.2.128  raeburn  5607:         if ( open (my $fh,'<',$designfile) ) {
1.632     raeburn  5608:             while (my $line = <$fh>) {
                   5609:                 next if ($line =~ /^\#/);
                   5610:                 chomp($line);
                   5611:                 my ($key,$val)=(split(/\=/,$line));
                   5612:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   5613:             }
                   5614:             close($fh);
                   5615:         }
                   5616:     }
1.1026    raeburn  5617:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  5618:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   5619:     }
                   5620:     return %legacyhash;
                   5621: }
                   5622: 
1.63      www      5623: =pod
                   5624: 
1.112     bowersj2 5625: =item * &domainlogo()
1.63      www      5626: 
                   5627: Inputs: $domain (usually will be undef)
                   5628: 
                   5629: Returns: A link to a domain logo, if the domain logo exists.
                   5630: If the domain logo does not exist, a description of the domain.
                   5631: 
                   5632: =cut
1.112     bowersj2 5633: 
1.63      www      5634: ###############################################
                   5635: sub domainlogo {
1.517     raeburn  5636:     my $domain = &determinedomain(shift);
1.518     albertel 5637:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  5638:     # See if there is a logo
                   5639:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  5640:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 5641:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   5642: 	    if ($imgsrc =~ m{^/res/}) {
                   5643: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   5644: 		&Apache::lonnet::repcopy($local_name);
                   5645: 	    }
                   5646: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.1075.2.161.  .2(raebu 5647:22):         }
                   5648:22):         my $alttext = $domain;
                   5649:22):         if ($designhash{$domain.'.login.alttext_domlogo'} ne '') {
                   5650:22):             $alttext = $designhash{$domain.'.login.alttext_domlogo'};
                   5651:22):         }
                   5652:22):         return '<img src="'.$imgsrc.'" alt="'.$alttext.'" id="lclogindomlogo" />';
1.514     albertel 5653:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   5654:         return &Apache::lonnet::domain($domain,'description');
1.59      www      5655:     } else {
1.60      matthew  5656:         return '';
1.59      www      5657:     }
                   5658: }
1.63      www      5659: ##############################################
                   5660: 
                   5661: =pod
                   5662: 
1.112     bowersj2 5663: =item * &designparm()
1.63      www      5664: 
                   5665: Inputs: $which parameter; $domain (usually will be undef)
                   5666: 
                   5667: Returns: value of designparamter $which
                   5668: 
                   5669: =cut
1.112     bowersj2 5670: 
1.397     albertel 5671: 
1.400     albertel 5672: ##############################################
1.397     albertel 5673: sub designparm {
                   5674:     my ($which,$domain)=@_;
                   5675:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   5676:         return $env{'environment.color.'.$which};
1.96      www      5677:     }
1.63      www      5678:     $domain=&determinedomain($domain);
1.1016    raeburn  5679:     my %domdesign;
                   5680:     unless ($domain eq 'public') {
                   5681:         %domdesign = &get_domainconf($domain);
                   5682:     }
1.520     raeburn  5683:     my $output;
1.517     raeburn  5684:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   5685:         $output = $domdesign{$domain.'.'.$which};
1.63      www      5686:     } else {
1.520     raeburn  5687:         $output = $defaultdesign{$which};
                   5688:     }
                   5689:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  5690:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 5691:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   5692:             if ($output =~ m{^/res/}) {
                   5693:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   5694:                 &Apache::lonnet::repcopy($local_name);
                   5695:             }
1.520     raeburn  5696:             $output = &lonhttpdurl($output);
                   5697:         }
1.63      www      5698:     }
1.520     raeburn  5699:     return $output;
1.63      www      5700: }
1.59      www      5701: 
1.822     bisitz   5702: ##############################################
                   5703: =pod
                   5704: 
1.832     bisitz   5705: =item * &authorspace()
                   5706: 
1.1028    raeburn  5707: Inputs: $url (usually will be undef).
1.832     bisitz   5708: 
1.1075.2.40  raeburn  5709: Returns: Path to Authoring Space containing the resource or 
1.1028    raeburn  5710:          directory being viewed (or for which action is being taken). 
                   5711:          If $url is provided, and begins /priv/<domain>/<uname>
                   5712:          the path will be that portion of the $context argument.
                   5713:          Otherwise the path will be for the author space of the current
                   5714:          user when the current role is author, or for that of the 
                   5715:          co-author/assistant co-author space when the current role 
                   5716:          is co-author or assistant co-author.
1.832     bisitz   5717: 
                   5718: =cut
                   5719: 
                   5720: sub authorspace {
1.1028    raeburn  5721:     my ($url) = @_;
                   5722:     if ($url ne '') {
                   5723:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   5724:            return $1;
                   5725:         }
                   5726:     }
1.832     bisitz   5727:     my $caname = '';
1.1024    www      5728:     my $cadom = '';
1.1028    raeburn  5729:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      5730:         ($cadom,$caname) =
1.832     bisitz   5731:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  5732:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   5733:         $caname = $env{'user.name'};
1.1024    www      5734:         $cadom = $env{'user.domain'};
1.832     bisitz   5735:     }
1.1028    raeburn  5736:     if (($caname ne '') && ($cadom ne '')) {
                   5737:         return "/priv/$cadom/$caname/";
                   5738:     }
                   5739:     return;
1.832     bisitz   5740: }
                   5741: 
                   5742: ##############################################
                   5743: =pod
                   5744: 
1.822     bisitz   5745: =item * &head_subbox()
                   5746: 
                   5747: Inputs: $content (contains HTML code with page functions, etc.)
                   5748: 
                   5749: Returns: HTML div with $content
                   5750:          To be included in page header
                   5751: 
                   5752: =cut
                   5753: 
                   5754: sub head_subbox {
                   5755:     my ($content)=@_;
                   5756:     my $output =
1.993     raeburn  5757:         '<div class="LC_head_subbox">'
1.822     bisitz   5758:        .$content
                   5759:        .'</div>'
                   5760: }
                   5761: 
                   5762: ##############################################
                   5763: =pod
                   5764: 
                   5765: =item * &CSTR_pageheader()
                   5766: 
1.1026    raeburn  5767: Input: (optional) filename from which breadcrumb trail is built.
                   5768:        In most cases no input as needed, as $env{'request.filename'}
                   5769:        is appropriate for use in building the breadcrumb trail.
1.1075.2.161.  .6(raebu 5770:22):        frameset flag
                   5771:22):        If page header is being requested for use in a frameset, then
                   5772:22):        the second (option) argument -- frameset will be true, and
                   5773:22):        the target attribute set for links should be target="_parent".
1.822     bisitz   5774: 
                   5775: Returns: HTML div with CSTR path and recent box
1.1075.2.40  raeburn  5776:          To be included on Authoring Space pages
1.822     bisitz   5777: 
                   5778: =cut
                   5779: 
                   5780: sub CSTR_pageheader {
1.1075.2.161.  .6(raebu 5781:22):     my ($trailfile,$frameset) = @_;
1.1026    raeburn  5782:     if ($trailfile eq '') {
                   5783:         $trailfile = $env{'request.filename'};
                   5784:     }
                   5785: 
                   5786: # this is for resources; directories have customtitle, and crumbs
                   5787: # and select recent are created in lonpubdir.pm
                   5788: 
                   5789:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      5790:     my ($udom,$uname,$thisdisfn)=
1.1075.2.29  raeburn  5791:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026    raeburn  5792:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   5793:     $formaction =~ s{/+}{/}g;
1.822     bisitz   5794: 
                   5795:     my $parentpath = '';
                   5796:     my $lastitem = '';
                   5797:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   5798:         $parentpath = $1;
                   5799:         $lastitem = $2;
                   5800:     } else {
                   5801:         $lastitem = $thisdisfn;
                   5802:     }
1.921     bisitz   5803: 
1.1075.2.161.  .6(raebu 5804:22):     my ($target,$crumbtarget) = (' target="_top"','_top');
                   5805:22):     if ($frameset) {
                   5806:22):         $target = ' target="_parent"';
                   5807:22):         $crumbtarget = '_parent';
                   5808:22):     } elsif (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'})) {
                   5809:22):         $target = ' target="'.$env{'request.deeplink.target'}.'"';
                   5810:22):         $crumbtarget = $env{'request.deeplink.target'};
                   5811:22):     }
                   5812:22): 
1.921     bisitz   5813:     my $output =
1.822     bisitz   5814:          '<div>'
                   5815:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1075.2.40  raeburn  5816:         .'<b>'.&mt('Authoring Space:').'</b> '
1.1075.2.161.  .6(raebu 5817:22):         .'<form name="dirs" method="post" action="'.$formaction.'"'.$target.'>'
                   5818:22):         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,$crumbtarget,'/priv/'.$udom,undef,undef);
1.921     bisitz   5819: 
                   5820:     if ($lastitem) {
                   5821:         $output .=
                   5822:              '<span class="LC_filename">'
                   5823:             .$lastitem
                   5824:             .'</span>';
                   5825:     }
                   5826:     $output .=
                   5827:          '<br />'
1.1075.2.161.  .6(raebu 5828:22):         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/',$crumbtarget,'/priv','','+1',1)."</b></tt><br />"
1.822     bisitz   5829:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   5830:         .'</form>'
1.1075.2.161.  .6(raebu 5831:22):         .&Apache::lonmenu::constspaceform($frameset)
1.822     bisitz   5832:         .'</div>';
1.921     bisitz   5833: 
                   5834:     return $output;
1.822     bisitz   5835: }
                   5836: 
1.60      matthew  5837: ###############################################
                   5838: ###############################################
                   5839: 
                   5840: =pod
                   5841: 
1.112     bowersj2 5842: =back
                   5843: 
1.549     albertel 5844: =head1 HTML Helpers
1.112     bowersj2 5845: 
                   5846: =over 4
                   5847: 
                   5848: =item * &bodytag()
1.60      matthew  5849: 
                   5850: Returns a uniform header for LON-CAPA web pages.
                   5851: 
                   5852: Inputs: 
                   5853: 
1.112     bowersj2 5854: =over 4
                   5855: 
                   5856: =item * $title, A title to be displayed on the page.
                   5857: 
                   5858: =item * $function, the current role (can be undef).
                   5859: 
                   5860: =item * $addentries, extra parameters for the <body> tag.
                   5861: 
                   5862: =item * $bodyonly, if defined, only return the <body> tag.
                   5863: 
                   5864: =item * $domain, if defined, force a given domain.
                   5865: 
                   5866: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      5867:             text interface only)
1.60      matthew  5868: 
1.814     bisitz   5869: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   5870:                      navigational links
1.317     albertel 5871: 
1.338     albertel 5872: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   5873: 
1.1075.2.12  raeburn  5874: =item * $no_inline_link, if true and in remote mode, don't show the
                   5875:          'Switch To Inline Menu' link
                   5876: 
1.460     albertel 5877: =item * $args, optional argument valid values are
                   5878:             no_auto_mt_title -> prevents &mt()ing the title arg
1.1075.2.133  raeburn  5879:             use_absolute     -> for external resource or syllabus, this will
                   5880:                                 contain https://<hostname> if server uses
                   5881:                                 https (as per hosts.tab), but request is for http
                   5882:             hostname         -> hostname, from $r->hostname().
1.460     albertel 5883: 
1.1075.2.15  raeburn  5884: =item * $advtoolsref, optional argument, ref to an array containing
                   5885:             inlineremote items to be added in "Functions" menu below
                   5886:             breadcrumbs.
                   5887: 
1.1075.2.161.  .1(raebu 5888:21): =item * $ltiscope, optional argument, will be one of: resource, map or
                   5889:21):             course, if LON-CAPA is in LTI Provider context. Value is
                   5890:21):             the scope of use, i.e., launch was for access to a single, a map
                   5891:21):             or the entire course.
                   5892:21): 
                   5893:21): =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
                   5894:21):             context, this will contain the URL for the landing item in
                   5895:21):             the course, after launch from an LTI Consumer
                   5896:21): 
                   5897:21): =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
                   5898:21):             context, this will contain a reference to hash of items
                   5899:21):             to be included in the page header and/or inline menu.
                   5900:21): 
          .8(raebu 5901:22): =item * $menucoll, optional argument, if specific menu collection is in
                   5902:22):             effect, either set as the default for the course, or set for
                   5903:22):             the deeplink paramater for $env{'request.deeplink.login'}
                   5904:22):             then $menucoll will be the number of that collection.
                   5905:22): 
                   5906:22): =item * $menuref, optional argument, reference to a hash, containing the
                   5907:22):             menu options included for the menu in effect, based on the
                   5908:22):             configuration for the numbered menu collection in use.
                   5909:22): 
                   5910:22): =item * $showncrumbsref, reference to a scalar. Calls to lonmenu::innerregister
                   5911:22):             within &bodytag() can result in calls to lonhtmlcommon::breadcrumbs(),
                   5912:22):             if so, $showncrumbsref is set there to 1, and will propagate back
                   5913:22):             via &bodytag() to &start_page(), to prevent lonhtmlcommon::breadcrumbs()
                   5914:22):             being called a second time.
                   5915:22): 
1.112     bowersj2 5916: =back
                   5917: 
1.60      matthew  5918: Returns: A uniform header for LON-CAPA web pages.  
                   5919: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   5920: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   5921: other decorations will be returned.
                   5922: 
                   5923: =cut
                   5924: 
1.54      www      5925: sub bodytag {
1.831     bisitz   5926:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1075.2.161.  .1(raebu 5927:21):         $no_nav_bar,$bgcolor,$no_inline_link,$args,$advtoolsref,
          .8(raebu 5928:22):         $ltiscope,$ltiuri,$ltimenu,$menucoll,$menuref,$showncrumbsref)=@_;
1.339     albertel 5929: 
1.954     raeburn  5930:     my $public;
                   5931:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   5932:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   5933:         $public = 1;
                   5934:     }
1.460     albertel 5935:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1075.2.52  raeburn  5936:     my $httphost = $args->{'use_absolute'};
1.1075.2.133  raeburn  5937:     my $hostname = $args->{'hostname'};
1.339     albertel 5938: 
1.183     matthew  5939:     $function = &get_users_function() if (!$function);
1.339     albertel 5940:     my $img =    &designparm($function.'.img',$domain);
                   5941:     my $font =   &designparm($function.'.font',$domain);
                   5942:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   5943: 
1.803     bisitz   5944:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 5945: 		   'bgcolor' => $pgbg,
1.339     albertel 5946: 		   'text'    => $font,
                   5947:                    'alink'   => &designparm($function.'.alink',$domain),
                   5948: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   5949: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 5950:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 5951: 
1.63      www      5952:  # role and realm
1.1075.2.68  raeburn  5953:     my ($role,$realm) = split(m{\./},$env{'request.role'},2);
                   5954:     if ($realm) {
                   5955:         $realm = '/'.$realm;
                   5956:     }
1.1075.2.159  raeburn  5957:     if ($role eq 'ca') {
1.479     albertel 5958:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 5959:         $realm = &plainname($rname,$rdom);
1.378     raeburn  5960:     } 
1.55      www      5961: # realm
1.1075.2.158  raeburn  5962:     my ($cid,$sec);
1.258     albertel 5963:     if ($env{'request.course.id'}) {
1.1075.2.158  raeburn  5964:         $cid = $env{'request.course.id'};
                   5965:         if ($env{'request.course.sec'}) {
                   5966:             $sec = $env{'request.course.sec'};
                   5967:         }
                   5968:     } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
                   5969:         if (&Apache::lonnet::is_course($1,$2)) {
                   5970:             $cid = $1.'_'.$2;
                   5971:             $sec = $3;
                   5972:         }
                   5973:     }
                   5974:     if ($cid) {
1.378     raeburn  5975:         if ($env{'request.role'} !~ /^cr/) {
                   5976:             $role = &Apache::lonnet::plaintext($role,&course_type());
1.1075.2.115  raeburn  5977:         } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1075.2.121  raeburn  5978:             if ($env{'request.role.desc'}) {
                   5979:                 $role = $env{'request.role.desc'};
                   5980:             } else {
                   5981:                 $role = &mt('Helpdesk[_1]','&nbsp;'.$2);
                   5982:             }
1.1075.2.115  raeburn  5983:         } else {
                   5984:             $role = (split(/\//,$role,4))[-1];
1.378     raeburn  5985:         }
1.1075.2.158  raeburn  5986:         if ($sec) {
                   5987:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$sec;
1.898     raeburn  5988:         }   
1.1075.2.158  raeburn  5989: 	$realm = $env{'course.'.$cid.'.description'};
1.378     raeburn  5990:     } else {
                   5991:         $role = &Apache::lonnet::plaintext($role);
1.54      www      5992:     }
1.433     albertel 5993: 
1.359     albertel 5994:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 5995: 
1.438     albertel 5996:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 5997: 
1.101     www      5998: # construct main body tag
1.359     albertel 5999:     my $bodytag = "<body $extra_body_attr>".
1.1075.2.100  raeburn  6000: 	&Apache::lontexconvert::init_math_support();
1.252     albertel 6001: 
1.1075.2.38  raeburn  6002:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6003: 
                   6004:     if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60      matthew  6005:         return $bodytag;
1.1075.2.38  raeburn  6006:     }
1.359     albertel 6007: 
1.954     raeburn  6008:     if ($public) {
1.433     albertel 6009: 	undef($role);
                   6010:     }
1.1075.2.158  raeburn  6011: 
1.1075.2.161.  .1(raebu 6012:21):     my $showcrstitle = 1;
                   6013:21):     if (($cid) && ($env{'request.lti.login'})) {
                   6014:21):         if (ref($ltimenu) eq 'HASH') {
                   6015:21):             unless ($ltimenu->{'role'}) {
                   6016:21):                 undef($role);
                   6017:21):             }
                   6018:21):             unless ($ltimenu->{'coursetitle'}) {
                   6019:21):                 $realm='&nbsp;';
                   6020:21):                 $showcrstitle = 0;
                   6021:21):             }
                   6022:21):         }
                   6023:21):     } elsif (($cid) && ($menucoll)) {
                   6024:21):         if (ref($menuref) eq 'HASH') {
                   6025:21):             unless ($menuref->{'role'}) {
                   6026:21):                 undef($role);
                   6027:21):             }
                   6028:21):             unless ($menuref->{'crs'}) {
                   6029:21):                 $realm='&nbsp;';
                   6030:21):                 $showcrstitle = 0;
                   6031:21):             }
                   6032:21):         }
                   6033:21):     }
                   6034:21): 
1.762     bisitz   6035:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 6036:     #
                   6037:     # Extra info if you are the DC
                   6038:     my $dc_info = '';
1.1075.2.161.  .1(raebu 6039:21):     if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1075.2.158  raeburn  6040:         (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917     raeburn  6041:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      6042:         $dc_info =~ s/\s+$//;
1.359     albertel 6043:     }
                   6044: 
1.1075.2.161.  .1(raebu 6045:21):     my $crstype;
                   6046:21):     if ($cid) {
                   6047:21):         $crstype = $env{'course.'.$cid.'.type'};
                   6048:21):     } elsif ($args->{'crstype'}) {
                   6049:21):         $crstype = $args->{'crstype'};
                   6050:21):     }
                   6051:21): 
1.1075.2.108  raeburn  6052:     $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.903     droeschl 6053: 
1.1075.2.13  raeburn  6054:     if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   6055: 
1.1075.2.38  raeburn  6056: 
                   6057: 
1.1075.2.21  raeburn  6058:     my $funclist;
                   6059:     if (($env{'environment.remote'} eq 'on') && ($env{'request.state'} ne 'construct')) {
1.1075.2.52  raeburn  6060:         $bodytag .= Apache::lonhtmlcommon::scripttag(Apache::lonmenu::utilityfunctions($httphost), 'start')."\n".
1.1075.2.21  raeburn  6061:                     Apache::lonmenu::serverform();
                   6062:         my $forbodytag;
                   6063:         &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   6064:                                             $forcereg,$args->{'group'},
                   6065:                                             $args->{'bread_crumbs'},
1.1075.2.133  raeburn  6066:                                             $advtoolsref,'','',\$forbodytag);
1.1075.2.21  raeburn  6067:         unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   6068:             $funclist = $forbodytag;
                   6069:         }
                   6070:     } else {
1.903     droeschl 6071: 
                   6072:         #    if ($env{'request.state'} eq 'construct') {
                   6073:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   6074:         #    }
                   6075: 
1.1075.2.38  raeburn  6076:         $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  6077:             Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359     albertel 6078: 
1.1075.2.161.  .1(raebu 6079:21):         unless ($args->{'no_primary_menu'}) {
          .4(raebu 6080:22):             my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref,
          .6(raebu 6081:22):                                                               $args->{'links_disabled'},
                   6082:22):                                                               $args->{'links_target'});
          .1(raebu 6083:21):             if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
                   6084:21):                 if ($dc_info) {
                   6085:21):                     $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   6086:21):                 }
                   6087:21):                 $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
                   6088:21):                                <em>$realm</em> $dc_info</div>|;
                   6089:21):                 return $bodytag;
1.1075.2.1  raeburn  6090:             }
1.894     droeschl 6091: 
1.1075.2.161.  .1(raebu 6092:21):             unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
                   6093:21):                 $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
                   6094:21):             }
1.916     droeschl 6095: 
1.1075.2.161.  .1(raebu 6096:21):             $bodytag .= $right;
1.852     droeschl 6097: 
1.1075.2.161.  .1(raebu 6098:21):             if ($dc_info) {
                   6099:21):                 $dc_info = &dc_courseid_toggle($dc_info);
                   6100:21):             }
                   6101:21):             $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917     raeburn  6102:         }
1.916     droeschl 6103: 
1.1075.2.61  raeburn  6104:         #if directed to not display the secondary menu, don't.
                   6105:         if ($args->{'no_secondary_menu'}) {
                   6106:             return $bodytag;
                   6107:         }
1.903     droeschl 6108:         #don't show menus for public users
1.954     raeburn  6109:         if (!$public){
1.1075.2.161.  .1(raebu 6110:21):             unless ($args->{'no_inline_menu'}) {
                   6111:21):                 $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
                   6112:21):                                                             $args->{'no_primary_menu'},
                   6113:21):                                                             $menucoll,$menuref,
          .6(raebu 6114:22):                                                             $args->{'links_disabled'},
                   6115:22):                                                             $args->{'links_target'});
          .1(raebu 6116:21):             }
1.903     droeschl 6117:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  6118:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   6119:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 6120:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1075.2.161.  .8(raebu 6121:22):                                 $args->{'bread_crumbs'},'','',$hostname,
                   6122:22):                                 $ltiscope,$ltiuri,$showncrumbsref);
1.1075.2.116  raeburn  6123:             } elsif ($forcereg) {
1.1075.2.22  raeburn  6124:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1075.2.161.  .8(raebu 6125:22):                                 $args->{'group'},$args->{'hide_buttons'},
                   6126:22):                                 $hostname,$ltiscope,$ltiuri,$showncrumbsref);
1.1075.2.15  raeburn  6127:             } else {
1.1075.2.21  raeburn  6128:                 my $forbodytag;
                   6129:                 &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   6130:                                                     $forcereg,$args->{'group'},
                   6131:                                                     $args->{'bread_crumbs'},
1.1075.2.133  raeburn  6132:                                                     $advtoolsref,'',$hostname,
                   6133:                                                     \$forbodytag);
1.1075.2.21  raeburn  6134:                 unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   6135:                     $bodytag .= $forbodytag;
                   6136:                 }
1.920     raeburn  6137:             }
1.903     droeschl 6138:         }else{
                   6139:             # this is to seperate menu from content when there's no secondary
                   6140:             # menu. Especially needed for public accessible ressources.
                   6141:             $bodytag .= '<hr style="clear:both" />';
                   6142:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  6143:         }
1.903     droeschl 6144: 
1.235     raeburn  6145:         return $bodytag;
1.1075.2.12  raeburn  6146:     }
                   6147: 
                   6148: #
                   6149: # Top frame rendering, Remote is up
                   6150: #
                   6151: 
                   6152:     my $imgsrc = $img;
                   6153:     if ($img =~ /^\/adm/) {
                   6154:         $imgsrc = &lonhttpdurl($img);
                   6155:     }
                   6156:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
                   6157: 
1.1075.2.60  raeburn  6158:     my $help=($no_inline_link?''
                   6159:               :&Apache::loncommon::top_nav_help('Help'));
                   6160: 
1.1075.2.12  raeburn  6161:     # Explicit link to get inline menu
                   6162:     my $menu= ($no_inline_link?''
                   6163:                :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
                   6164: 
                   6165:     if ($dc_info) {
                   6166:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   6167:     }
                   6168: 
1.1075.2.38  raeburn  6169:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
                   6170:     unless ($public) {
                   6171:         $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
                   6172:                                 undef,'LC_menubuttons_link');
                   6173:     }
                   6174: 
1.1075.2.12  raeburn  6175:     unless ($env{'form.inhibitmenu'}) {
                   6176:         $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.1075.2.38  raeburn  6177:                        <ol class="LC_primary_menu LC_floatright LC_right">
1.1075.2.60  raeburn  6178:                        <li>$help</li>
1.1075.2.12  raeburn  6179:                        <li>$menu</li>
                   6180:                        </ol><div id="LC_realm"> $realm $dc_info</div>|;
                   6181:     }
1.1075.2.13  raeburn  6182:     if ($env{'request.state'} eq 'construct') {
                   6183:         if (!$public){
                   6184:             if ($env{'request.state'} eq 'construct') {
                   6185:                 $funclist = &Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  6186:                                 &Apache::lonmenu::utilityfunctions($httphost), 'start').
1.1075.2.13  raeburn  6187:                             &Apache::lonhtmlcommon::scripttag('','end').
                   6188:                             &Apache::lonmenu::innerregister($forcereg,
                   6189:                                                             $args->{'bread_crumbs'});
                   6190:             }
                   6191:         }
                   6192:     }
1.1075.2.21  raeburn  6193:     return $bodytag."\n".$funclist;
1.182     matthew  6194: }
                   6195: 
1.917     raeburn  6196: sub dc_courseid_toggle {
                   6197:     my ($dc_info) = @_;
1.980     raeburn  6198:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  6199:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  6200:            &mt('(More ...)').'</a></span>'.
                   6201:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   6202: }
                   6203: 
1.330     albertel 6204: sub make_attr_string {
                   6205:     my ($register,$attr_ref) = @_;
                   6206: 
                   6207:     if ($attr_ref && !ref($attr_ref)) {
                   6208: 	die("addentries Must be a hash ref ".
                   6209: 	    join(':',caller(1))." ".
                   6210: 	    join(':',caller(0))." ");
                   6211:     }
                   6212: 
                   6213:     if ($register) {
1.339     albertel 6214: 	my ($on_load,$on_unload);
                   6215: 	foreach my $key (keys(%{$attr_ref})) {
                   6216: 	    if      (lc($key) eq 'onload') {
                   6217: 		$on_load.=$attr_ref->{$key}.';';
                   6218: 		delete($attr_ref->{$key});
                   6219: 
                   6220: 	    } elsif (lc($key) eq 'onunload') {
                   6221: 		$on_unload.=$attr_ref->{$key}.';';
                   6222: 		delete($attr_ref->{$key});
                   6223: 	    }
                   6224: 	}
1.1075.2.12  raeburn  6225:         if ($env{'environment.remote'} eq 'on') {
                   6226:             $attr_ref->{'onload'}  =
                   6227:                 &Apache::lonmenu::loadevents().  $on_load;
                   6228:             $attr_ref->{'onunload'}=
                   6229:                 &Apache::lonmenu::unloadevents().$on_unload;
                   6230:         } else {  
                   6231: 	    $attr_ref->{'onload'}  = $on_load;
                   6232: 	    $attr_ref->{'onunload'}= $on_unload;
                   6233:         }
1.330     albertel 6234:     }
1.339     albertel 6235: 
1.330     albertel 6236:     my $attr_string;
1.1075.2.56  raeburn  6237:     foreach my $attr (sort(keys(%$attr_ref))) {
1.330     albertel 6238: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   6239:     }
                   6240:     return $attr_string;
                   6241: }
                   6242: 
                   6243: 
1.182     matthew  6244: ###############################################
1.251     albertel 6245: ###############################################
                   6246: 
                   6247: =pod
                   6248: 
                   6249: =item * &endbodytag()
                   6250: 
                   6251: Returns a uniform footer for LON-CAPA web pages.
                   6252: 
1.635     raeburn  6253: Inputs: 1 - optional reference to an args hash
                   6254: If in the hash, key for noredirectlink has a value which evaluates to true,
                   6255: a 'Continue' link is not displayed if the page contains an
                   6256: internal redirect in the <head></head> section,
                   6257: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 6258: 
                   6259: =cut
                   6260: 
                   6261: sub endbodytag {
1.635     raeburn  6262:     my ($args) = @_;
1.1075.2.6  raeburn  6263:     my $endbodytag;
                   6264:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   6265:         $endbodytag='</body>';
                   6266:     }
1.315     albertel 6267:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  6268:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
1.1075.2.161.  .9(raebu 6269:22):             my ($endbodyjs,$idattr);
                   6270:22):             if ($env{'internal.head.to_opener'}) {
                   6271:22):                 my $linkid = 'LC_continue_link';
                   6272:22):                 $idattr = ' id="'.$linkid.'"';
                   6273:22):                 my $redirect_for_js = &js_escape($env{'internal.head.redirect'});
                   6274:22):                 $endbodyjs=<<ENDJS;
                   6275:22): <script type="text/javascript">
                   6276:22): // <![CDATA[
                   6277:22): function ebFunction(evt) {
                   6278:22):     evt.preventDefault();
                   6279:22):     var dest = '$redirect_for_js';
                   6280:22):     if (window.opener != null && !window.opener.closed) {
                   6281:22):         window.opener.location.href=dest;
                   6282:22):         window.close();
                   6283:22):     } else {
                   6284:22):         window.location.href=dest;
                   6285:22):     }
                   6286:22):     return false;
                   6287:22): }
                   6288:22): 
                   6289:22): \$(document).ready(function () {
                   6290:22):   if (document.getElementById('$linkid')) {
                   6291:22):     var clickelem = document.getElementById('$linkid');
                   6292:22):     clickelem.addEventListener('click',ebFunction,false);
                   6293:22):   }
                   6294:22): });
                   6295:22): // ]]>
                   6296:22): </script>
                   6297:22): ENDJS
                   6298:22):             }
1.635     raeburn  6299: 	    $endbodytag=
1.1075.2.161.  .9(raebu 6300:22): 	        "$endbodyjs<br /><a href=\"$env{'internal.head.redirect'}\"$idattr>".
1.635     raeburn  6301: 	        &mt('Continue').'</a>'.
                   6302: 	        $endbodytag;
                   6303:         }
1.315     albertel 6304:     }
1.251     albertel 6305:     return $endbodytag;
                   6306: }
                   6307: 
1.352     albertel 6308: =pod
                   6309: 
                   6310: =item * &standard_css()
                   6311: 
                   6312: Returns a style sheet
                   6313: 
                   6314: Inputs: (all optional)
                   6315:             domain         -> force to color decorate a page for a specific
                   6316:                                domain
                   6317:             function       -> force usage of a specific rolish color scheme
                   6318:             bgcolor        -> override the default page bgcolor
                   6319: 
                   6320: =cut
                   6321: 
1.343     albertel 6322: sub standard_css {
1.345     albertel 6323:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 6324:     $function  = &get_users_function() if (!$function);
                   6325:     my $img    = &designparm($function.'.img',   $domain);
                   6326:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   6327:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 6328:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 6329: #second colour for later usage
1.345     albertel 6330:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 6331:     my $pgbg_or_bgcolor =
                   6332: 	         $bgcolor ||
1.352     albertel 6333: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 6334:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 6335:     my $alink  = &designparm($function.'.alink', $domain);
                   6336:     my $vlink  = &designparm($function.'.vlink', $domain);
                   6337:     my $link   = &designparm($function.'.link',  $domain);
                   6338: 
1.602     albertel 6339:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 6340:     my $mono                 = 'monospace';
1.850     bisitz   6341:     my $data_table_head      = $sidebg;
                   6342:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   6343:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 6344:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 6345:     my $data_table_highlight = '#FFFF00';
1.352     albertel 6346:     my $mail_new             = '#FFBB77';
                   6347:     my $mail_new_hover       = '#DD9955';
                   6348:     my $mail_read            = '#BBBB77';
                   6349:     my $mail_read_hover      = '#999944';
                   6350:     my $mail_replied         = '#AAAA88';
                   6351:     my $mail_replied_hover   = '#888855';
                   6352:     my $mail_other           = '#99BBBB';
                   6353:     my $mail_other_hover     = '#669999';
1.391     albertel 6354:     my $table_header         = '#DDDDDD';
1.489     raeburn  6355:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   6356:     my $lg_border_color      = '#C8C8C8';
1.952     onken    6357:     my $button_hover         = '#BF2317';
1.392     albertel 6358: 
1.608     albertel 6359:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   6360:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   6361:                                              : '0 3px 0 4px';
1.448     albertel 6362: 
1.523     albertel 6363: 
1.343     albertel 6364:     return <<END;
1.947     droeschl 6365: 
                   6366: /* needed for iframe to allow 100% height in FF */
                   6367: body, html { 
                   6368:     margin: 0;
                   6369:     padding: 0 0.5%;
                   6370:     height: 99%; /* to avoid scrollbars */
                   6371: }
                   6372: 
1.795     www      6373: body {
1.911     bisitz   6374:   font-family: $sans;
                   6375:   line-height:130%;
                   6376:   font-size:0.83em;
                   6377:   color:$font;
1.795     www      6378: }
                   6379: 
1.959     onken    6380: a:focus,
                   6381: a:focus img {
1.795     www      6382:   color: red;
                   6383: }
1.698     harmsja  6384: 
1.911     bisitz   6385: form, .inline {
                   6386:   display: inline;
1.795     www      6387: }
1.721     harmsja  6388: 
1.795     www      6389: .LC_right {
1.911     bisitz   6390:   text-align:right;
1.795     www      6391: }
                   6392: 
                   6393: .LC_middle {
1.911     bisitz   6394:   vertical-align:middle;
1.795     www      6395: }
1.721     harmsja  6396: 
1.1075.2.38  raeburn  6397: .LC_floatleft {
                   6398:   float: left;
                   6399: }
                   6400: 
                   6401: .LC_floatright {
                   6402:   float: right;
                   6403: }
                   6404: 
1.911     bisitz   6405: .LC_400Box {
                   6406:   width:400px;
                   6407: }
1.721     harmsja  6408: 
1.947     droeschl 6409: .LC_iframecontainer {
                   6410:     width: 98%;
                   6411:     margin: 0;
                   6412:     position: fixed;
                   6413:     top: 8.5em;
                   6414:     bottom: 0;
                   6415: }
                   6416: 
                   6417: .LC_iframecontainer iframe{
                   6418:     border: none;
                   6419:     width: 100%;
                   6420:     height: 100%;
                   6421: }
                   6422: 
1.778     bisitz   6423: .LC_filename {
                   6424:   font-family: $mono;
                   6425:   white-space:pre;
1.921     bisitz   6426:   font-size: 120%;
1.778     bisitz   6427: }
                   6428: 
                   6429: .LC_fileicon {
                   6430:   border: none;
                   6431:   height: 1.3em;
                   6432:   vertical-align: text-bottom;
                   6433:   margin-right: 0.3em;
                   6434:   text-decoration:none;
                   6435: }
                   6436: 
1.1008    www      6437: .LC_setting {
                   6438:   text-decoration:underline;
                   6439: }
                   6440: 
1.350     albertel 6441: .LC_error {
                   6442:   color: red;
                   6443: }
1.795     www      6444: 
1.1075.2.15  raeburn  6445: .LC_warning {
                   6446:   color: darkorange;
                   6447: }
                   6448: 
1.457     albertel 6449: .LC_diff_removed {
1.733     bisitz   6450:   color: red;
1.394     albertel 6451: }
1.532     albertel 6452: 
                   6453: .LC_info,
1.457     albertel 6454: .LC_success,
                   6455: .LC_diff_added {
1.350     albertel 6456:   color: green;
                   6457: }
1.795     www      6458: 
1.802     bisitz   6459: div.LC_confirm_box {
                   6460:   background-color: #FAFAFA;
                   6461:   border: 1px solid $lg_border_color;
                   6462:   margin-right: 0;
                   6463:   padding: 5px;
                   6464: }
                   6465: 
                   6466: div.LC_confirm_box .LC_error img,
                   6467: div.LC_confirm_box .LC_success img {
                   6468:   vertical-align: middle;
                   6469: }
                   6470: 
1.1075.2.108  raeburn  6471: .LC_maxwidth {
                   6472:   max-width: 100%;
                   6473:   height: auto;
                   6474: }
                   6475: 
                   6476: .LC_textsize_mobile {
                   6477:   \@media only screen and (max-device-width: 480px) {
                   6478:       -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
                   6479:   }
                   6480: }
                   6481: 
1.440     albertel 6482: .LC_icon {
1.771     droeschl 6483:   border: none;
1.790     droeschl 6484:   vertical-align: middle;
1.771     droeschl 6485: }
                   6486: 
1.543     albertel 6487: .LC_docs_spacer {
                   6488:   width: 25px;
                   6489:   height: 1px;
1.771     droeschl 6490:   border: none;
1.543     albertel 6491: }
1.346     albertel 6492: 
1.532     albertel 6493: .LC_internal_info {
1.735     bisitz   6494:   color: #999999;
1.532     albertel 6495: }
                   6496: 
1.794     www      6497: .LC_discussion {
1.1050    www      6498:   background: $data_table_dark;
1.911     bisitz   6499:   border: 1px solid black;
                   6500:   margin: 2px;
1.794     www      6501: }
                   6502: 
                   6503: .LC_disc_action_left {
1.1050    www      6504:   background: $sidebg;
1.911     bisitz   6505:   text-align: left;
1.1050    www      6506:   padding: 4px;
                   6507:   margin: 2px;
1.794     www      6508: }
                   6509: 
                   6510: .LC_disc_action_right {
1.1050    www      6511:   background: $sidebg;
1.911     bisitz   6512:   text-align: right;
1.1050    www      6513:   padding: 4px;
                   6514:   margin: 2px;
1.794     www      6515: }
                   6516: 
                   6517: .LC_disc_new_item {
1.911     bisitz   6518:   background: white;
                   6519:   border: 2px solid red;
1.1050    www      6520:   margin: 4px;
                   6521:   padding: 4px;
1.794     www      6522: }
                   6523: 
                   6524: .LC_disc_old_item {
1.911     bisitz   6525:   background: white;
1.1050    www      6526:   margin: 4px;
                   6527:   padding: 4px;
1.794     www      6528: }
                   6529: 
1.458     albertel 6530: table.LC_pastsubmission {
                   6531:   border: 1px solid black;
                   6532:   margin: 2px;
                   6533: }
                   6534: 
1.924     bisitz   6535: table#LC_menubuttons {
1.345     albertel 6536:   width: 100%;
                   6537:   background: $pgbg;
1.392     albertel 6538:   border: 2px;
1.402     albertel 6539:   border-collapse: separate;
1.803     bisitz   6540:   padding: 0;
1.345     albertel 6541: }
1.392     albertel 6542: 
1.801     tempelho 6543: table#LC_title_bar a {
                   6544:   color: $fontmenu;
                   6545: }
1.836     bisitz   6546: 
1.807     droeschl 6547: table#LC_title_bar {
1.819     tempelho 6548:   clear: both;
1.836     bisitz   6549:   display: none;
1.807     droeschl 6550: }
                   6551: 
1.795     www      6552: table#LC_title_bar,
1.933     droeschl 6553: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 6554: table#LC_title_bar.LC_with_remote {
1.359     albertel 6555:   width: 100%;
1.392     albertel 6556:   border-color: $pgbg;
                   6557:   border-style: solid;
                   6558:   border-width: $border;
1.379     albertel 6559:   background: $pgbg;
1.801     tempelho 6560:   color: $fontmenu;
1.392     albertel 6561:   border-collapse: collapse;
1.803     bisitz   6562:   padding: 0;
1.819     tempelho 6563:   margin: 0;
1.359     albertel 6564: }
1.795     www      6565: 
1.933     droeschl 6566: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 6567:     margin: 0;
                   6568:     padding: 0;
1.933     droeschl 6569:     position: relative;
                   6570:     list-style: none;
1.913     droeschl 6571: }
1.933     droeschl 6572: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 6573:     display: inline;
                   6574: }
1.933     droeschl 6575: 
                   6576: .LC_breadcrumb_tools_navigation {
1.913     droeschl 6577:     padding: 0;
1.933     droeschl 6578:     margin: 0;
                   6579:     float: left;
1.913     droeschl 6580: }
1.933     droeschl 6581: .LC_breadcrumb_tools_tools {
                   6582:     padding: 0;
                   6583:     margin: 0;
1.913     droeschl 6584:     float: right;
                   6585: }
                   6586: 
1.359     albertel 6587: table#LC_title_bar td {
                   6588:   background: $tabbg;
                   6589: }
1.795     www      6590: 
1.911     bisitz   6591: table#LC_menubuttons img {
1.803     bisitz   6592:   border: none;
1.346     albertel 6593: }
1.795     www      6594: 
1.842     droeschl 6595: .LC_breadcrumbs_component {
1.911     bisitz   6596:   float: right;
                   6597:   margin: 0 1em;
1.357     albertel 6598: }
1.842     droeschl 6599: .LC_breadcrumbs_component img {
1.911     bisitz   6600:   vertical-align: middle;
1.777     tempelho 6601: }
1.795     www      6602: 
1.1075.2.108  raeburn  6603: .LC_breadcrumbs_hoverable {
                   6604:   background: $sidebg;
                   6605: }
                   6606: 
1.383     albertel 6607: td.LC_table_cell_checkbox {
                   6608:   text-align: center;
                   6609: }
1.795     www      6610: 
                   6611: .LC_fontsize_small {
1.911     bisitz   6612:   font-size: 70%;
1.705     tempelho 6613: }
                   6614: 
1.844     bisitz   6615: #LC_breadcrumbs {
1.911     bisitz   6616:   clear:both;
                   6617:   background: $sidebg;
                   6618:   border-bottom: 1px solid $lg_border_color;
                   6619:   line-height: 2.5em;
1.933     droeschl 6620:   overflow: hidden;
1.911     bisitz   6621:   margin: 0;
                   6622:   padding: 0;
1.995     raeburn  6623:   text-align: left;
1.819     tempelho 6624: }
1.862     bisitz   6625: 
1.1075.2.16  raeburn  6626: .LC_head_subbox, .LC_actionbox {
1.911     bisitz   6627:   clear:both;
                   6628:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 6629:   border: 1px solid $sidebg;
1.1075.2.16  raeburn  6630:   margin: 0 0 10px 0;
1.966     bisitz   6631:   padding: 3px;
1.995     raeburn  6632:   text-align: left;
1.822     bisitz   6633: }
                   6634: 
1.795     www      6635: .LC_fontsize_medium {
1.911     bisitz   6636:   font-size: 85%;
1.705     tempelho 6637: }
                   6638: 
1.795     www      6639: .LC_fontsize_large {
1.911     bisitz   6640:   font-size: 120%;
1.705     tempelho 6641: }
                   6642: 
1.346     albertel 6643: .LC_menubuttons_inline_text {
                   6644:   color: $font;
1.698     harmsja  6645:   font-size: 90%;
1.701     harmsja  6646:   padding-left:3px;
1.346     albertel 6647: }
                   6648: 
1.934     droeschl 6649: .LC_menubuttons_inline_text img{
                   6650:   vertical-align: middle;
                   6651: }
                   6652: 
1.1051    www      6653: li.LC_menubuttons_inline_text img {
1.951     onken    6654:   cursor:pointer;
1.1002    droeschl 6655:   text-decoration: none;
1.951     onken    6656: }
                   6657: 
1.526     www      6658: .LC_menubuttons_link {
                   6659:   text-decoration: none;
                   6660: }
1.795     www      6661: 
1.522     albertel 6662: .LC_menubuttons_category {
1.521     www      6663:   color: $font;
1.526     www      6664:   background: $pgbg;
1.521     www      6665:   font-size: larger;
                   6666:   font-weight: bold;
                   6667: }
                   6668: 
1.346     albertel 6669: td.LC_menubuttons_text {
1.911     bisitz   6670:   color: $font;
1.346     albertel 6671: }
1.706     harmsja  6672: 
1.346     albertel 6673: .LC_current_location {
                   6674:   background: $tabbg;
                   6675: }
1.795     www      6676: 
1.1075.2.134  raeburn  6677: td.LC_zero_height {
                   6678:   line-height: 0;
                   6679:   cellpadding: 0;
                   6680: }
                   6681: 
1.938     bisitz   6682: table.LC_data_table {
1.347     albertel 6683:   border: 1px solid #000000;
1.402     albertel 6684:   border-collapse: separate;
1.426     albertel 6685:   border-spacing: 1px;
1.610     albertel 6686:   background: $pgbg;
1.347     albertel 6687: }
1.795     www      6688: 
1.422     albertel 6689: .LC_data_table_dense {
                   6690:   font-size: small;
                   6691: }
1.795     www      6692: 
1.507     raeburn  6693: table.LC_nested_outer {
                   6694:   border: 1px solid #000000;
1.589     raeburn  6695:   border-collapse: collapse;
1.803     bisitz   6696:   border-spacing: 0;
1.507     raeburn  6697:   width: 100%;
                   6698: }
1.795     www      6699: 
1.879     raeburn  6700: table.LC_innerpickbox,
1.507     raeburn  6701: table.LC_nested {
1.803     bisitz   6702:   border: none;
1.589     raeburn  6703:   border-collapse: collapse;
1.803     bisitz   6704:   border-spacing: 0;
1.507     raeburn  6705:   width: 100%;
                   6706: }
1.795     www      6707: 
1.911     bisitz   6708: table.LC_data_table tr th,
                   6709: table.LC_calendar tr th,
1.879     raeburn  6710: table.LC_prior_tries tr th,
                   6711: table.LC_innerpickbox tr th {
1.349     albertel 6712:   font-weight: bold;
                   6713:   background-color: $data_table_head;
1.801     tempelho 6714:   color:$fontmenu;
1.701     harmsja  6715:   font-size:90%;
1.347     albertel 6716: }
1.795     www      6717: 
1.879     raeburn  6718: table.LC_innerpickbox tr th,
                   6719: table.LC_innerpickbox tr td {
                   6720:   vertical-align: top;
                   6721: }
                   6722: 
1.711     raeburn  6723: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   6724:   background-color: #CCCCCC;
1.711     raeburn  6725:   font-weight: bold;
                   6726:   text-align: left;
                   6727: }
1.795     www      6728: 
1.912     bisitz   6729: table.LC_data_table tr.LC_odd_row > td {
                   6730:   background-color: $data_table_light;
                   6731:   padding: 2px;
                   6732:   vertical-align: top;
                   6733: }
                   6734: 
1.809     bisitz   6735: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 6736:   background-color: $data_table_light;
1.912     bisitz   6737:   vertical-align: top;
                   6738: }
                   6739: 
                   6740: table.LC_data_table tr.LC_even_row > td {
                   6741:   background-color: $data_table_dark;
1.425     albertel 6742:   padding: 2px;
1.900     bisitz   6743:   vertical-align: top;
1.347     albertel 6744: }
1.795     www      6745: 
1.809     bisitz   6746: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 6747:   background-color: $data_table_dark;
1.900     bisitz   6748:   vertical-align: top;
1.347     albertel 6749: }
1.795     www      6750: 
1.425     albertel 6751: table.LC_data_table tr.LC_data_table_highlight td {
                   6752:   background-color: $data_table_darker;
                   6753: }
1.795     www      6754: 
1.639     raeburn  6755: table.LC_data_table tr td.LC_leftcol_header {
                   6756:   background-color: $data_table_head;
                   6757:   font-weight: bold;
                   6758: }
1.795     www      6759: 
1.451     albertel 6760: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  6761: table.LC_nested tr.LC_empty_row td {
1.421     albertel 6762:   font-weight: bold;
                   6763:   font-style: italic;
                   6764:   text-align: center;
                   6765:   padding: 8px;
1.347     albertel 6766: }
1.795     www      6767: 
1.1075.2.30  raeburn  6768: table.LC_data_table tr.LC_empty_row td,
                   6769: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   6770:   background-color: $sidebg;
                   6771: }
                   6772: 
                   6773: table.LC_nested tr.LC_empty_row td {
                   6774:   background-color: #FFFFFF;
                   6775: }
                   6776: 
1.890     droeschl 6777: table.LC_caption {
                   6778: }
                   6779: 
1.507     raeburn  6780: table.LC_nested tr.LC_empty_row td {
1.465     albertel 6781:   padding: 4ex
                   6782: }
1.795     www      6783: 
1.507     raeburn  6784: table.LC_nested_outer tr th {
                   6785:   font-weight: bold;
1.801     tempelho 6786:   color:$fontmenu;
1.507     raeburn  6787:   background-color: $data_table_head;
1.701     harmsja  6788:   font-size: small;
1.507     raeburn  6789:   border-bottom: 1px solid #000000;
                   6790: }
1.795     www      6791: 
1.507     raeburn  6792: table.LC_nested_outer tr td.LC_subheader {
                   6793:   background-color: $data_table_head;
                   6794:   font-weight: bold;
                   6795:   font-size: small;
                   6796:   border-bottom: 1px solid #000000;
                   6797:   text-align: right;
1.451     albertel 6798: }
1.795     www      6799: 
1.507     raeburn  6800: table.LC_nested tr.LC_info_row td {
1.735     bisitz   6801:   background-color: #CCCCCC;
1.451     albertel 6802:   font-weight: bold;
                   6803:   font-size: small;
1.507     raeburn  6804:   text-align: center;
                   6805: }
1.795     www      6806: 
1.589     raeburn  6807: table.LC_nested tr.LC_info_row td.LC_left_item,
                   6808: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  6809:   text-align: left;
1.451     albertel 6810: }
1.795     www      6811: 
1.507     raeburn  6812: table.LC_nested td {
1.735     bisitz   6813:   background-color: #FFFFFF;
1.451     albertel 6814:   font-size: small;
1.507     raeburn  6815: }
1.795     www      6816: 
1.507     raeburn  6817: table.LC_nested_outer tr th.LC_right_item,
                   6818: table.LC_nested tr.LC_info_row td.LC_right_item,
                   6819: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   6820: table.LC_nested tr td.LC_right_item {
1.451     albertel 6821:   text-align: right;
                   6822: }
                   6823: 
1.507     raeburn  6824: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   6825:   background-color: #EEEEEE;
1.451     albertel 6826: }
                   6827: 
1.473     raeburn  6828: table.LC_createuser {
                   6829: }
                   6830: 
                   6831: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  6832:   font-size: small;
1.473     raeburn  6833: }
                   6834: 
                   6835: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   6836:   background-color: #CCCCCC;
1.473     raeburn  6837:   font-weight: bold;
                   6838:   text-align: center;
                   6839: }
                   6840: 
1.349     albertel 6841: table.LC_calendar {
                   6842:   border: 1px solid #000000;
                   6843:   border-collapse: collapse;
1.917     raeburn  6844:   width: 98%;
1.349     albertel 6845: }
1.795     www      6846: 
1.349     albertel 6847: table.LC_calendar_pickdate {
                   6848:   font-size: xx-small;
                   6849: }
1.795     www      6850: 
1.349     albertel 6851: table.LC_calendar tr td {
                   6852:   border: 1px solid #000000;
                   6853:   vertical-align: top;
1.917     raeburn  6854:   width: 14%;
1.349     albertel 6855: }
1.795     www      6856: 
1.349     albertel 6857: table.LC_calendar tr td.LC_calendar_day_empty {
                   6858:   background-color: $data_table_dark;
                   6859: }
1.795     www      6860: 
1.779     bisitz   6861: table.LC_calendar tr td.LC_calendar_day_current {
                   6862:   background-color: $data_table_highlight;
1.777     tempelho 6863: }
1.795     www      6864: 
1.938     bisitz   6865: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 6866:   background-color: $mail_new;
                   6867: }
1.795     www      6868: 
1.938     bisitz   6869: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 6870:   background-color: $mail_new_hover;
                   6871: }
1.795     www      6872: 
1.938     bisitz   6873: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 6874:   background-color: $mail_read;
                   6875: }
1.795     www      6876: 
1.938     bisitz   6877: /*
                   6878: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 6879:   background-color: $mail_read_hover;
                   6880: }
1.938     bisitz   6881: */
1.795     www      6882: 
1.938     bisitz   6883: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 6884:   background-color: $mail_replied;
                   6885: }
1.795     www      6886: 
1.938     bisitz   6887: /*
                   6888: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 6889:   background-color: $mail_replied_hover;
                   6890: }
1.938     bisitz   6891: */
1.795     www      6892: 
1.938     bisitz   6893: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 6894:   background-color: $mail_other;
                   6895: }
1.795     www      6896: 
1.938     bisitz   6897: /*
                   6898: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 6899:   background-color: $mail_other_hover;
                   6900: }
1.938     bisitz   6901: */
1.494     raeburn  6902: 
1.777     tempelho 6903: table.LC_data_table tr > td.LC_browser_file,
                   6904: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   6905:   background: #AAEE77;
1.389     albertel 6906: }
1.795     www      6907: 
1.777     tempelho 6908: table.LC_data_table tr > td.LC_browser_file_locked,
                   6909: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 6910:   background: #FFAA99;
1.387     albertel 6911: }
1.795     www      6912: 
1.777     tempelho 6913: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   6914:   background: #888888;
1.779     bisitz   6915: }
1.795     www      6916: 
1.777     tempelho 6917: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   6918: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   6919:   background: #F8F866;
1.777     tempelho 6920: }
1.795     www      6921: 
1.696     bisitz   6922: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   6923:   background: #E0E8FF;
1.387     albertel 6924: }
1.696     bisitz   6925: 
1.707     bisitz   6926: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   6927:   /* background: #77FF77; */
1.707     bisitz   6928: }
1.795     www      6929: 
1.707     bisitz   6930: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   6931:   border-right: 8px solid #FFFF77;
1.707     bisitz   6932: }
1.795     www      6933: 
1.707     bisitz   6934: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   6935:   border-right: 8px solid #FFAA77;
1.707     bisitz   6936: }
1.795     www      6937: 
1.707     bisitz   6938: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   6939:   border-right: 8px solid #FF7777;
1.707     bisitz   6940: }
1.795     www      6941: 
1.707     bisitz   6942: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   6943:   border-right: 8px solid #AAFF77;
1.707     bisitz   6944: }
1.795     www      6945: 
1.707     bisitz   6946: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   6947:   border-right: 8px solid #11CC55;
1.707     bisitz   6948: }
                   6949: 
1.388     albertel 6950: span.LC_current_location {
1.701     harmsja  6951:   font-size:larger;
1.388     albertel 6952:   background: $pgbg;
                   6953: }
1.387     albertel 6954: 
1.1029    www      6955: span.LC_current_nav_location {
                   6956:   font-weight:bold;
                   6957:   background: $sidebg;
                   6958: }
                   6959: 
1.395     albertel 6960: span.LC_parm_menu_item {
                   6961:   font-size: larger;
                   6962: }
1.795     www      6963: 
1.395     albertel 6964: span.LC_parm_scope_all {
                   6965:   color: red;
                   6966: }
1.795     www      6967: 
1.395     albertel 6968: span.LC_parm_scope_folder {
                   6969:   color: green;
                   6970: }
1.795     www      6971: 
1.395     albertel 6972: span.LC_parm_scope_resource {
                   6973:   color: orange;
                   6974: }
1.795     www      6975: 
1.395     albertel 6976: span.LC_parm_part {
                   6977:   color: blue;
                   6978: }
1.795     www      6979: 
1.911     bisitz   6980: span.LC_parm_folder,
                   6981: span.LC_parm_symb {
1.395     albertel 6982:   font-size: x-small;
                   6983:   font-family: $mono;
                   6984:   color: #AAAAAA;
                   6985: }
                   6986: 
1.977     bisitz   6987: ul.LC_parm_parmlist li {
                   6988:   display: inline-block;
                   6989:   padding: 0.3em 0.8em;
                   6990:   vertical-align: top;
                   6991:   width: 150px;
                   6992:   border-top:1px solid $lg_border_color;
                   6993: }
                   6994: 
1.795     www      6995: td.LC_parm_overview_level_menu,
                   6996: td.LC_parm_overview_map_menu,
                   6997: td.LC_parm_overview_parm_selectors,
                   6998: td.LC_parm_overview_restrictions  {
1.396     albertel 6999:   border: 1px solid black;
                   7000:   border-collapse: collapse;
                   7001: }
1.795     www      7002: 
1.396     albertel 7003: table.LC_parm_overview_restrictions td {
                   7004:   border-width: 1px 4px 1px 4px;
                   7005:   border-style: solid;
                   7006:   border-color: $pgbg;
                   7007:   text-align: center;
                   7008: }
1.795     www      7009: 
1.396     albertel 7010: table.LC_parm_overview_restrictions th {
                   7011:   background: $tabbg;
                   7012:   border-width: 1px 4px 1px 4px;
                   7013:   border-style: solid;
                   7014:   border-color: $pgbg;
                   7015: }
1.795     www      7016: 
1.398     albertel 7017: table#LC_helpmenu {
1.803     bisitz   7018:   border: none;
1.398     albertel 7019:   height: 55px;
1.803     bisitz   7020:   border-spacing: 0;
1.398     albertel 7021: }
                   7022: 
                   7023: table#LC_helpmenu fieldset legend {
                   7024:   font-size: larger;
                   7025: }
1.795     www      7026: 
1.397     albertel 7027: table#LC_helpmenu_links {
                   7028:   width: 100%;
                   7029:   border: 1px solid black;
                   7030:   background: $pgbg;
1.803     bisitz   7031:   padding: 0;
1.397     albertel 7032:   border-spacing: 1px;
                   7033: }
1.795     www      7034: 
1.397     albertel 7035: table#LC_helpmenu_links tr td {
                   7036:   padding: 1px;
                   7037:   background: $tabbg;
1.399     albertel 7038:   text-align: center;
                   7039:   font-weight: bold;
1.397     albertel 7040: }
1.396     albertel 7041: 
1.795     www      7042: table#LC_helpmenu_links a:link,
                   7043: table#LC_helpmenu_links a:visited,
1.397     albertel 7044: table#LC_helpmenu_links a:active {
                   7045:   text-decoration: none;
                   7046:   color: $font;
                   7047: }
1.795     www      7048: 
1.397     albertel 7049: table#LC_helpmenu_links a:hover {
                   7050:   text-decoration: underline;
                   7051:   color: $vlink;
                   7052: }
1.396     albertel 7053: 
1.417     albertel 7054: .LC_chrt_popup_exists {
                   7055:   border: 1px solid #339933;
                   7056:   margin: -1px;
                   7057: }
1.795     www      7058: 
1.417     albertel 7059: .LC_chrt_popup_up {
                   7060:   border: 1px solid yellow;
                   7061:   margin: -1px;
                   7062: }
1.795     www      7063: 
1.417     albertel 7064: .LC_chrt_popup {
                   7065:   border: 1px solid #8888FF;
                   7066:   background: #CCCCFF;
                   7067: }
1.795     www      7068: 
1.421     albertel 7069: table.LC_pick_box {
                   7070:   border-collapse: separate;
                   7071:   background: white;
                   7072:   border: 1px solid black;
                   7073:   border-spacing: 1px;
                   7074: }
1.795     www      7075: 
1.421     albertel 7076: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   7077:   background: $sidebg;
1.421     albertel 7078:   font-weight: bold;
1.900     bisitz   7079:   text-align: left;
1.740     bisitz   7080:   vertical-align: top;
1.421     albertel 7081:   width: 184px;
                   7082:   padding: 8px;
                   7083: }
1.795     www      7084: 
1.579     raeburn  7085: table.LC_pick_box td.LC_pick_box_value {
                   7086:   text-align: left;
                   7087:   padding: 8px;
                   7088: }
1.795     www      7089: 
1.579     raeburn  7090: table.LC_pick_box td.LC_pick_box_select {
                   7091:   text-align: left;
                   7092:   padding: 8px;
                   7093: }
1.795     www      7094: 
1.424     albertel 7095: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   7096:   padding: 0;
1.421     albertel 7097:   height: 1px;
                   7098:   background: black;
                   7099: }
1.795     www      7100: 
1.421     albertel 7101: table.LC_pick_box td.LC_pick_box_submit {
                   7102:   text-align: right;
                   7103: }
1.795     www      7104: 
1.579     raeburn  7105: table.LC_pick_box td.LC_evenrow_value {
                   7106:   text-align: left;
                   7107:   padding: 8px;
                   7108:   background-color: $data_table_light;
                   7109: }
1.795     www      7110: 
1.579     raeburn  7111: table.LC_pick_box td.LC_oddrow_value {
                   7112:   text-align: left;
                   7113:   padding: 8px;
                   7114:   background-color: $data_table_light;
                   7115: }
1.795     www      7116: 
1.579     raeburn  7117: span.LC_helpform_receipt_cat {
                   7118:   font-weight: bold;
                   7119: }
1.795     www      7120: 
1.424     albertel 7121: table.LC_group_priv_box {
                   7122:   background: white;
                   7123:   border: 1px solid black;
                   7124:   border-spacing: 1px;
                   7125: }
1.795     www      7126: 
1.424     albertel 7127: table.LC_group_priv_box td.LC_pick_box_title {
                   7128:   background: $tabbg;
                   7129:   font-weight: bold;
                   7130:   text-align: right;
                   7131:   width: 184px;
                   7132: }
1.795     www      7133: 
1.424     albertel 7134: table.LC_group_priv_box td.LC_groups_fixed {
                   7135:   background: $data_table_light;
                   7136:   text-align: center;
                   7137: }
1.795     www      7138: 
1.424     albertel 7139: table.LC_group_priv_box td.LC_groups_optional {
                   7140:   background: $data_table_dark;
                   7141:   text-align: center;
                   7142: }
1.795     www      7143: 
1.424     albertel 7144: table.LC_group_priv_box td.LC_groups_functionality {
                   7145:   background: $data_table_darker;
                   7146:   text-align: center;
                   7147:   font-weight: bold;
                   7148: }
1.795     www      7149: 
1.424     albertel 7150: table.LC_group_priv td {
                   7151:   text-align: left;
1.803     bisitz   7152:   padding: 0;
1.424     albertel 7153: }
                   7154: 
                   7155: .LC_navbuttons {
                   7156:   margin: 2ex 0ex 2ex 0ex;
                   7157: }
1.795     www      7158: 
1.423     albertel 7159: .LC_topic_bar {
                   7160:   font-weight: bold;
                   7161:   background: $tabbg;
1.918     wenzelju 7162:   margin: 1em 0em 1em 2em;
1.805     bisitz   7163:   padding: 3px;
1.918     wenzelju 7164:   font-size: 1.2em;
1.423     albertel 7165: }
1.795     www      7166: 
1.423     albertel 7167: .LC_topic_bar span {
1.918     wenzelju 7168:   left: 0.5em;
                   7169:   position: absolute;
1.423     albertel 7170:   vertical-align: middle;
1.918     wenzelju 7171:   font-size: 1.2em;
1.423     albertel 7172: }
1.795     www      7173: 
1.423     albertel 7174: table.LC_course_group_status {
                   7175:   margin: 20px;
                   7176: }
1.795     www      7177: 
1.423     albertel 7178: table.LC_status_selector td {
                   7179:   vertical-align: top;
                   7180:   text-align: center;
1.424     albertel 7181:   padding: 4px;
                   7182: }
1.795     www      7183: 
1.599     albertel 7184: div.LC_feedback_link {
1.616     albertel 7185:   clear: both;
1.829     kalberla 7186:   background: $sidebg;
1.779     bisitz   7187:   width: 100%;
1.829     kalberla 7188:   padding-bottom: 10px;
                   7189:   border: 1px $tabbg solid;
1.833     kalberla 7190:   height: 22px;
                   7191:   line-height: 22px;
                   7192:   padding-top: 5px;
                   7193: }
                   7194: 
                   7195: div.LC_feedback_link img {
                   7196:   height: 22px;
1.867     kalberla 7197:   vertical-align:middle;
1.829     kalberla 7198: }
                   7199: 
1.911     bisitz   7200: div.LC_feedback_link a {
1.829     kalberla 7201:   text-decoration: none;
1.489     raeburn  7202: }
1.795     www      7203: 
1.867     kalberla 7204: div.LC_comblock {
1.911     bisitz   7205:   display:inline;
1.867     kalberla 7206:   color:$font;
                   7207:   font-size:90%;
                   7208: }
                   7209: 
                   7210: div.LC_feedback_link div.LC_comblock {
                   7211:   padding-left:5px;
                   7212: }
                   7213: 
                   7214: div.LC_feedback_link div.LC_comblock a {
                   7215:   color:$font;
                   7216: }
                   7217: 
1.489     raeburn  7218: span.LC_feedback_link {
1.858     bisitz   7219:   /* background: $feedback_link_bg; */
1.599     albertel 7220:   font-size: larger;
                   7221: }
1.795     www      7222: 
1.599     albertel 7223: span.LC_message_link {
1.858     bisitz   7224:   /* background: $feedback_link_bg; */
1.599     albertel 7225:   font-size: larger;
                   7226:   position: absolute;
                   7227:   right: 1em;
1.489     raeburn  7228: }
1.421     albertel 7229: 
1.515     albertel 7230: table.LC_prior_tries {
1.524     albertel 7231:   border: 1px solid #000000;
                   7232:   border-collapse: separate;
                   7233:   border-spacing: 1px;
1.515     albertel 7234: }
1.523     albertel 7235: 
1.515     albertel 7236: table.LC_prior_tries td {
1.524     albertel 7237:   padding: 2px;
1.515     albertel 7238: }
1.523     albertel 7239: 
                   7240: .LC_answer_correct {
1.795     www      7241:   background: lightgreen;
                   7242:   color: darkgreen;
                   7243:   padding: 6px;
1.523     albertel 7244: }
1.795     www      7245: 
1.523     albertel 7246: .LC_answer_charged_try {
1.797     www      7247:   background: #FFAAAA;
1.795     www      7248:   color: darkred;
                   7249:   padding: 6px;
1.523     albertel 7250: }
1.795     www      7251: 
1.779     bisitz   7252: .LC_answer_not_charged_try,
1.523     albertel 7253: .LC_answer_no_grade,
                   7254: .LC_answer_late {
1.795     www      7255:   background: lightyellow;
1.523     albertel 7256:   color: black;
1.795     www      7257:   padding: 6px;
1.523     albertel 7258: }
1.795     www      7259: 
1.523     albertel 7260: .LC_answer_previous {
1.795     www      7261:   background: lightblue;
                   7262:   color: darkblue;
                   7263:   padding: 6px;
1.523     albertel 7264: }
1.795     www      7265: 
1.779     bisitz   7266: .LC_answer_no_message {
1.777     tempelho 7267:   background: #FFFFFF;
                   7268:   color: black;
1.795     www      7269:   padding: 6px;
1.779     bisitz   7270: }
1.795     www      7271: 
1.1075.2.140  raeburn  7272: .LC_answer_unknown,
                   7273: .LC_answer_warning {
1.779     bisitz   7274:   background: orange;
                   7275:   color: black;
1.795     www      7276:   padding: 6px;
1.777     tempelho 7277: }
1.795     www      7278: 
1.529     albertel 7279: span.LC_prior_numerical,
                   7280: span.LC_prior_string,
                   7281: span.LC_prior_custom,
                   7282: span.LC_prior_reaction,
                   7283: span.LC_prior_math {
1.925     bisitz   7284:   font-family: $mono;
1.523     albertel 7285:   white-space: pre;
                   7286: }
                   7287: 
1.525     albertel 7288: span.LC_prior_string {
1.925     bisitz   7289:   font-family: $mono;
1.525     albertel 7290:   white-space: pre;
                   7291: }
                   7292: 
1.523     albertel 7293: table.LC_prior_option {
                   7294:   width: 100%;
                   7295:   border-collapse: collapse;
                   7296: }
1.795     www      7297: 
1.911     bisitz   7298: table.LC_prior_rank,
1.795     www      7299: table.LC_prior_match {
1.528     albertel 7300:   border-collapse: collapse;
                   7301: }
1.795     www      7302: 
1.528     albertel 7303: table.LC_prior_option tr td,
                   7304: table.LC_prior_rank tr td,
                   7305: table.LC_prior_match tr td {
1.524     albertel 7306:   border: 1px solid #000000;
1.515     albertel 7307: }
                   7308: 
1.855     bisitz   7309: .LC_nobreak {
1.544     albertel 7310:   white-space: nowrap;
1.519     raeburn  7311: }
                   7312: 
1.576     raeburn  7313: span.LC_cusr_emph {
                   7314:   font-style: italic;
                   7315: }
                   7316: 
1.633     raeburn  7317: span.LC_cusr_subheading {
                   7318:   font-weight: normal;
                   7319:   font-size: 85%;
                   7320: }
                   7321: 
1.861     bisitz   7322: div.LC_docs_entry_move {
1.859     bisitz   7323:   border: 1px solid #BBBBBB;
1.545     albertel 7324:   background: #DDDDDD;
1.861     bisitz   7325:   width: 22px;
1.859     bisitz   7326:   padding: 1px;
                   7327:   margin: 0;
1.545     albertel 7328: }
                   7329: 
1.861     bisitz   7330: table.LC_data_table tr > td.LC_docs_entry_commands,
                   7331: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 7332:   font-size: x-small;
                   7333: }
1.795     www      7334: 
1.861     bisitz   7335: .LC_docs_entry_parameter {
                   7336:   white-space: nowrap;
                   7337: }
                   7338: 
1.544     albertel 7339: .LC_docs_copy {
1.545     albertel 7340:   color: #000099;
1.544     albertel 7341: }
1.795     www      7342: 
1.544     albertel 7343: .LC_docs_cut {
1.545     albertel 7344:   color: #550044;
1.544     albertel 7345: }
1.795     www      7346: 
1.544     albertel 7347: .LC_docs_rename {
1.545     albertel 7348:   color: #009900;
1.544     albertel 7349: }
1.795     www      7350: 
1.544     albertel 7351: .LC_docs_remove {
1.545     albertel 7352:   color: #990000;
                   7353: }
                   7354: 
1.1075.2.134  raeburn  7355: .LC_domprefs_email,
1.547     albertel 7356: .LC_docs_reinit_warn,
                   7357: .LC_docs_ext_edit {
                   7358:   font-size: x-small;
                   7359: }
                   7360: 
1.545     albertel 7361: table.LC_docs_adddocs td,
                   7362: table.LC_docs_adddocs th {
                   7363:   border: 1px solid #BBBBBB;
                   7364:   padding: 4px;
                   7365:   background: #DDDDDD;
1.543     albertel 7366: }
                   7367: 
1.584     albertel 7368: table.LC_sty_begin {
                   7369:   background: #BBFFBB;
                   7370: }
1.795     www      7371: 
1.584     albertel 7372: table.LC_sty_end {
                   7373:   background: #FFBBBB;
                   7374: }
                   7375: 
1.589     raeburn  7376: table.LC_double_column {
1.803     bisitz   7377:   border-width: 0;
1.589     raeburn  7378:   border-collapse: collapse;
                   7379:   width: 100%;
                   7380:   padding: 2px;
                   7381: }
                   7382: 
                   7383: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  7384:   top: 2px;
1.589     raeburn  7385:   left: 2px;
                   7386:   width: 47%;
                   7387:   vertical-align: top;
                   7388: }
                   7389: 
                   7390: table.LC_double_column tr td.LC_right_col {
                   7391:   top: 2px;
1.779     bisitz   7392:   right: 2px;
1.589     raeburn  7393:   width: 47%;
                   7394:   vertical-align: top;
                   7395: }
                   7396: 
1.591     raeburn  7397: div.LC_left_float {
                   7398:   float: left;
                   7399:   padding-right: 5%;
1.597     albertel 7400:   padding-bottom: 4px;
1.591     raeburn  7401: }
                   7402: 
                   7403: div.LC_clear_float_header {
1.597     albertel 7404:   padding-bottom: 2px;
1.591     raeburn  7405: }
                   7406: 
                   7407: div.LC_clear_float_footer {
1.597     albertel 7408:   padding-top: 10px;
1.591     raeburn  7409:   clear: both;
                   7410: }
                   7411: 
1.597     albertel 7412: div.LC_grade_show_user {
1.941     bisitz   7413: /*  border-left: 5px solid $sidebg; */
                   7414:   border-top: 5px solid #000000;
                   7415:   margin: 50px 0 0 0;
1.936     bisitz   7416:   padding: 15px 0 5px 10px;
1.597     albertel 7417: }
1.795     www      7418: 
1.936     bisitz   7419: div.LC_grade_show_user_odd_row {
1.941     bisitz   7420: /*  border-left: 5px solid #000000; */
                   7421: }
                   7422: 
                   7423: div.LC_grade_show_user div.LC_Box {
                   7424:   margin-right: 50px;
1.597     albertel 7425: }
                   7426: 
                   7427: div.LC_grade_submissions,
                   7428: div.LC_grade_message_center,
1.936     bisitz   7429: div.LC_grade_info_links {
1.597     albertel 7430:   margin: 5px;
                   7431:   width: 99%;
                   7432:   background: #FFFFFF;
                   7433: }
1.795     www      7434: 
1.597     albertel 7435: div.LC_grade_submissions_header,
1.936     bisitz   7436: div.LC_grade_message_center_header {
1.705     tempelho 7437:   font-weight: bold;
                   7438:   font-size: large;
1.597     albertel 7439: }
1.795     www      7440: 
1.597     albertel 7441: div.LC_grade_submissions_body,
1.936     bisitz   7442: div.LC_grade_message_center_body {
1.597     albertel 7443:   border: 1px solid black;
                   7444:   width: 99%;
                   7445:   background: #FFFFFF;
                   7446: }
1.795     www      7447: 
1.613     albertel 7448: table.LC_scantron_action {
                   7449:   width: 100%;
                   7450: }
1.795     www      7451: 
1.613     albertel 7452: table.LC_scantron_action tr th {
1.698     harmsja  7453:   font-weight:bold;
                   7454:   font-style:normal;
1.613     albertel 7455: }
1.795     www      7456: 
1.779     bisitz   7457: .LC_edit_problem_header,
1.614     albertel 7458: div.LC_edit_problem_footer {
1.705     tempelho 7459:   font-weight: normal;
                   7460:   font-size:  medium;
1.602     albertel 7461:   margin: 2px;
1.1060    bisitz   7462:   background-color: $sidebg;
1.600     albertel 7463: }
1.795     www      7464: 
1.600     albertel 7465: div.LC_edit_problem_header,
1.602     albertel 7466: div.LC_edit_problem_header div,
1.614     albertel 7467: div.LC_edit_problem_footer,
                   7468: div.LC_edit_problem_footer div,
1.602     albertel 7469: div.LC_edit_problem_editxml_header,
                   7470: div.LC_edit_problem_editxml_header div {
1.1075.2.112  raeburn  7471:   z-index: 100;
1.600     albertel 7472: }
1.795     www      7473: 
1.600     albertel 7474: div.LC_edit_problem_header_title {
1.705     tempelho 7475:   font-weight: bold;
                   7476:   font-size: larger;
1.602     albertel 7477:   background: $tabbg;
                   7478:   padding: 3px;
1.1060    bisitz   7479:   margin: 0 0 5px 0;
1.602     albertel 7480: }
1.795     www      7481: 
1.602     albertel 7482: table.LC_edit_problem_header_title {
                   7483:   width: 100%;
1.600     albertel 7484:   background: $tabbg;
1.602     albertel 7485: }
                   7486: 
1.1075.2.112  raeburn  7487: div.LC_edit_actionbar {
                   7488:     background-color: $sidebg;
                   7489:     margin: 0;
                   7490:     padding: 0;
                   7491:     line-height: 200%;
1.602     albertel 7492: }
1.795     www      7493: 
1.1075.2.112  raeburn  7494: div.LC_edit_actionbar div{
                   7495:     padding: 0;
                   7496:     margin: 0;
                   7497:     display: inline-block;
1.600     albertel 7498: }
1.795     www      7499: 
1.1075.2.34  raeburn  7500: .LC_edit_opt {
                   7501:   padding-left: 1em;
                   7502:   white-space: nowrap;
                   7503: }
                   7504: 
1.1075.2.57  raeburn  7505: .LC_edit_problem_latexhelper{
                   7506:     text-align: right;
                   7507: }
                   7508: 
                   7509: #LC_edit_problem_colorful div{
                   7510:     margin-left: 40px;
                   7511: }
                   7512: 
1.1075.2.112  raeburn  7513: #LC_edit_problem_codemirror div{
                   7514:     margin-left: 0px;
                   7515: }
                   7516: 
1.911     bisitz   7517: img.stift {
1.803     bisitz   7518:   border-width: 0;
                   7519:   vertical-align: middle;
1.677     riegler  7520: }
1.680     riegler  7521: 
1.923     bisitz   7522: table td.LC_mainmenu_col_fieldset {
1.680     riegler  7523:   vertical-align: top;
1.777     tempelho 7524: }
1.795     www      7525: 
1.716     raeburn  7526: div.LC_createcourse {
1.911     bisitz   7527:   margin: 10px 10px 10px 10px;
1.716     raeburn  7528: }
                   7529: 
1.917     raeburn  7530: .LC_dccid {
1.1075.2.38  raeburn  7531:   float: right;
1.917     raeburn  7532:   margin: 0.2em 0 0 0;
                   7533:   padding: 0;
                   7534:   font-size: 90%;
                   7535:   display:none;
                   7536: }
                   7537: 
1.897     wenzelju 7538: ol.LC_primary_menu a:hover,
1.721     harmsja  7539: ol#LC_MenuBreadcrumbs a:hover,
                   7540: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 7541: ul#LC_secondary_menu a:hover,
1.721     harmsja  7542: .LC_FormSectionClearButton input:hover
1.795     www      7543: ul.LC_TabContent   li:hover a {
1.952     onken    7544:   color:$button_hover;
1.911     bisitz   7545:   text-decoration:none;
1.693     droeschl 7546: }
                   7547: 
1.779     bisitz   7548: h1 {
1.911     bisitz   7549:   padding: 0;
                   7550:   line-height:130%;
1.693     droeschl 7551: }
1.698     harmsja  7552: 
1.911     bisitz   7553: h2,
                   7554: h3,
                   7555: h4,
                   7556: h5,
                   7557: h6 {
                   7558:   margin: 5px 0 5px 0;
                   7559:   padding: 0;
                   7560:   line-height:130%;
1.693     droeschl 7561: }
1.795     www      7562: 
                   7563: .LC_hcell {
1.911     bisitz   7564:   padding:3px 15px 3px 15px;
                   7565:   margin: 0;
                   7566:   background-color:$tabbg;
                   7567:   color:$fontmenu;
                   7568:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 7569: }
1.795     www      7570: 
1.840     bisitz   7571: .LC_Box > .LC_hcell {
1.911     bisitz   7572:   margin: 0 -10px 10px -10px;
1.835     bisitz   7573: }
                   7574: 
1.721     harmsja  7575: .LC_noBorder {
1.911     bisitz   7576:   border: 0;
1.698     harmsja  7577: }
1.693     droeschl 7578: 
1.721     harmsja  7579: .LC_FormSectionClearButton input {
1.911     bisitz   7580:   background-color:transparent;
                   7581:   border: none;
                   7582:   cursor:pointer;
                   7583:   text-decoration:underline;
1.693     droeschl 7584: }
1.763     bisitz   7585: 
                   7586: .LC_help_open_topic {
1.911     bisitz   7587:   color: #FFFFFF;
                   7588:   background-color: #EEEEFF;
                   7589:   margin: 1px;
                   7590:   padding: 4px;
                   7591:   border: 1px solid #000033;
                   7592:   white-space: nowrap;
                   7593:   /* vertical-align: middle; */
1.759     neumanie 7594: }
1.693     droeschl 7595: 
1.911     bisitz   7596: dl,
                   7597: ul,
                   7598: div,
                   7599: fieldset {
                   7600:   margin: 10px 10px 10px 0;
                   7601:   /* overflow: hidden; */
1.693     droeschl 7602: }
1.795     www      7603: 
1.1075.2.90  raeburn  7604: article.geogebraweb div {
                   7605:     margin: 0;
                   7606: }
                   7607: 
1.838     bisitz   7608: fieldset > legend {
1.911     bisitz   7609:   font-weight: bold;
                   7610:   padding: 0 5px 0 5px;
1.838     bisitz   7611: }
                   7612: 
1.813     bisitz   7613: #LC_nav_bar {
1.911     bisitz   7614:   float: left;
1.995     raeburn  7615:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   7616:   margin: 0 0 2px 0;
1.807     droeschl 7617: }
                   7618: 
1.916     droeschl 7619: #LC_realm {
                   7620:   margin: 0.2em 0 0 0;
                   7621:   padding: 0;
                   7622:   font-weight: bold;
                   7623:   text-align: center;
1.995     raeburn  7624:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 7625: }
                   7626: 
1.911     bisitz   7627: #LC_nav_bar em {
                   7628:   font-weight: bold;
                   7629:   font-style: normal;
1.807     droeschl 7630: }
                   7631: 
1.897     wenzelju 7632: ol.LC_primary_menu {
1.934     droeschl 7633:   margin: 0;
1.1075.2.2  raeburn  7634:   padding: 0;
1.807     droeschl 7635: }
                   7636: 
1.852     droeschl 7637: ol#LC_PathBreadcrumbs {
1.911     bisitz   7638:   margin: 0;
1.693     droeschl 7639: }
                   7640: 
1.897     wenzelju 7641: ol.LC_primary_menu li {
1.1075.2.2  raeburn  7642:   color: RGB(80, 80, 80);
                   7643:   vertical-align: middle;
                   7644:   text-align: left;
                   7645:   list-style: none;
1.1075.2.112  raeburn  7646:   position: relative;
1.1075.2.2  raeburn  7647:   float: left;
1.1075.2.112  raeburn  7648:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   7649:   line-height: 1.5em;
1.1075.2.2  raeburn  7650: }
                   7651: 
1.1075.2.113  raeburn  7652: ol.LC_primary_menu li a, 
1.1075.2.112  raeburn  7653: ol.LC_primary_menu li p {
1.1075.2.2  raeburn  7654:   display: block;
                   7655:   margin: 0;
                   7656:   padding: 0 5px 0 10px;
                   7657:   text-decoration: none;
                   7658: }
                   7659: 
1.1075.2.112  raeburn  7660: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   7661:   display: inline-block;
                   7662:   width: 95%;
                   7663:   text-align: left;
                   7664: }
                   7665: 
                   7666: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   7667:   display: inline-block;
                   7668:   width: 5%;
                   7669:   float: right;
                   7670:   text-align: right;
                   7671:   font-size: 70%;
                   7672: }
                   7673: 
                   7674: ol.LC_primary_menu ul {
1.1075.2.2  raeburn  7675:   display: none;
1.1075.2.112  raeburn  7676:   width: 15em;
1.1075.2.2  raeburn  7677:   background-color: $data_table_light;
1.1075.2.112  raeburn  7678:   position: absolute;
                   7679:   top: 100%;
                   7680: }
                   7681: 
                   7682: ol.LC_primary_menu ul ul {
                   7683:   left: 100%;
                   7684:   top: 0;
1.1075.2.2  raeburn  7685: }
                   7686: 
1.1075.2.112  raeburn  7687: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1075.2.2  raeburn  7688:   display: block;
                   7689:   position: absolute;
                   7690:   margin: 0;
                   7691:   padding: 0;
1.1075.2.5  raeburn  7692:   z-index: 2;
1.1075.2.2  raeburn  7693: }
                   7694: 
                   7695: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1075.2.112  raeburn  7696: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1075.2.2  raeburn  7697:   font-size: 90%;
1.911     bisitz   7698:   vertical-align: top;
1.1075.2.2  raeburn  7699:   float: none;
1.1075.2.5  raeburn  7700:   border-left: 1px solid black;
                   7701:   border-right: 1px solid black;
1.1075.2.112  raeburn  7702: /* A dark bottom border to visualize different menu options;
                   7703: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   7704:   border-bottom: 1px solid $data_table_dark;
1.1075.2.2  raeburn  7705: }
                   7706: 
1.1075.2.112  raeburn  7707: ol.LC_primary_menu li li p:hover {
                   7708:   color:$button_hover;
                   7709:   text-decoration:none;
                   7710:   background-color:$data_table_dark;
1.1075.2.2  raeburn  7711: }
                   7712: 
                   7713: ol.LC_primary_menu li li a:hover {
                   7714:    color:$button_hover;
                   7715:    background-color:$data_table_dark;
1.693     droeschl 7716: }
                   7717: 
1.1075.2.112  raeburn  7718: /* Font-size equal to the size of the predecessors*/
                   7719: ol.LC_primary_menu li:hover li li {
                   7720:   font-size: 100%;
                   7721: }
                   7722: 
1.897     wenzelju 7723: ol.LC_primary_menu li img {
1.911     bisitz   7724:   vertical-align: bottom;
1.934     droeschl 7725:   height: 1.1em;
1.1075.2.3  raeburn  7726:   margin: 0.2em 0 0 0;
1.693     droeschl 7727: }
                   7728: 
1.897     wenzelju 7729: ol.LC_primary_menu a {
1.911     bisitz   7730:   color: RGB(80, 80, 80);
                   7731:   text-decoration: none;
1.693     droeschl 7732: }
1.795     www      7733: 
1.949     droeschl 7734: ol.LC_primary_menu a.LC_new_message {
                   7735:   font-weight:bold;
                   7736:   color: darkred;
                   7737: }
                   7738: 
1.975     raeburn  7739: ol.LC_docs_parameters {
                   7740:   margin-left: 0;
                   7741:   padding: 0;
                   7742:   list-style: none;
                   7743: }
                   7744: 
                   7745: ol.LC_docs_parameters li {
                   7746:   margin: 0;
                   7747:   padding-right: 20px;
                   7748:   display: inline;
                   7749: }
                   7750: 
1.976     raeburn  7751: ol.LC_docs_parameters li:before {
                   7752:   content: "\\002022 \\0020";
                   7753: }
                   7754: 
                   7755: li.LC_docs_parameters_title {
                   7756:   font-weight: bold;
                   7757: }
                   7758: 
                   7759: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   7760:   content: "";
                   7761: }
                   7762: 
1.897     wenzelju 7763: ul#LC_secondary_menu {
1.1075.2.23  raeburn  7764:   clear: right;
1.911     bisitz   7765:   color: $fontmenu;
                   7766:   background: $tabbg;
                   7767:   list-style: none;
                   7768:   padding: 0;
                   7769:   margin: 0;
                   7770:   width: 100%;
1.995     raeburn  7771:   text-align: left;
1.1075.2.4  raeburn  7772:   float: left;
1.808     droeschl 7773: }
                   7774: 
1.897     wenzelju 7775: ul#LC_secondary_menu li {
1.911     bisitz   7776:   font-weight: bold;
                   7777:   line-height: 1.8em;
                   7778:   border-right: 1px solid black;
1.1075.2.4  raeburn  7779:   float: left;
                   7780: }
                   7781: 
                   7782: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   7783:   background-color: $data_table_light;
                   7784: }
                   7785: 
                   7786: ul#LC_secondary_menu li a {
                   7787:   padding: 0 0.8em;
                   7788: }
                   7789: 
                   7790: ul#LC_secondary_menu li ul {
                   7791:   display: none;
                   7792: }
                   7793: 
                   7794: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   7795:   display: block;
                   7796:   position: absolute;
                   7797:   margin: 0;
                   7798:   padding: 0;
                   7799:   list-style:none;
                   7800:   float: none;
                   7801:   background-color: $data_table_light;
1.1075.2.5  raeburn  7802:   z-index: 2;
1.1075.2.10  raeburn  7803:   margin-left: -1px;
1.1075.2.4  raeburn  7804: }
                   7805: 
                   7806: ul#LC_secondary_menu li ul li {
                   7807:   font-size: 90%;
                   7808:   vertical-align: top;
                   7809:   border-left: 1px solid black;
                   7810:   border-right: 1px solid black;
1.1075.2.33  raeburn  7811:   background-color: $data_table_light;
1.1075.2.4  raeburn  7812:   list-style:none;
                   7813:   float: none;
                   7814: }
                   7815: 
                   7816: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   7817:   background-color: $data_table_dark;
1.807     droeschl 7818: }
                   7819: 
1.847     tempelho 7820: ul.LC_TabContent {
1.911     bisitz   7821:   display:block;
                   7822:   background: $sidebg;
                   7823:   border-bottom: solid 1px $lg_border_color;
                   7824:   list-style:none;
1.1020    raeburn  7825:   margin: -1px -10px 0 -10px;
1.911     bisitz   7826:   padding: 0;
1.693     droeschl 7827: }
                   7828: 
1.795     www      7829: ul.LC_TabContent li,
                   7830: ul.LC_TabContentBigger li {
1.911     bisitz   7831:   float:left;
1.741     harmsja  7832: }
1.795     www      7833: 
1.897     wenzelju 7834: ul#LC_secondary_menu li a {
1.911     bisitz   7835:   color: $fontmenu;
                   7836:   text-decoration: none;
1.693     droeschl 7837: }
1.795     www      7838: 
1.721     harmsja  7839: ul.LC_TabContent {
1.952     onken    7840:   min-height:20px;
1.721     harmsja  7841: }
1.795     www      7842: 
                   7843: ul.LC_TabContent li {
1.911     bisitz   7844:   vertical-align:middle;
1.959     onken    7845:   padding: 0 16px 0 10px;
1.911     bisitz   7846:   background-color:$tabbg;
                   7847:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  7848:   border-left: solid 1px $font;
1.721     harmsja  7849: }
1.795     www      7850: 
1.847     tempelho 7851: ul.LC_TabContent .right {
1.911     bisitz   7852:   float:right;
1.847     tempelho 7853: }
                   7854: 
1.911     bisitz   7855: ul.LC_TabContent li a,
                   7856: ul.LC_TabContent li {
                   7857:   color:rgb(47,47,47);
                   7858:   text-decoration:none;
                   7859:   font-size:95%;
                   7860:   font-weight:bold;
1.952     onken    7861:   min-height:20px;
                   7862: }
                   7863: 
1.959     onken    7864: ul.LC_TabContent li a:hover,
                   7865: ul.LC_TabContent li a:focus {
1.952     onken    7866:   color: $button_hover;
1.959     onken    7867:   background:none;
                   7868:   outline:none;
1.952     onken    7869: }
                   7870: 
                   7871: ul.LC_TabContent li:hover {
                   7872:   color: $button_hover;
                   7873:   cursor:pointer;
1.721     harmsja  7874: }
1.795     www      7875: 
1.911     bisitz   7876: ul.LC_TabContent li.active {
1.952     onken    7877:   color: $font;
1.911     bisitz   7878:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    7879:   border-bottom:solid 1px #FFFFFF;
                   7880:   cursor: default;
1.744     ehlerst  7881: }
1.795     www      7882: 
1.959     onken    7883: ul.LC_TabContent li.active a {
                   7884:   color:$font;
                   7885:   background:#FFFFFF;
                   7886:   outline: none;
                   7887: }
1.1047    raeburn  7888: 
                   7889: ul.LC_TabContent li.goback {
                   7890:   float: left;
                   7891:   border-left: none;
                   7892: }
                   7893: 
1.870     tempelho 7894: #maincoursedoc {
1.911     bisitz   7895:   clear:both;
1.870     tempelho 7896: }
                   7897: 
                   7898: ul.LC_TabContentBigger {
1.911     bisitz   7899:   display:block;
                   7900:   list-style:none;
                   7901:   padding: 0;
1.870     tempelho 7902: }
                   7903: 
1.795     www      7904: ul.LC_TabContentBigger li {
1.911     bisitz   7905:   vertical-align:bottom;
                   7906:   height: 30px;
                   7907:   font-size:110%;
                   7908:   font-weight:bold;
                   7909:   color: #737373;
1.841     tempelho 7910: }
                   7911: 
1.957     onken    7912: ul.LC_TabContentBigger li.active {
                   7913:   position: relative;
                   7914:   top: 1px;
                   7915: }
                   7916: 
1.870     tempelho 7917: ul.LC_TabContentBigger li a {
1.911     bisitz   7918:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   7919:   height: 30px;
                   7920:   line-height: 30px;
                   7921:   text-align: center;
                   7922:   display: block;
                   7923:   text-decoration: none;
1.958     onken    7924:   outline: none;  
1.741     harmsja  7925: }
1.795     www      7926: 
1.870     tempelho 7927: ul.LC_TabContentBigger li.active a {
1.911     bisitz   7928:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   7929:   color:$font;
1.744     ehlerst  7930: }
1.795     www      7931: 
1.870     tempelho 7932: ul.LC_TabContentBigger li b {
1.911     bisitz   7933:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   7934:   display: block;
                   7935:   float: left;
                   7936:   padding: 0 30px;
1.957     onken    7937:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 7938: }
                   7939: 
1.956     onken    7940: ul.LC_TabContentBigger li:hover b {
                   7941:   color:$button_hover;
                   7942: }
                   7943: 
1.870     tempelho 7944: ul.LC_TabContentBigger li.active b {
1.911     bisitz   7945:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   7946:   color:$font;
1.957     onken    7947:   border: 0;
1.741     harmsja  7948: }
1.693     droeschl 7949: 
1.870     tempelho 7950: 
1.862     bisitz   7951: ul.LC_CourseBreadcrumbs {
                   7952:   background: $sidebg;
1.1020    raeburn  7953:   height: 2em;
1.862     bisitz   7954:   padding-left: 10px;
1.1020    raeburn  7955:   margin: 0;
1.862     bisitz   7956:   list-style-position: inside;
                   7957: }
                   7958: 
1.911     bisitz   7959: ol#LC_MenuBreadcrumbs,
1.862     bisitz   7960: ol#LC_PathBreadcrumbs {
1.911     bisitz   7961:   padding-left: 10px;
                   7962:   margin: 0;
1.933     droeschl 7963:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 7964: }
                   7965: 
1.911     bisitz   7966: ol#LC_MenuBreadcrumbs li,
                   7967: ol#LC_PathBreadcrumbs li,
1.862     bisitz   7968: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   7969:   display: inline;
1.933     droeschl 7970:   white-space: normal;  
1.693     droeschl 7971: }
                   7972: 
1.823     bisitz   7973: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   7974: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   7975:   text-decoration: none;
                   7976:   font-size:90%;
1.693     droeschl 7977: }
1.795     www      7978: 
1.969     droeschl 7979: ol#LC_MenuBreadcrumbs h1 {
                   7980:   display: inline;
                   7981:   font-size: 90%;
                   7982:   line-height: 2.5em;
                   7983:   margin: 0;
                   7984:   padding: 0;
                   7985: }
                   7986: 
1.795     www      7987: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   7988:   text-decoration:none;
                   7989:   font-size:100%;
                   7990:   font-weight:bold;
1.693     droeschl 7991: }
1.795     www      7992: 
1.840     bisitz   7993: .LC_Box {
1.911     bisitz   7994:   border: solid 1px $lg_border_color;
                   7995:   padding: 0 10px 10px 10px;
1.746     neumanie 7996: }
1.795     www      7997: 
1.1020    raeburn  7998: .LC_DocsBox {
                   7999:   border: solid 1px $lg_border_color;
                   8000:   padding: 0 0 10px 10px;
                   8001: }
                   8002: 
1.795     www      8003: .LC_AboutMe_Image {
1.911     bisitz   8004:   float:left;
                   8005:   margin-right:10px;
1.747     neumanie 8006: }
1.795     www      8007: 
                   8008: .LC_Clear_AboutMe_Image {
1.911     bisitz   8009:   clear:left;
1.747     neumanie 8010: }
1.795     www      8011: 
1.721     harmsja  8012: dl.LC_ListStyleClean dt {
1.911     bisitz   8013:   padding-right: 5px;
                   8014:   display: table-header-group;
1.693     droeschl 8015: }
                   8016: 
1.721     harmsja  8017: dl.LC_ListStyleClean dd {
1.911     bisitz   8018:   display: table-row;
1.693     droeschl 8019: }
                   8020: 
1.721     harmsja  8021: .LC_ListStyleClean,
                   8022: .LC_ListStyleSimple,
                   8023: .LC_ListStyleNormal,
1.795     www      8024: .LC_ListStyleSpecial {
1.911     bisitz   8025:   /* display:block; */
                   8026:   list-style-position: inside;
                   8027:   list-style-type: none;
                   8028:   overflow: hidden;
                   8029:   padding: 0;
1.693     droeschl 8030: }
                   8031: 
1.721     harmsja  8032: .LC_ListStyleSimple li,
                   8033: .LC_ListStyleSimple dd,
                   8034: .LC_ListStyleNormal li,
                   8035: .LC_ListStyleNormal dd,
                   8036: .LC_ListStyleSpecial li,
1.795     www      8037: .LC_ListStyleSpecial dd {
1.911     bisitz   8038:   margin: 0;
                   8039:   padding: 5px 5px 5px 10px;
                   8040:   clear: both;
1.693     droeschl 8041: }
                   8042: 
1.721     harmsja  8043: .LC_ListStyleClean li,
                   8044: .LC_ListStyleClean dd {
1.911     bisitz   8045:   padding-top: 0;
                   8046:   padding-bottom: 0;
1.693     droeschl 8047: }
                   8048: 
1.721     harmsja  8049: .LC_ListStyleSimple dd,
1.795     www      8050: .LC_ListStyleSimple li {
1.911     bisitz   8051:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 8052: }
                   8053: 
1.721     harmsja  8054: .LC_ListStyleSpecial li,
                   8055: .LC_ListStyleSpecial dd {
1.911     bisitz   8056:   list-style-type: none;
                   8057:   background-color: RGB(220, 220, 220);
                   8058:   margin-bottom: 4px;
1.693     droeschl 8059: }
                   8060: 
1.721     harmsja  8061: table.LC_SimpleTable {
1.911     bisitz   8062:   margin:5px;
                   8063:   border:solid 1px $lg_border_color;
1.795     www      8064: }
1.693     droeschl 8065: 
1.721     harmsja  8066: table.LC_SimpleTable tr {
1.911     bisitz   8067:   padding: 0;
                   8068:   border:solid 1px $lg_border_color;
1.693     droeschl 8069: }
1.795     www      8070: 
                   8071: table.LC_SimpleTable thead {
1.911     bisitz   8072:   background:rgb(220,220,220);
1.693     droeschl 8073: }
                   8074: 
1.721     harmsja  8075: div.LC_columnSection {
1.911     bisitz   8076:   display: block;
                   8077:   clear: both;
                   8078:   overflow: hidden;
                   8079:   margin: 0;
1.693     droeschl 8080: }
                   8081: 
1.721     harmsja  8082: div.LC_columnSection>* {
1.911     bisitz   8083:   float: left;
                   8084:   margin: 10px 20px 10px 0;
                   8085:   overflow:hidden;
1.693     droeschl 8086: }
1.721     harmsja  8087: 
1.795     www      8088: table em {
1.911     bisitz   8089:   font-weight: bold;
                   8090:   font-style: normal;
1.748     schulted 8091: }
1.795     www      8092: 
1.779     bisitz   8093: table.LC_tableBrowseRes,
1.795     www      8094: table.LC_tableOfContent {
1.911     bisitz   8095:   border:none;
                   8096:   border-spacing: 1px;
                   8097:   padding: 3px;
                   8098:   background-color: #FFFFFF;
                   8099:   font-size: 90%;
1.753     droeschl 8100: }
1.789     droeschl 8101: 
1.911     bisitz   8102: table.LC_tableOfContent {
                   8103:   border-collapse: collapse;
1.789     droeschl 8104: }
                   8105: 
1.771     droeschl 8106: table.LC_tableBrowseRes a,
1.768     schulted 8107: table.LC_tableOfContent a {
1.911     bisitz   8108:   background-color: transparent;
                   8109:   text-decoration: none;
1.753     droeschl 8110: }
                   8111: 
1.795     www      8112: table.LC_tableOfContent img {
1.911     bisitz   8113:   border: none;
                   8114:   height: 1.3em;
                   8115:   vertical-align: text-bottom;
                   8116:   margin-right: 0.3em;
1.753     droeschl 8117: }
1.757     schulted 8118: 
1.795     www      8119: a#LC_content_toolbar_firsthomework {
1.911     bisitz   8120:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  8121: }
                   8122: 
1.795     www      8123: a#LC_content_toolbar_everything {
1.911     bisitz   8124:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  8125: }
                   8126: 
1.795     www      8127: a#LC_content_toolbar_uncompleted {
1.911     bisitz   8128:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  8129: }
                   8130: 
1.795     www      8131: #LC_content_toolbar_clearbubbles {
1.911     bisitz   8132:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  8133: }
                   8134: 
1.795     www      8135: a#LC_content_toolbar_changefolder {
1.911     bisitz   8136:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 8137: }
                   8138: 
1.795     www      8139: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   8140:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 8141: }
                   8142: 
1.1043    raeburn  8143: a#LC_content_toolbar_edittoplevel {
                   8144:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   8145: }
                   8146: 
1.795     www      8147: ul#LC_toolbar li a:hover {
1.911     bisitz   8148:   background-position: bottom center;
1.757     schulted 8149: }
                   8150: 
1.795     www      8151: ul#LC_toolbar {
1.911     bisitz   8152:   padding: 0;
                   8153:   margin: 2px;
                   8154:   list-style:none;
                   8155:   position:relative;
                   8156:   background-color:white;
1.1075.2.9  raeburn  8157:   overflow: auto;
1.757     schulted 8158: }
                   8159: 
1.795     www      8160: ul#LC_toolbar li {
1.911     bisitz   8161:   border:1px solid white;
                   8162:   padding: 0;
                   8163:   margin: 0;
                   8164:   float: left;
                   8165:   display:inline;
                   8166:   vertical-align:middle;
1.1075.2.9  raeburn  8167:   white-space: nowrap;
1.911     bisitz   8168: }
1.757     schulted 8169: 
1.783     amueller 8170: 
1.795     www      8171: a.LC_toolbarItem {
1.911     bisitz   8172:   display:block;
                   8173:   padding: 0;
                   8174:   margin: 0;
                   8175:   height: 32px;
                   8176:   width: 32px;
                   8177:   color:white;
                   8178:   border: none;
                   8179:   background-repeat:no-repeat;
                   8180:   background-color:transparent;
1.757     schulted 8181: }
                   8182: 
1.915     droeschl 8183: ul.LC_funclist {
                   8184:     margin: 0;
                   8185:     padding: 0.5em 1em 0.5em 0;
                   8186: }
                   8187: 
1.933     droeschl 8188: ul.LC_funclist > li:first-child {
                   8189:     font-weight:bold; 
                   8190:     margin-left:0.8em;
                   8191: }
                   8192: 
1.915     droeschl 8193: ul.LC_funclist + ul.LC_funclist {
                   8194:     /* 
                   8195:        left border as a seperator if we have more than
                   8196:        one list 
                   8197:     */
                   8198:     border-left: 1px solid $sidebg;
                   8199:     /* 
                   8200:        this hides the left border behind the border of the 
                   8201:        outer box if element is wrapped to the next 'line' 
                   8202:     */
                   8203:     margin-left: -1px;
                   8204: }
                   8205: 
1.843     bisitz   8206: ul.LC_funclist li {
1.915     droeschl 8207:   display: inline;
1.782     bisitz   8208:   white-space: nowrap;
1.915     droeschl 8209:   margin: 0 0 0 25px;
                   8210:   line-height: 150%;
1.782     bisitz   8211: }
                   8212: 
1.974     wenzelju 8213: .LC_hidden {
                   8214:   display: none;
                   8215: }
                   8216: 
1.1030    www      8217: .LCmodal-overlay {
                   8218: 		position:fixed;
                   8219: 		top:0;
                   8220: 		right:0;
                   8221: 		bottom:0;
                   8222: 		left:0;
                   8223: 		height:100%;
                   8224: 		width:100%;
                   8225: 		margin:0;
                   8226: 		padding:0;
                   8227: 		background:#999;
                   8228: 		opacity:.75;
                   8229: 		filter: alpha(opacity=75);
                   8230: 		-moz-opacity: 0.75;
                   8231: 		z-index:101;
                   8232: }
                   8233: 
                   8234: * html .LCmodal-overlay {   
                   8235: 		position: absolute;
                   8236: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   8237: }
                   8238: 
                   8239: .LCmodal-window {
                   8240: 		position:fixed;
                   8241: 		top:50%;
                   8242: 		left:50%;
                   8243: 		margin:0;
                   8244: 		padding:0;
                   8245: 		z-index:102;
                   8246: 	}
                   8247: 
                   8248: * html .LCmodal-window {
                   8249: 		position:absolute;
                   8250: }
                   8251: 
                   8252: .LCclose-window {
                   8253: 		position:absolute;
                   8254: 		width:32px;
                   8255: 		height:32px;
                   8256: 		right:8px;
                   8257: 		top:8px;
                   8258: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   8259: 		text-indent:-99999px;
                   8260: 		overflow:hidden;
                   8261: 		cursor:pointer;
                   8262: }
                   8263: 
1.1075.2.158  raeburn  8264: .LCisDisabled {
                   8265:   cursor: not-allowed;
                   8266:   opacity: 0.5;
                   8267: }
                   8268: 
                   8269: a[aria-disabled="true"] {
                   8270:   color: currentColor;
                   8271:   display: inline-block;  /* For IE11/ MS Edge bug */
                   8272:   pointer-events: none;
                   8273:   text-decoration: none;
                   8274: }
                   8275: 
1.1075.2.141  raeburn  8276: pre.LC_wordwrap {
                   8277:   white-space: pre-wrap;
                   8278:   white-space: -moz-pre-wrap;
                   8279:   white-space: -pre-wrap;
                   8280:   white-space: -o-pre-wrap;
                   8281:   word-wrap: break-word;
                   8282: }
                   8283: 
1.1075.2.17  raeburn  8284: /*
                   8285:   styles used by TTH when "Default set of options to pass to tth/m
                   8286:   when converting TeX" in course settings has been set
                   8287: 
                   8288:   option passed: -t
                   8289: 
                   8290: */
                   8291: 
                   8292: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   8293: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   8294: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   8295: td div.norm {line-height:normal;}
                   8296: 
                   8297: /*
                   8298:   option passed -y3
                   8299: */
                   8300: 
                   8301: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   8302: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   8303: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   8304: 
1.1075.2.121  raeburn  8305: #LC_minitab_header {
                   8306:   float:left;
                   8307:   width:100%;
                   8308:   background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
                   8309:   font-size:93%;
                   8310:   line-height:normal;
                   8311:   margin: 0.5em 0 0.5em 0;
                   8312: }
                   8313: #LC_minitab_header ul {
                   8314:   margin:0;
                   8315:   padding:10px 10px 0;
                   8316:   list-style:none;
                   8317: }
                   8318: #LC_minitab_header li {
                   8319:   float:left;
                   8320:   background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
                   8321:   margin:0;
                   8322:   padding:0 0 0 9px;
                   8323: }
                   8324: #LC_minitab_header a {
                   8325:   display:block;
                   8326:   background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
                   8327:   padding:5px 15px 4px 6px;
                   8328: }
                   8329: #LC_minitab_header #LC_current_minitab {
                   8330:   background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
                   8331: }
                   8332: #LC_minitab_header #LC_current_minitab a {
                   8333:   background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
                   8334:   padding-bottom:5px;
                   8335: }
                   8336: 
                   8337: 
1.343     albertel 8338: END
                   8339: }
                   8340: 
1.306     albertel 8341: =pod
                   8342: 
                   8343: =item * &headtag()
                   8344: 
                   8345: Returns a uniform footer for LON-CAPA web pages.
                   8346: 
1.307     albertel 8347: Inputs: $title - optional title for the head
                   8348:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 8349:         $args - optional arguments
1.319     albertel 8350:             force_register - if is true call registerurl so the remote is 
                   8351:                              informed
1.415     albertel 8352:             redirect       -> array ref of
                   8353:                                    1- seconds before redirect occurs
                   8354:                                    2- url to redirect to
                   8355:                                    3- whether the side effect should occur
1.315     albertel 8356:                            (side effect of setting 
                   8357:                                $env{'internal.head.redirect'} to the url 
1.1075.2.161.  .9(raebu 8358:22):                                redirected to)
                   8359:22):                                    4- whether the redirect target should be
                   8360:22):                                       the opener of the current (pop-up)
                   8361:22):                                       window (side effect of setting
                   8362:22):                                       $env{'internal.head.to_opener'} to
                   8363:22):                                       1, if true.
1.352     albertel 8364:             domain         -> force to color decorate a page for a specific
                   8365:                                domain
                   8366:             function       -> force usage of a specific rolish color scheme
                   8367:             bgcolor        -> override the default page bgcolor
1.460     albertel 8368:             no_auto_mt_title
                   8369:                            -> prevent &mt()ing the title arg
1.464     albertel 8370: 
1.306     albertel 8371: =cut
                   8372: 
                   8373: sub headtag {
1.313     albertel 8374:     my ($title,$head_extra,$args) = @_;
1.306     albertel 8375:     
1.363     albertel 8376:     my $function = $args->{'function'} || &get_users_function();
                   8377:     my $domain   = $args->{'domain'}   || &determinedomain();
                   8378:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1075.2.52  raeburn  8379:     my $httphost = $args->{'use_absolute'};
1.418     albertel 8380:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 8381: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 8382: 		   #time(),
1.418     albertel 8383: 		   $env{'environment.color.timestamp'},
1.363     albertel 8384: 		   $function,$domain,$bgcolor);
                   8385: 
1.369     www      8386:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 8387: 
1.308     albertel 8388:     my $result =
                   8389: 	'<head>'.
1.1075.2.56  raeburn  8390: 	&font_settings($args);
1.319     albertel 8391: 
1.1075.2.72  raeburn  8392:     my $inhibitprint;
                   8393:     if ($args->{'print_suppress'}) {
                   8394:         $inhibitprint = &print_suppression();
                   8395:     }
1.1064    raeburn  8396: 
1.461     albertel 8397:     if (!$args->{'frameset'}) {
                   8398: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   8399:     }
1.1075.2.12  raeburn  8400:     if ($args->{'force_register'}) {
                   8401:         $result .= &Apache::lonmenu::registerurl(1);
1.319     albertel 8402:     }
1.436     albertel 8403:     if (!$args->{'no_nav_bar'} 
                   8404: 	&& !$args->{'only_body'}
                   8405: 	&& !$args->{'frameset'}) {
1.1075.2.52  raeburn  8406: 	$result .= &help_menu_js($httphost);
1.1032    www      8407:         $result.=&modal_window();
1.1038    www      8408:         $result.=&togglebox_script();
1.1034    www      8409:         $result.=&wishlist_window();
1.1041    www      8410:         $result.=&LCprogressbarUpdate_script();
1.1034    www      8411:     } else {
                   8412:         if ($args->{'add_modal'}) {
                   8413:            $result.=&modal_window();
                   8414:         }
                   8415:         if ($args->{'add_wishlist'}) {
                   8416:            $result.=&wishlist_window();
                   8417:         }
1.1038    www      8418:         if ($args->{'add_togglebox'}) {
                   8419:            $result.=&togglebox_script();
                   8420:         }
1.1041    www      8421:         if ($args->{'add_progressbar'}) {
                   8422:            $result.=&LCprogressbarUpdate_script();
                   8423:         }
1.436     albertel 8424:     }
1.314     albertel 8425:     if (ref($args->{'redirect'})) {
1.1075.2.161.  .9(raebu 8426:22): 	my ($time,$url,$inhibit_continue,$to_opener) = @{$args->{'redirect'}};
1.315     albertel 8427: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 8428: 	if (!$inhibit_continue) {
                   8429: 	    $env{'internal.head.redirect'} = $url;
                   8430: 	}
1.1075.2.161.  .9(raebu 8431:22):         $result.=<<"ADDMETA";
1.313     albertel 8432: <meta http-equiv="pragma" content="no-cache" />
1.1075.2.161.  .9(raebu 8433:22): ADDMETA
                   8434:22):         if ($to_opener) {
                   8435:22):             $env{'internal.head.to_opener'} = 1;
                   8436:22):             my $dest = &js_escape($url);
                   8437:22):             my $timeout = int($time * 1000);
                   8438:22):             $result .=<<"ENDJS";
                   8439:22): <script type="text/javascript">
                   8440:22): // <![CDATA[
                   8441:22): function LC_To_Opener() {
                   8442:22):     var dest = '$dest';
                   8443:22):     if (dest != '') {
                   8444:22):         if (window.opener != null && !window.opener.closed) {
                   8445:22):             window.opener.location.href=dest;
                   8446:22):             window.close();
                   8447:22):         } else {
                   8448:22):             window.location.href=dest;
                   8449:22):         }
                   8450:22):     }
                   8451:22): }
                   8452:22): \$(document).ready(function () {
                   8453:22):     setTimeout('LC_To_Opener()',$timeout);
                   8454:22): });
                   8455:22): // ]]>
                   8456:22): </script>
                   8457:22): ENDJS
                   8458:22):         } else {
                   8459:22):             $result.=<<"ADDMETA";
1.344     albertel 8460: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 8461: ADDMETA
1.1075.2.161.  .9(raebu 8462:22):         }
1.1075.2.89  raeburn  8463:     } else {
                   8464:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
                   8465:             my $requrl = $env{'request.uri'};
                   8466:             if ($requrl eq '') {
                   8467:                 $requrl = $ENV{'REQUEST_URI'};
                   8468:                 $requrl =~ s/\?.+$//;
                   8469:             }
                   8470:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
                   8471:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
                   8472:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
                   8473:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
                   8474:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
                   8475:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1075.2.145  raeburn  8476:                     my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1075.2.151  raeburn  8477:                     my ($offload,$offloadoth);
1.1075.2.89  raeburn  8478:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
                   8479:                         if ($domdefs{'offloadnow'}{$lonhost}) {
1.1075.2.145  raeburn  8480:                             $offload = 1;
1.1075.2.151  raeburn  8481:                             if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8482:                                 (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8483:                                 unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8484:                                     $offloadoth = 1;
                   8485:                                     $dom_in_use = $env{'user.domain'};
                   8486:                                 }
                   8487:                             }
1.1075.2.145  raeburn  8488:                         }
                   8489:                     }
                   8490:                     unless ($offload) {
                   8491:                         if (ref($domdefs{'offloadoth'}) eq 'HASH') {
                   8492:                             if ($domdefs{'offloadoth'}{$lonhost}) {
                   8493:                                 if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8494:                                     (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8495:                                     unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8496:                                         $offload = 1;
1.1075.2.151  raeburn  8497:                                         $offloadoth = 1;
1.1075.2.145  raeburn  8498:                                         $dom_in_use = $env{'user.domain'};
                   8499:                                     }
1.1075.2.89  raeburn  8500:                                 }
1.1075.2.145  raeburn  8501:                             }
                   8502:                         }
                   8503:                     }
                   8504:                     if ($offload) {
1.1075.2.158  raeburn  8505:                         my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1075.2.151  raeburn  8506:                         if (($newserver eq '') && ($offloadoth)) {
                   8507:                             my @domains = &Apache::lonnet::current_machine_domains();
1.1075.2.161.  .1(raebu 8508:21):                             if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
1.1075.2.151  raeburn  8509:                                 ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
                   8510:                             }
                   8511:                         }
1.1075.2.145  raeburn  8512:                         if (($newserver) && ($newserver ne $lonhost)) {
                   8513:                             my $numsec = 5;
                   8514:                             my $timeout = $numsec * 1000;
                   8515:                             my ($newurl,$locknum,%locks,$msg);
                   8516:                             if ($env{'request.role.adv'}) {
                   8517:                                 ($locknum,%locks) = &Apache::lonnet::get_locks();
                   8518:                             }
                   8519:                             my $disable_submit = 0;
                   8520:                             if ($requrl =~ /$LONCAPA::assess_re/) {
                   8521:                                 $disable_submit = 1;
                   8522:                             }
                   8523:                             if ($locknum) {
                   8524:                                 my @lockinfo = sort(values(%locks));
1.1075.2.153  raeburn  8525:                                 $msg = &mt('Once the following tasks are complete:')." \n".
1.1075.2.145  raeburn  8526:                                        join(", ",sort(values(%locks)))."\n";
                   8527:                                 if (&show_course()) {
                   8528:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
1.1075.2.89  raeburn  8529:                                 } else {
1.1075.2.145  raeburn  8530:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
                   8531:                                 }
                   8532:                             } else {
                   8533:                                 if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
                   8534:                                     $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
                   8535:                                 }
                   8536:                                 $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
                   8537:                                 $newurl = '/adm/switchserver?otherserver='.$newserver;
                   8538:                                 if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
                   8539:                                     $newurl .= '&role='.$env{'request.role'};
                   8540:                                 }
                   8541:                                 if ($env{'request.symb'}) {
                   8542:                                     my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
                   8543:                                     if ($shownsymb =~ m{^/enc/}) {
                   8544:                                         my $reqdmajor = 2;
                   8545:                                         my $reqdminor = 11;
                   8546:                                         my $reqdsubminor = 3;
                   8547:                                         my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
                   8548:                                         my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
                   8549:                                         my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
                   8550:                                         if (($major eq '' && $minor eq '') ||
                   8551:                                             (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
                   8552:                                             (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
                   8553:                                              ($reqdsubminor > $subminor))))) {
                   8554:                                             undef($shownsymb);
                   8555:                                         }
1.1075.2.89  raeburn  8556:                                     }
1.1075.2.145  raeburn  8557:                                     if ($shownsymb) {
                   8558:                                         &js_escape(\$shownsymb);
                   8559:                                         $newurl .= '&symb='.$shownsymb;
1.1075.2.89  raeburn  8560:                                     }
1.1075.2.145  raeburn  8561:                                 } else {
                   8562:                                     my $shownurl = &Apache::lonenc::check_encrypt($requrl);
                   8563:                                     &js_escape(\$shownurl);
                   8564:                                     $newurl .= '&origurl='.$shownurl;
1.1075.2.89  raeburn  8565:                                 }
1.1075.2.145  raeburn  8566:                             }
                   8567:                             &js_escape(\$msg);
                   8568:                             $result.=<<OFFLOAD
1.1075.2.89  raeburn  8569: <meta http-equiv="pragma" content="no-cache" />
                   8570: <script type="text/javascript">
1.1075.2.92  raeburn  8571: // <![CDATA[
1.1075.2.89  raeburn  8572: function LC_Offload_Now() {
                   8573:     var dest = "$newurl";
                   8574:     if (dest != '') {
                   8575:         window.location.href="$newurl";
                   8576:     }
                   8577: }
1.1075.2.92  raeburn  8578: \$(document).ready(function () {
                   8579:     window.alert('$msg');
                   8580:     if ($disable_submit) {
1.1075.2.89  raeburn  8581:         \$(".LC_hwk_submit").prop("disabled", true);
                   8582:         \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1075.2.92  raeburn  8583:     }
                   8584:     setTimeout('LC_Offload_Now()', $timeout);
                   8585: });
                   8586: // ]]>
1.1075.2.89  raeburn  8587: </script>
                   8588: OFFLOAD
                   8589:                         }
                   8590:                     }
                   8591:                 }
                   8592:             }
                   8593:         }
1.313     albertel 8594:     }
1.306     albertel 8595:     if (!defined($title)) {
                   8596: 	$title = 'The LearningOnline Network with CAPA';
                   8597:     }
1.460     albertel 8598:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   8599:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.1075.2.61  raeburn  8600: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'"';
                   8601:     if (!$args->{'frameset'}) {
                   8602:         $result .= ' /';
                   8603:     }
                   8604:     $result .= '>'
1.1064    raeburn  8605:         .$inhibitprint
1.414     albertel 8606: 	.$head_extra;
1.1075.2.108  raeburn  8607:     my $clientmobile;
                   8608:     if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   8609:         (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
                   8610:     } else {
                   8611:         $clientmobile = $env{'browser.mobile'};
                   8612:     }
                   8613:     if ($clientmobile) {
1.1075.2.42  raeburn  8614:         $result .= '
                   8615: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
                   8616: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   8617:     }
1.1075.2.126  raeburn  8618:     $result .= '<meta name="google" content="notranslate" />'."\n";
1.962     droeschl 8619:     return $result.'</head>';
1.306     albertel 8620: }
                   8621: 
                   8622: =pod
                   8623: 
1.340     albertel 8624: =item * &font_settings()
                   8625: 
                   8626: Returns neccessary <meta> to set the proper encoding
                   8627: 
1.1075.2.56  raeburn  8628: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 8629: 
                   8630: =cut
                   8631: 
                   8632: sub font_settings {
1.1075.2.56  raeburn  8633:     my ($args) = @_;
1.340     albertel 8634:     my $headerstring='';
1.1075.2.56  raeburn  8635:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   8636:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.340     albertel 8637: 	$headerstring.=
1.1075.2.61  raeburn  8638: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   8639:         if (!$args->{'frameset'}) {
                   8640:             $headerstring.= ' /';
                   8641:         }
                   8642:         $headerstring .= '>'."\n";
1.340     albertel 8643:     }
                   8644:     return $headerstring;
                   8645: }
                   8646: 
1.341     albertel 8647: =pod
                   8648: 
1.1064    raeburn  8649: =item * &print_suppression()
                   8650: 
                   8651: In course context returns css which causes the body to be blank when media="print",
                   8652: if printout generation is unavailable for the current resource.
                   8653: 
                   8654: This could be because:
                   8655: 
                   8656: (a) printstartdate is in the future
                   8657: 
                   8658: (b) printenddate is in the past
                   8659: 
                   8660: (c) there is an active exam block with "printout"
                   8661: functionality blocked
                   8662: 
                   8663: Users with pav, pfo or evb privileges are exempt.
                   8664: 
                   8665: Inputs: none
                   8666: 
                   8667: =cut
                   8668: 
                   8669: 
                   8670: sub print_suppression {
                   8671:     my $noprint;
                   8672:     if ($env{'request.course.id'}) {
                   8673:         my $scope = $env{'request.course.id'};
                   8674:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8675:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   8676:             return;
                   8677:         }
                   8678:         if ($env{'request.course.sec'} ne '') {
                   8679:             $scope .= "/$env{'request.course.sec'}";
                   8680:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8681:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  8682:                 return;
1.1064    raeburn  8683:             }
                   8684:         }
                   8685:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8686:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.158  raeburn  8687:         my $clientip = &Apache::lonnet::get_requestor_ip();
                   8688:         my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064    raeburn  8689:         if ($blocked) {
                   8690:             my $checkrole = "cm./$cdom/$cnum";
                   8691:             if ($env{'request.course.sec'} ne '') {
                   8692:                 $checkrole .= "/$env{'request.course.sec'}";
                   8693:             }
                   8694:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   8695:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   8696:                 $noprint = 1;
                   8697:             }
                   8698:         }
                   8699:         unless ($noprint) {
                   8700:             my $symb = &Apache::lonnet::symbread();
                   8701:             if ($symb ne '') {
                   8702:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   8703:                 if (ref($navmap)) {
                   8704:                     my $res = $navmap->getBySymb($symb);
                   8705:                     if (ref($res)) {
                   8706:                         if (!$res->resprintable()) {
                   8707:                             $noprint = 1;
                   8708:                         }
                   8709:                     }
                   8710:                 }
                   8711:             }
                   8712:         }
                   8713:         if ($noprint) {
                   8714:             return <<"ENDSTYLE";
                   8715: <style type="text/css" media="print">
                   8716:     body { display:none }
                   8717: </style>
                   8718: ENDSTYLE
                   8719:         }
                   8720:     }
                   8721:     return;
                   8722: }
                   8723: 
                   8724: =pod
                   8725: 
1.341     albertel 8726: =item * &xml_begin()
                   8727: 
                   8728: Returns the needed doctype and <html>
                   8729: 
                   8730: Inputs: none
                   8731: 
                   8732: =cut
                   8733: 
                   8734: sub xml_begin {
1.1075.2.61  raeburn  8735:     my ($is_frameset) = @_;
1.341     albertel 8736:     my $output='';
                   8737: 
                   8738:     if ($env{'browser.mathml'}) {
                   8739: 	$output='<?xml version="1.0"?>'
                   8740:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   8741: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   8742:             
                   8743: #	    .'<!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">] >'
                   8744: 	    .'<!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">'
                   8745:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   8746: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1075.2.61  raeburn  8747:     } elsif ($is_frameset) {
                   8748:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
                   8749:                 '<html>'."\n";
1.341     albertel 8750:     } else {
1.1075.2.61  raeburn  8751: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   8752:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 8753:     }
                   8754:     return $output;
                   8755: }
1.340     albertel 8756: 
                   8757: =pod
                   8758: 
1.306     albertel 8759: =item * &start_page()
                   8760: 
                   8761: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   8762: 
1.648     raeburn  8763: Inputs:
                   8764: 
                   8765: =over 4
                   8766: 
                   8767: $title - optional title for the page
                   8768: 
                   8769: $head_extra - optional extra HTML to incude inside the <head>
                   8770: 
                   8771: $args - additional optional args supported are:
                   8772: 
                   8773: =over 8
                   8774: 
                   8775:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 8776:                                     arg on
1.814     bisitz   8777:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  8778:              add_entries    -> additional attributes to add to the  <body>
                   8779:              domain         -> force to color decorate a page for a 
1.317     albertel 8780:                                     specific domain
1.648     raeburn  8781:              function       -> force usage of a specific rolish color
1.317     albertel 8782:                                     scheme
1.648     raeburn  8783:              redirect       -> see &headtag()
                   8784:              bgcolor        -> override the default page bg color
                   8785:              js_ready       -> return a string ready for being used in 
1.317     albertel 8786:                                     a javascript writeln
1.648     raeburn  8787:              html_encode    -> return a string ready for being used in 
1.320     albertel 8788:                                     a html attribute
1.648     raeburn  8789:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 8790:                                     $forcereg arg
1.648     raeburn  8791:              frameset       -> if true will start with a <frameset>
1.330     albertel 8792:                                     rather than <body>
1.648     raeburn  8793:              skip_phases    -> hash ref of 
1.338     albertel 8794:                                     head -> skip the <html><head> generation
                   8795:                                     body -> skip all <body> generation
1.1075.2.12  raeburn  8796:              no_inline_link -> if true and in remote mode, don't show the
                   8797:                                     'Switch To Inline Menu' link
1.648     raeburn  8798:              no_auto_mt_title -> prevent &mt()ing the title arg
1.867     kalberla 8799:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  8800:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1075.2.123  raeburn  8801:              bread_crumbs_nomenu -> if true will pass false as the value of $menulink
                   8802:                                     to lonhtmlcommon::breadcrumbs
1.1075.2.15  raeburn  8803:              group          -> includes the current group, if page is for a
                   8804:                                specific group
1.1075.2.133  raeburn  8805:              use_absolute   -> for request for external resource or syllabus, this
                   8806:                                will contain https://<hostname> if server uses
                   8807:                                https (as per hosts.tab), but request is for http
                   8808:              hostname       -> hostname, originally from $r->hostname(), (optional).
1.1075.2.158  raeburn  8809:              links_disabled -> Links in primary and secondary menus are disabled
                   8810:                                (Can enable them once page has loaded - see lonroles.pm
                   8811:                                for an example).
1.1075.2.161.  .6(raebu 8812:22):              links_target   -> Target for links, e.g., _parent (optional).
1.361     albertel 8813: 
1.648     raeburn  8814: =back
1.460     albertel 8815: 
1.648     raeburn  8816: =back
1.562     albertel 8817: 
1.306     albertel 8818: =cut
                   8819: 
                   8820: sub start_page {
1.309     albertel 8821:     my ($title,$head_extra,$args) = @_;
1.318     albertel 8822:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 8823: 
1.315     albertel 8824:     $env{'internal.start_page'}++;
1.1075.2.161.  .1(raebu 8825:21):     my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964     droeschl 8826: 
1.338     albertel 8827:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1075.2.62  raeburn  8828:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 8829:     }
1.1075.2.161.  .1(raebu 8830:21): 
                   8831:21):     if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
                   8832:21):         if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
                   8833:21):             unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
                   8834:21):                 $args->{'no_primary_menu'} = 1;
                   8835:21):             }
                   8836:21):             unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
                   8837:21):                 $args->{'no_inline_menu'} = 1;
                   8838:21):             }
                   8839:21):             if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
                   8840:21):                 map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
                   8841:21):             }
                   8842:21):         } else {
                   8843:21):             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8844:21):             my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
                   8845:21):             if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
                   8846:21):                 unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
                   8847:21):                     $args->{'no_primary_menu'} = 1;
                   8848:21):                 }
                   8849:21):                 unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
                   8850:21):                     $args->{'no_inline_menu'} = 1;
                   8851:21):                 }
                   8852:21):                 if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
                   8853:21):                     map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
                   8854:21):                 }
                   8855:21):             }
                   8856:21):         }
                   8857:21):         ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
                   8858:21):                                   $env{'course.'.$env{'request.course.id'}.'.domain'},
                   8859:21):                                   $env{'course.'.$env{'request.course.id'}.'.num'});
                   8860:21):     } elsif ($env{'request.course.id'}) {
                   8861:21):         my $expiretime=600;
                   8862:21):         if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
                   8863:21):             &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
                   8864:21):         }
                   8865:21):         my ($deeplinkmenu,$menuref);
                   8866:21):         ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
                   8867:21):         if ($menucoll) {
                   8868:21):             if (ref($menuref) eq 'HASH') {
                   8869:21):                 %menu = %{$menuref};
                   8870:21):             }
                   8871:21):             if ($menu{'top'} eq 'n') {
                   8872:21):                 $args->{'no_primary_menu'} = 1;
                   8873:21):             }
                   8874:21):             if ($menu{'inline'} eq 'n') {
                   8875:21):                 unless (&Apache::lonnet::allowed('opa')) {
                   8876:21):                     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8877:21):                     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   8878:21):                     my $crstype = &course_type();
                   8879:21):                     my $now = time;
                   8880:21):                     my $ccrole;
                   8881:21):                     if ($crstype eq 'Community') {
                   8882:21):                         $ccrole = 'co';
                   8883:21):                     } else {
                   8884:21):                         $ccrole = 'cc';
                   8885:21):                     }
                   8886:21):                     if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
                   8887:21):                         my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
                   8888:21):                         if ((($start) && ($start<0)) ||
                   8889:21):                             (($end) && ($end<$now))  ||
                   8890:21):                             (($start) && ($now<$start))) {
                   8891:21):                             $args->{'no_inline_menu'} = 1;
                   8892:21):                         }
                   8893:21):                     } else {
                   8894:21):                         $args->{'no_inline_menu'} = 1;
                   8895:21):                     }
                   8896:21):                 }
                   8897:21):             }
                   8898:21):         }
                   8899:21):     }
          .4(raebu 8900:22): 
          .8(raebu 8901:22):     my $showncrumbs;
1.338     albertel 8902:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   8903: 	if ($args->{'frameset'}) {
                   8904: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   8905: 						$args->{'add_entries'});
                   8906: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   8907:         } else {
                   8908:             $result .=
                   8909:                 &bodytag($title, 
                   8910:                          $args->{'function'},       $args->{'add_entries'},
                   8911:                          $args->{'only_body'},      $args->{'domain'},
                   8912:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12  raeburn  8913:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
1.1075.2.161.  .1(raebu 8914:21):                          $args,                     \@advtools,
          .8(raebu 8915:22):                          $ltiscope,$ltiuri,\%ltimenu,$menucoll,\%menu,\$showncrumbs);
1.831     bisitz   8916:         }
1.330     albertel 8917:     }
1.338     albertel 8918: 
1.315     albertel 8919:     if ($args->{'js_ready'}) {
1.713     kaisler  8920: 		$result = &js_ready($result);
1.315     albertel 8921:     }
1.320     albertel 8922:     if ($args->{'html_encode'}) {
1.713     kaisler  8923: 		$result = &html_encode($result);
                   8924:     }
                   8925: 
1.813     bisitz   8926:     # Preparation for new and consistent functionlist at top of screen
                   8927:     # if ($args->{'functionlist'}) {
                   8928:     #            $result .= &build_functionlist();
                   8929:     #}
                   8930: 
1.964     droeschl 8931:     # Don't add anything more if only_body wanted or in const space
                   8932:     return $result if    $args->{'only_body'} 
                   8933:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   8934: 
                   8935:     #Breadcrumbs
1.758     kaisler  8936:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1075.2.161.  .8(raebu 8937:22):         unless ($showncrumbs) {
1.758     kaisler  8938: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   8939: 		#if any br links exists, add them to the breadcrumbs
                   8940: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   8941: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   8942: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   8943: 			}
                   8944: 		}
1.1075.2.19  raeburn  8945:                 # if @advtools array contains items add then to the breadcrumbs
                   8946:                 if (@advtools > 0) {
                   8947:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   8948:                 }
1.1075.2.123  raeburn  8949:                 my $menulink;
                   8950:                 # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
1.1075.2.161.  .1(raebu 8951:21):                 if ((exists($args->{'bread_crumbs_nomenu'})) ||
                   8952:21):                     ($ltiscope eq 'map') || ($ltiscope eq 'resource')) {
1.1075.2.123  raeburn  8953:                     $menulink = 0;
                   8954:                 } else {
                   8955:                     undef($menulink);
                   8956:                 }
1.1075.2.161.  .8(raebu 8957:22):                 my $linkprotout;
                   8958:22):                 if ($env{'request.deeplink.login'}) {
                   8959:22):                     my $linkprotout = &Apache::lonmenu::linkprot_exit();
                   8960:22):                     if ($linkprotout) {
                   8961:22):                         &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
                   8962:22):                     }
                   8963:22):                 }
1.758     kaisler  8964: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   8965: 		if(exists($args->{'bread_crumbs_component'})){
1.1075.2.123  raeburn  8966: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.1075.2.161.  .1(raebu 8967:21): 		} else {
1.1075.2.123  raeburn  8968: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758     kaisler  8969: 		}
1.1075.2.161.  .8(raebu 8970:22):         }
1.1075.2.24  raeburn  8971:     } elsif (($env{'environment.remote'} eq 'on') &&
                   8972:              ($env{'form.inhibitmenu'} ne 'yes') &&
                   8973:              ($env{'request.noversionuri'} =~ m{^/res/}) &&
                   8974:              ($env{'request.noversionuri'} !~ m{^/res/adm/pages/})) {
1.1075.2.21  raeburn  8975:         $result .= '<div style="padding:0;margin:0;clear:both"><hr /></div>';
1.320     albertel 8976:     }
1.315     albertel 8977:     return $result;
1.306     albertel 8978: }
                   8979: 
                   8980: sub end_page {
1.315     albertel 8981:     my ($args) = @_;
                   8982:     $env{'internal.end_page'}++;
1.330     albertel 8983:     my $result;
1.335     albertel 8984:     if ($args->{'discussion'}) {
                   8985: 	my ($target,$parser);
                   8986: 	if (ref($args->{'discussion'})) {
                   8987: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   8988: 				$args->{'discussion'}{'parser'});
                   8989: 	}
                   8990: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   8991:     }
1.330     albertel 8992:     if ($args->{'frameset'}) {
                   8993: 	$result .= '</frameset>';
                   8994:     } else {
1.635     raeburn  8995: 	$result .= &endbodytag($args);
1.330     albertel 8996:     }
1.1075.2.6  raeburn  8997:     unless ($args->{'notbody'}) {
                   8998:         $result .= "\n</html>";
                   8999:     }
1.330     albertel 9000: 
1.315     albertel 9001:     if ($args->{'js_ready'}) {
1.317     albertel 9002: 	$result = &js_ready($result);
1.315     albertel 9003:     }
1.335     albertel 9004: 
1.320     albertel 9005:     if ($args->{'html_encode'}) {
                   9006: 	$result = &html_encode($result);
                   9007:     }
1.335     albertel 9008: 
1.315     albertel 9009:     return $result;
                   9010: }
                   9011: 
1.1075.2.161.  .1(raebu 9012:21): sub menucoll_in_effect {
                   9013:21):     my ($menucoll,$deeplinkmenu,%menu);
                   9014:21):     if ($env{'request.course.id'}) {
                   9015:21):         $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
                   9016:21):         if ($env{'request.deeplink.login'}) {
                   9017:21):             my ($deeplink_symb,$deeplink,$check_login_symb);
                   9018:21):             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   9019:21):             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   9020:21):             if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
                   9021:21):                 if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
                   9022:21):                     my $navmap = Apache::lonnavmaps::navmap->new();
                   9023:21):                     if (ref($navmap)) {
                   9024:21):                         $deeplink = $navmap->get_mapparam(undef,
                   9025:21):                                                           &Apache::lonnet::declutter($env{'request.noversionuri'}),
                   9026:21):                                                           '0.deeplink');
                   9027:21):                     } else {
                   9028:21):                         $check_login_symb = 1;
                   9029:21):                     }
                   9030:21):                 } else {
                   9031:21):                     my $symb=&Apache::lonnet::symbread();
                   9032:21):                     if ($symb) {
                   9033:21):                         $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
                   9034:21):                     } else {
                   9035:21):                         $check_login_symb = 1;
                   9036:21):                     }
                   9037:21):                 }
                   9038:21):             } else {
                   9039:21):                 $check_login_symb = 1;
                   9040:21):             }
                   9041:21):             if ($check_login_symb) {
                   9042:21):                 $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
                   9043:21):                 if ($deeplink_symb =~ /\.(page|sequence)$/) {
                   9044:21):                     my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
                   9045:21):                     my $navmap = Apache::lonnavmaps::navmap->new();
                   9046:21):                     if (ref($navmap)) {
                   9047:21):                         $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
                   9048:21):                     }
                   9049:21):                 } else {
                   9050:21):                     $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
                   9051:21):                 }
                   9052:21):             }
                   9053:21):             if ($deeplink ne '') {
          .6(raebu 9054:22):                 my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
          .1(raebu 9055:21):                 if ($display =~ /^\d+$/) {
                   9056:21):                     $deeplinkmenu = 1;
                   9057:21):                     $menucoll = $display;
                   9058:21):                 }
                   9059:21):             }
                   9060:21):         }
                   9061:21):         if ($menucoll) {
                   9062:21):             %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
                   9063:21):         }
                   9064:21):     }
                   9065:21):     return ($menucoll,$deeplinkmenu,\%menu);
                   9066:21): }
                   9067:21): 
                   9068:21): sub deeplink_login_symb {
                   9069:21):     my ($cnum,$cdom) = @_;
                   9070:21):     my $login_symb;
                   9071:21):     if ($env{'request.deeplink.login'}) {
                   9072:21):         $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
                   9073:21):     }
                   9074:21):     return $login_symb;
                   9075:21): }
                   9076:21): 
                   9077:21): sub symb_from_tinyurl {
                   9078:21):     my ($url,$cnum,$cdom) = @_;
                   9079:21):     if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
                   9080:21):         my $key = $1;
                   9081:21):         my ($tinyurl,$login);
                   9082:21):         my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
                   9083:21):         if (defined($cached)) {
                   9084:21):             $tinyurl = $result;
                   9085:21):         } else {
                   9086:21):             my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
                   9087:21):             my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
                   9088:21):             if ($currtiny{$key} ne '') {
                   9089:21):                 $tinyurl = $currtiny{$key};
                   9090:21):                 &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
                   9091:21):             }
                   9092:21):         }
                   9093:21):         if ($tinyurl ne '') {
                   9094:21):             my ($cnumreq,$symb) = split(/\&/,$tinyurl);
                   9095:21):             if (wantarray) {
                   9096:21):                 return ($cnumreq,$symb);
                   9097:21):             } elsif ($cnumreq eq $cnum) {
                   9098:21):                 return $symb;
                   9099:21):             }
                   9100:21):         }
                   9101:21):     }
                   9102:21):     if (wantarray) {
                   9103:21):         return ();
                   9104:21):     } else {
                   9105:21):         return;
                   9106:21):     }
                   9107:21): }
                   9108:21): 
1.1034    www      9109: sub wishlist_window {
                   9110:     return(<<'ENDWISHLIST');
1.1046    raeburn  9111: <script type="text/javascript">
1.1034    www      9112: // <![CDATA[
                   9113: // <!-- BEGIN LON-CAPA Internal
                   9114: function set_wishlistlink(title, path) {
                   9115:     if (!title) {
                   9116:         title = document.title;
                   9117:         title = title.replace(/^LON-CAPA /,'');
                   9118:     }
1.1075.2.65  raeburn  9119:     title = encodeURIComponent(title);
1.1075.2.83  raeburn  9120:     title = title.replace("'","\\\'");
1.1034    www      9121:     if (!path) {
                   9122:         path = location.pathname;
                   9123:     }
1.1075.2.65  raeburn  9124:     path = encodeURIComponent(path);
1.1075.2.83  raeburn  9125:     path = path.replace("'","\\\'");
1.1034    www      9126:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   9127:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   9128: }
                   9129: // END LON-CAPA Internal -->
                   9130: // ]]>
                   9131: </script>
                   9132: ENDWISHLIST
                   9133: }
                   9134: 
1.1030    www      9135: sub modal_window {
                   9136:     return(<<'ENDMODAL');
1.1046    raeburn  9137: <script type="text/javascript">
1.1030    www      9138: // <![CDATA[
                   9139: // <!-- BEGIN LON-CAPA Internal
                   9140: var modalWindow = {
                   9141: 	parent:"body",
                   9142: 	windowId:null,
                   9143: 	content:null,
                   9144: 	width:null,
                   9145: 	height:null,
                   9146: 	close:function()
                   9147: 	{
                   9148: 	        $(".LCmodal-window").remove();
                   9149: 	        $(".LCmodal-overlay").remove();
                   9150: 	},
                   9151: 	open:function()
                   9152: 	{
                   9153: 		var modal = "";
                   9154: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   9155: 		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;\">";
                   9156: 		modal += this.content;
                   9157: 		modal += "</div>";	
                   9158: 
                   9159: 		$(this.parent).append(modal);
                   9160: 
                   9161: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   9162: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   9163: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   9164: 	}
                   9165: };
1.1075.2.42  raeburn  9166: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      9167: 	{
1.1075.2.119  raeburn  9168:                 source = source.replace(/'/g,"&#39;");
1.1030    www      9169: 		modalWindow.windowId = "myModal";
                   9170: 		modalWindow.width = width;
                   9171: 		modalWindow.height = height;
1.1075.2.80  raeburn  9172: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      9173: 		modalWindow.open();
1.1075.2.87  raeburn  9174: 	};
1.1030    www      9175: // END LON-CAPA Internal -->
                   9176: // ]]>
                   9177: </script>
                   9178: ENDMODAL
                   9179: }
                   9180: 
                   9181: sub modal_link {
1.1075.2.42  raeburn  9182:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      9183:     unless ($width) { $width=480; }
                   9184:     unless ($height) { $height=400; }
1.1031    www      9185:     unless ($scrolling) { $scrolling='yes'; }
1.1075.2.42  raeburn  9186:     unless ($transparency) { $transparency='true'; }
                   9187: 
1.1074    raeburn  9188:     my $target_attr;
                   9189:     if (defined($target)) {
                   9190:         $target_attr = 'target="'.$target.'"';
                   9191:     }
                   9192:     return <<"ENDLINK";
1.1075.2.143  raeburn  9193: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074    raeburn  9194: ENDLINK
1.1030    www      9195: }
                   9196: 
1.1032    www      9197: sub modal_adhoc_script {
1.1075.2.155  raeburn  9198:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
                   9199:     my $mathjax;
                   9200:     if ($possmathjax) {
                   9201:         $mathjax = <<'ENDJAX';
                   9202:                if (typeof MathJax == 'object') {
                   9203:                    MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
                   9204:                }
                   9205: ENDJAX
                   9206:     }
1.1032    www      9207:     return (<<ENDADHOC);
1.1046    raeburn  9208: <script type="text/javascript">
1.1032    www      9209: // <![CDATA[
                   9210:         var $funcname = function()
                   9211:         {
                   9212:                 modalWindow.windowId = "myModal";
                   9213:                 modalWindow.width = $width;
                   9214:                 modalWindow.height = $height;
                   9215:                 modalWindow.content = '$content';
                   9216:                 modalWindow.open();
1.1075.2.155  raeburn  9217:                 $mathjax
1.1032    www      9218:         };  
                   9219: // ]]>
                   9220: </script>
                   9221: ENDADHOC
                   9222: }
                   9223: 
1.1041    www      9224: sub modal_adhoc_inner {
1.1075.2.155  raeburn  9225:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041    www      9226:     my $innerwidth=$width-20;
                   9227:     $content=&js_ready(
1.1042    www      9228:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1075.2.42  raeburn  9229:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   9230:                  $content.
1.1041    www      9231:                  &end_scrollbox().
1.1075.2.42  raeburn  9232:                  &end_page()
1.1041    www      9233:              );
1.1075.2.155  raeburn  9234:     return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041    www      9235: }
                   9236: 
                   9237: sub modal_adhoc_window {
1.1075.2.155  raeburn  9238:     my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
                   9239:     return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041    www      9240:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   9241: }
                   9242: 
                   9243: sub modal_adhoc_launch {
                   9244:     my ($funcname,$width,$height,$content)=@_;
                   9245:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   9246: <script type="text/javascript">
                   9247: // <![CDATA[
                   9248: $funcname();
                   9249: // ]]>
                   9250: </script>
                   9251: ENDLAUNCH
                   9252: }
                   9253: 
                   9254: sub modal_adhoc_close {
                   9255:     return (<<ENDCLOSE);
                   9256: <script type="text/javascript">
                   9257: // <![CDATA[
                   9258: modalWindow.close();
                   9259: // ]]>
                   9260: </script>
                   9261: ENDCLOSE
                   9262: }
                   9263: 
1.1038    www      9264: sub togglebox_script {
                   9265:    return(<<ENDTOGGLE);
                   9266: <script type="text/javascript"> 
                   9267: // <![CDATA[
                   9268: function LCtoggleDisplay(id,hidetext,showtext) {
                   9269:    link = document.getElementById(id + "link").childNodes[0];
                   9270:    with (document.getElementById(id).style) {
                   9271:       if (display == "none" ) {
                   9272:           display = "inline";
                   9273:           link.nodeValue = hidetext;
                   9274:         } else {
                   9275:           display = "none";
                   9276:           link.nodeValue = showtext;
                   9277:        }
                   9278:    }
                   9279: }
                   9280: // ]]>
                   9281: </script>
                   9282: ENDTOGGLE
                   9283: }
                   9284: 
1.1039    www      9285: sub start_togglebox {
                   9286:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   9287:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   9288:     unless ($showtext) { $showtext=&mt('show'); }
                   9289:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   9290:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   9291:     return &start_data_table().
                   9292:            &start_data_table_header_row().
                   9293:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   9294:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   9295:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   9296:            &end_data_table_header_row().
                   9297:            '<tr id="'.$id.'" style="display:none""><td>';
                   9298: }
                   9299: 
                   9300: sub end_togglebox {
                   9301:     return '</td></tr>'.&end_data_table();
                   9302: }
                   9303: 
1.1041    www      9304: sub LCprogressbar_script {
1.1075.2.130  raeburn  9305:    my ($id,$number_to_do)=@_;
                   9306:    if ($number_to_do) {
                   9307:        return(<<ENDPROGRESS);
1.1041    www      9308: <script type="text/javascript">
                   9309: // <![CDATA[
1.1045    www      9310: \$('#progressbar$id').progressbar({
1.1041    www      9311:   value: 0,
                   9312:   change: function(event, ui) {
                   9313:     var newVal = \$(this).progressbar('option', 'value');
                   9314:     \$('.pblabel', this).text(LCprogressTxt);
                   9315:   }
                   9316: });
                   9317: // ]]>
                   9318: </script>
                   9319: ENDPROGRESS
1.1075.2.130  raeburn  9320:    } else {
                   9321:        return(<<ENDPROGRESS);
                   9322: <script type="text/javascript">
                   9323: // <![CDATA[
                   9324: \$('#progressbar$id').progressbar({
                   9325:   value: false,
                   9326:   create: function(event, ui) {
                   9327:     \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
                   9328:     \$('.ui-progressbar-overlay', this).css({'margin':'0'});
                   9329:   }
                   9330: });
                   9331: // ]]>
                   9332: </script>
                   9333: ENDPROGRESS
                   9334:    }
1.1041    www      9335: }
                   9336: 
                   9337: sub LCprogressbarUpdate_script {
                   9338:    return(<<ENDPROGRESSUPDATE);
                   9339: <style type="text/css">
                   9340: .ui-progressbar { position:relative; }
1.1075.2.130  raeburn  9341: .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      9342: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   9343: </style>
                   9344: <script type="text/javascript">
                   9345: // <![CDATA[
1.1045    www      9346: var LCprogressTxt='---';
                   9347: 
1.1075.2.130  raeburn  9348: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041    www      9349:    LCprogressTxt=progresstext;
1.1075.2.130  raeburn  9350:    if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
                   9351:        \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
                   9352:    } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
                   9353:        \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
                   9354:    } else {
                   9355:        \$('#progressbar'+id).progressbar('value',percent);
                   9356:    }
1.1041    www      9357: }
                   9358: // ]]>
                   9359: </script>
                   9360: ENDPROGRESSUPDATE
                   9361: }
                   9362: 
1.1042    www      9363: my $LClastpercent;
1.1045    www      9364: my $LCidcnt;
                   9365: my $LCcurrentid;
1.1042    www      9366: 
1.1041    www      9367: sub LCprogressbar {
1.1075.2.130  raeburn  9368:     my ($r,$number_to_do,$preamble)=@_;
1.1042    www      9369:     $LClastpercent=0;
1.1045    www      9370:     $LCidcnt++;
                   9371:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1075.2.130  raeburn  9372:     my ($starting,$content);
                   9373:     if ($number_to_do) {
                   9374:         $starting=&mt('Starting');
                   9375:         $content=(<<ENDPROGBAR);
                   9376: $preamble
1.1045    www      9377:   <div id="progressbar$LCcurrentid">
1.1041    www      9378:     <span class="pblabel">$starting</span>
                   9379:   </div>
                   9380: ENDPROGBAR
1.1075.2.130  raeburn  9381:     } else {
                   9382:         $starting=&mt('Loading...');
                   9383:         $LClastpercent='false';
                   9384:         $content=(<<ENDPROGBAR);
                   9385: $preamble
                   9386:   <div id="progressbar$LCcurrentid">
                   9387:       <div class="progress-label">$starting</div>
                   9388:   </div>
                   9389: ENDPROGBAR
                   9390:     }
                   9391:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041    www      9392: }
                   9393: 
                   9394: sub LCprogressbarUpdate {
1.1075.2.130  raeburn  9395:     my ($r,$val,$text,$number_to_do)=@_;
                   9396:     if ($number_to_do) {
                   9397:         unless ($val) { 
                   9398:             if ($LClastpercent) {
                   9399:                 $val=$LClastpercent;
                   9400:             } else {
                   9401:                 $val=0;
                   9402:             }
                   9403:         }
                   9404:         if ($val<0) { $val=0; }
                   9405:         if ($val>100) { $val=0; }
                   9406:         $LClastpercent=$val;
                   9407:         unless ($text) { $text=$val.'%'; }
                   9408:     } else {
                   9409:         $val = 'false';
1.1042    www      9410:     }
1.1041    www      9411:     $text=&js_ready($text);
1.1044    www      9412:     &r_print($r,<<ENDUPDATE);
1.1041    www      9413: <script type="text/javascript">
                   9414: // <![CDATA[
1.1075.2.130  raeburn  9415: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041    www      9416: // ]]>
                   9417: </script>
                   9418: ENDUPDATE
1.1035    www      9419: }
                   9420: 
1.1042    www      9421: sub LCprogressbarClose {
                   9422:     my ($r)=@_;
                   9423:     $LClastpercent=0;
1.1044    www      9424:     &r_print($r,<<ENDCLOSE);
1.1042    www      9425: <script type="text/javascript">
                   9426: // <![CDATA[
1.1045    www      9427: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      9428: // ]]>
                   9429: </script>
                   9430: ENDCLOSE
1.1044    www      9431: }
                   9432: 
                   9433: sub r_print {
                   9434:     my ($r,$to_print)=@_;
                   9435:     if ($r) {
                   9436:       $r->print($to_print);
                   9437:       $r->rflush();
                   9438:     } else {
                   9439:       print($to_print);
                   9440:     }
1.1042    www      9441: }
                   9442: 
1.320     albertel 9443: sub html_encode {
                   9444:     my ($result) = @_;
                   9445: 
1.322     albertel 9446:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 9447:     
                   9448:     return $result;
                   9449: }
1.1044    www      9450: 
1.317     albertel 9451: sub js_ready {
                   9452:     my ($result) = @_;
                   9453: 
1.323     albertel 9454:     $result =~ s/[\n\r]/ /xmsg;
                   9455:     $result =~ s/\\/\\\\/xmsg;
                   9456:     $result =~ s/'/\\'/xmsg;
1.372     albertel 9457:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 9458:     
                   9459:     return $result;
                   9460: }
                   9461: 
1.315     albertel 9462: sub validate_page {
                   9463:     if (  exists($env{'internal.start_page'})
1.316     albertel 9464: 	  &&     $env{'internal.start_page'} > 1) {
                   9465: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 9466: 				 $env{'internal.start_page'}.' '.
1.316     albertel 9467: 				 $ENV{'request.filename'});
1.315     albertel 9468:     }
                   9469:     if (  exists($env{'internal.end_page'})
1.316     albertel 9470: 	  &&     $env{'internal.end_page'} > 1) {
                   9471: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 9472: 				 $env{'internal.end_page'}.' '.
1.316     albertel 9473: 				 $env{'request.filename'});
1.315     albertel 9474:     }
                   9475:     if (     exists($env{'internal.start_page'})
                   9476: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 9477: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   9478: 				 $env{'request.filename'});
1.315     albertel 9479:     }
                   9480:     if (   ! exists($env{'internal.start_page'})
                   9481: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 9482: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   9483: 				 $env{'request.filename'});
1.315     albertel 9484:     }
1.306     albertel 9485: }
1.315     albertel 9486: 
1.996     www      9487: 
                   9488: sub start_scrollbox {
1.1075.2.56  raeburn  9489:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  9490:     unless ($outerwidth) { $outerwidth='520px'; }
                   9491:     unless ($width) { $width='500px'; }
                   9492:     unless ($height) { $height='200px'; }
1.1075    raeburn  9493:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  9494:     if ($id ne '') {
1.1075.2.42  raeburn  9495:         $table_id = ' id="table_'.$id.'"';
                   9496:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  9497:     }
1.1075    raeburn  9498:     if ($bgcolor ne '') {
                   9499:         $tdcol = "background-color: $bgcolor;";
                   9500:     }
1.1075.2.42  raeburn  9501:     my $nicescroll_js;
                   9502:     if ($env{'browser.mobile'}) {
                   9503:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   9504:     }
1.1075    raeburn  9505:     return <<"END";
1.1075.2.42  raeburn  9506: $nicescroll_js
                   9507: 
                   9508: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
1.1075.2.56  raeburn  9509: <div style="overflow:auto; width:$width; height:$height;"$div_id>
1.1075    raeburn  9510: END
1.996     www      9511: }
                   9512: 
                   9513: sub end_scrollbox {
1.1036    www      9514:     return '</div></td></tr></table>';
1.996     www      9515: }
                   9516: 
1.1075.2.42  raeburn  9517: sub nicescroll_javascript {
                   9518:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   9519:     my %options;
                   9520:     if (ref($cursor) eq 'HASH') {
                   9521:         %options = %{$cursor};
                   9522:     }
                   9523:     unless ($options{'railalign'} =~ /^left|right$/) {
                   9524:         $options{'railalign'} = 'left';
                   9525:     }
                   9526:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   9527:         my $function  = &get_users_function();
                   9528:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
                   9529:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   9530:             $options{'cursorcolor'} = '#00F';
                   9531:         }
                   9532:     }
                   9533:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   9534:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
                   9535:             $options{'cursoropacity'}='1.0';
                   9536:         }
                   9537:     } else {
                   9538:         $options{'cursoropacity'}='1.0';
                   9539:     }
                   9540:     if ($options{'cursorfixedheight'} eq 'none') {
                   9541:         delete($options{'cursorfixedheight'});
                   9542:     } else {
                   9543:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   9544:     }
                   9545:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   9546:         delete($options{'railoffset'});
                   9547:     }
                   9548:     my @niceoptions;
                   9549:     while (my($key,$value) = each(%options)) {
                   9550:         if ($value =~ /^\{.+\}$/) {
                   9551:             push(@niceoptions,$key.':'.$value);
                   9552:         } else {
                   9553:             push(@niceoptions,$key.':"'.$value.'"');
                   9554:         }
                   9555:     }
                   9556:     my $nicescroll_js = '
                   9557: $(document).ready(
                   9558:       function() {
                   9559:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   9560:       }
                   9561: );
                   9562: ';
                   9563:     if ($framecheck) {
                   9564:         $nicescroll_js .= '
                   9565: function expand_div(caller) {
                   9566:     if (top === self) {
                   9567:         document.getElementById("'.$id.'").style.width = "auto";
                   9568:         document.getElementById("'.$id.'").style.height = "auto";
                   9569:     } else {
                   9570:         try {
                   9571:             if (parent.frames) {
                   9572:                 if (parent.frames.length > 1) {
                   9573:                     var framesrc = parent.frames[1].location.href;
                   9574:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   9575:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   9576:                         document.getElementById("'.$id.'").style.width = "auto";
                   9577:                         document.getElementById("'.$id.'").style.height = "auto";
                   9578:                     }
                   9579:                 }
                   9580:             }
                   9581:         } catch (e) {
                   9582:             return;
                   9583:         }
                   9584:     }
                   9585:     return;
                   9586: }
                   9587: ';
                   9588:     }
                   9589:     if ($needjsready) {
                   9590:         $nicescroll_js = '
                   9591: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   9592:     } else {
                   9593:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   9594:     }
                   9595:     return $nicescroll_js;
                   9596: }
                   9597: 
1.318     albertel 9598: sub simple_error_page {
1.1075.2.49  raeburn  9599:     my ($r,$title,$msg,$args) = @_;
1.1075.2.161.  .4(raebu 9600:22):     my %displayargs;
1.1075.2.49  raeburn  9601:     if (ref($args) eq 'HASH') {
                   9602:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1075.2.161.  .4(raebu 9603:22):         if ($args->{'only_body'}) {
                   9604:22):             $displayargs{'only_body'} = 1;
                   9605:22):         }
                   9606:22):         if ($args->{'no_nav_bar'}) {
                   9607:22):             $displayargs{'no_nav_bar'} = 1;
                   9608:22):         }
1.1075.2.49  raeburn  9609:     } else {
                   9610:         $msg = &mt($msg);
                   9611:     }
                   9612: 
1.318     albertel 9613:     my $page =
1.1075.2.161.  .4(raebu 9614:22): 	&Apache::loncommon::start_page($title,'',\%displayargs).
1.1075.2.49  raeburn  9615: 	'<p class="LC_error">'.$msg.'</p>'.
1.318     albertel 9616: 	&Apache::loncommon::end_page();
                   9617:     if (ref($r)) {
                   9618: 	$r->print($page);
1.327     albertel 9619: 	return;
1.318     albertel 9620:     }
                   9621:     return $page;
                   9622: }
1.347     albertel 9623: 
                   9624: {
1.610     albertel 9625:     my @row_count;
1.961     onken    9626: 
                   9627:     sub start_data_table_count {
                   9628:         unshift(@row_count, 0);
                   9629:         return;
                   9630:     }
                   9631: 
                   9632:     sub end_data_table_count {
                   9633:         shift(@row_count);
                   9634:         return;
                   9635:     }
                   9636: 
1.347     albertel 9637:     sub start_data_table {
1.1018    raeburn  9638: 	my ($add_class,$id) = @_;
1.422     albertel 9639: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  9640:         my $table_id;
                   9641:         if (defined($id)) {
                   9642:             $table_id = ' id="'.$id.'"';
                   9643:         }
1.961     onken    9644: 	&start_data_table_count();
1.1018    raeburn  9645: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 9646:     }
                   9647: 
                   9648:     sub end_data_table {
1.961     onken    9649: 	&end_data_table_count();
1.389     albertel 9650: 	return '</table>'."\n";;
1.347     albertel 9651:     }
                   9652: 
                   9653:     sub start_data_table_row {
1.974     wenzelju 9654: 	my ($add_class, $id) = @_;
1.610     albertel 9655: 	$row_count[0]++;
                   9656: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   9657: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 9658:         $id = (' id="'.$id.'"') unless ($id eq '');
                   9659:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 9660:     }
1.471     banghart 9661:     
                   9662:     sub continue_data_table_row {
1.974     wenzelju 9663: 	my ($add_class, $id) = @_;
1.610     albertel 9664: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 9665: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   9666:         $id = (' id="'.$id.'"') unless ($id eq '');
                   9667:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 9668:     }
1.347     albertel 9669: 
                   9670:     sub end_data_table_row {
1.389     albertel 9671: 	return '</tr>'."\n";;
1.347     albertel 9672:     }
1.367     www      9673: 
1.421     albertel 9674:     sub start_data_table_empty_row {
1.707     bisitz   9675: #	$row_count[0]++;
1.421     albertel 9676: 	return  '<tr class="LC_empty_row" >'."\n";;
                   9677:     }
                   9678: 
                   9679:     sub end_data_table_empty_row {
                   9680: 	return '</tr>'."\n";;
                   9681:     }
                   9682: 
1.367     www      9683:     sub start_data_table_header_row {
1.389     albertel 9684: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      9685:     }
                   9686: 
                   9687:     sub end_data_table_header_row {
1.389     albertel 9688: 	return '</tr>'."\n";;
1.367     www      9689:     }
1.890     droeschl 9690: 
                   9691:     sub data_table_caption {
                   9692:         my $caption = shift;
                   9693:         return "<caption class=\"LC_caption\">$caption</caption>";
                   9694:     }
1.347     albertel 9695: }
                   9696: 
1.548     albertel 9697: =pod
                   9698: 
                   9699: =item * &inhibit_menu_check($arg)
                   9700: 
                   9701: Checks for a inhibitmenu state and generates output to preserve it
                   9702: 
                   9703: Inputs:         $arg - can be any of
                   9704:                      - undef - in which case the return value is a string 
                   9705:                                to add  into arguments list of a uri
                   9706:                      - 'input' - in which case the return value is a HTML
                   9707:                                  <form> <input> field of type hidden to
                   9708:                                  preserve the value
                   9709:                      - a url - in which case the return value is the url with
                   9710:                                the neccesary cgi args added to preserve the
                   9711:                                inhibitmenu state
                   9712:                      - a ref to a url - no return value, but the string is
                   9713:                                         updated to include the neccessary cgi
                   9714:                                         args to preserve the inhibitmenu state
                   9715: 
                   9716: =cut
                   9717: 
                   9718: sub inhibit_menu_check {
                   9719:     my ($arg) = @_;
                   9720:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   9721:     if ($arg eq 'input') {
                   9722: 	if ($env{'form.inhibitmenu'}) {
                   9723: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   9724: 	} else {
                   9725: 	    return
                   9726: 	}
                   9727:     }
                   9728:     if ($env{'form.inhibitmenu'}) {
                   9729: 	if (ref($arg)) {
                   9730: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9731: 	} elsif ($arg eq '') {
                   9732: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   9733: 	} else {
                   9734: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9735: 	}
                   9736:     }
                   9737:     if (!ref($arg)) {
                   9738: 	return $arg;
                   9739:     }
                   9740: }
                   9741: 
1.251     albertel 9742: ###############################################
1.182     matthew  9743: 
                   9744: =pod
                   9745: 
1.549     albertel 9746: =back
                   9747: 
                   9748: =head1 User Information Routines
                   9749: 
                   9750: =over 4
                   9751: 
1.405     albertel 9752: =item * &get_users_function()
1.182     matthew  9753: 
                   9754: Used by &bodytag to determine the current users primary role.
                   9755: Returns either 'student','coordinator','admin', or 'author'.
                   9756: 
                   9757: =cut
                   9758: 
                   9759: ###############################################
                   9760: sub get_users_function {
1.815     tempelho 9761:     my $function = 'norole';
1.818     tempelho 9762:     if ($env{'request.role'}=~/^(st)/) {
                   9763:         $function='student';
                   9764:     }
1.907     raeburn  9765:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  9766:         $function='coordinator';
                   9767:     }
1.258     albertel 9768:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  9769:         $function='admin';
                   9770:     }
1.826     bisitz   9771:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  9772:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  9773:         $function='author';
                   9774:     }
                   9775:     return $function;
1.54      www      9776: }
1.99      www      9777: 
                   9778: ###############################################
                   9779: 
1.233     raeburn  9780: =pod
                   9781: 
1.821     raeburn  9782: =item * &show_course()
                   9783: 
                   9784: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   9785: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   9786: 
                   9787: Inputs:
                   9788: None
                   9789: 
                   9790: Outputs:
                   9791: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   9792: 
                   9793: =cut
                   9794: 
                   9795: ###############################################
                   9796: sub show_course {
                   9797:     my $course = !$env{'user.adv'};
                   9798:     if (!$env{'user.adv'}) {
                   9799:         foreach my $env (keys(%env)) {
                   9800:             next if ($env !~ m/^user\.priv\./);
                   9801:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   9802:                 $course = 0;
                   9803:                 last;
                   9804:             }
                   9805:         }
                   9806:     }
                   9807:     return $course;
                   9808: }
                   9809: 
                   9810: ###############################################
                   9811: 
                   9812: =pod
                   9813: 
1.542     raeburn  9814: =item * &check_user_status()
1.274     raeburn  9815: 
                   9816: Determines current status of supplied role for a
                   9817: specific user. Roles can be active, previous or future.
                   9818: 
                   9819: Inputs: 
                   9820: user's domain, user's username, course's domain,
1.375     raeburn  9821: course's number, optional section ID.
1.274     raeburn  9822: 
                   9823: Outputs:
                   9824: role status: active, previous or future. 
                   9825: 
                   9826: =cut
                   9827: 
                   9828: sub check_user_status {
1.412     raeburn  9829:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  9830:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1075.2.85  raeburn  9831:     my @uroles = keys(%userinfo);
1.274     raeburn  9832:     my $srchstr;
                   9833:     my $active_chk = 'none';
1.412     raeburn  9834:     my $now = time;
1.274     raeburn  9835:     if (@uroles > 0) {
1.908     raeburn  9836:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  9837:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   9838:         } else {
1.412     raeburn  9839:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   9840:         }
                   9841:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  9842:             my $role_end = 0;
                   9843:             my $role_start = 0;
                   9844:             $active_chk = 'active';
1.412     raeburn  9845:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   9846:                 $role_end = $1;
                   9847:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   9848:                     $role_start = $1;
1.274     raeburn  9849:                 }
                   9850:             }
                   9851:             if ($role_start > 0) {
1.412     raeburn  9852:                 if ($now < $role_start) {
1.274     raeburn  9853:                     $active_chk = 'future';
                   9854:                 }
                   9855:             }
                   9856:             if ($role_end > 0) {
1.412     raeburn  9857:                 if ($now > $role_end) {
1.274     raeburn  9858:                     $active_chk = 'previous';
                   9859:                 }
                   9860:             }
                   9861:         }
                   9862:     }
                   9863:     return $active_chk;
                   9864: }
                   9865: 
                   9866: ###############################################
                   9867: 
                   9868: =pod
                   9869: 
1.405     albertel 9870: =item * &get_sections()
1.233     raeburn  9871: 
                   9872: Determines all the sections for a course including
                   9873: sections with students and sections containing other roles.
1.419     raeburn  9874: Incoming parameters: 
                   9875: 
                   9876: 1. domain
                   9877: 2. course number 
                   9878: 3. reference to array containing roles for which sections should 
                   9879: be gathered (optional).
                   9880: 4. reference to array containing status types for which sections 
                   9881: should be gathered (optional).
                   9882: 
                   9883: If the third argument is undefined, sections are gathered for any role. 
                   9884: If the fourth argument is undefined, sections are gathered for any status.
                   9885: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  9886:  
1.374     raeburn  9887: Returns section hash (keys are section IDs, values are
                   9888: number of users in each section), subject to the
1.419     raeburn  9889: optional roles filter, optional status filter 
1.233     raeburn  9890: 
                   9891: =cut
                   9892: 
                   9893: ###############################################
                   9894: sub get_sections {
1.419     raeburn  9895:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 9896:     if (!defined($cdom) || !defined($cnum)) {
                   9897:         my $cid =  $env{'request.course.id'};
                   9898: 
                   9899: 	return if (!defined($cid));
                   9900: 
                   9901:         $cdom = $env{'course.'.$cid.'.domain'};
                   9902:         $cnum = $env{'course.'.$cid.'.num'};
                   9903:     }
                   9904: 
                   9905:     my %sectioncount;
1.419     raeburn  9906:     my $now = time;
1.240     albertel 9907: 
1.1075.2.33  raeburn  9908:     my $check_students = 1;
                   9909:     my $only_students = 0;
                   9910:     if (ref($possible_roles) eq 'ARRAY') {
                   9911:         if (grep(/^st$/,@{$possible_roles})) {
                   9912:             if (@{$possible_roles} == 1) {
                   9913:                 $only_students = 1;
                   9914:             }
                   9915:         } else {
                   9916:             $check_students = 0;
                   9917:         }
                   9918:     }
                   9919: 
                   9920:     if ($check_students) {
1.276     albertel 9921: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 9922: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   9923: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  9924:         my $start_index = &Apache::loncoursedata::CL_START();
                   9925:         my $end_index = &Apache::loncoursedata::CL_END();
                   9926:         my $status;
1.366     albertel 9927: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  9928: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   9929: 				                     $data->[$status_index],
                   9930:                                                      $data->[$start_index],
                   9931:                                                      $data->[$end_index]);
                   9932:             if ($stu_status eq 'Active') {
                   9933:                 $status = 'active';
                   9934:             } elsif ($end < $now) {
                   9935:                 $status = 'previous';
                   9936:             } elsif ($start > $now) {
                   9937:                 $status = 'future';
                   9938:             } 
                   9939: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   9940:                 if ((!defined($possible_status)) || (($status ne '') && 
                   9941:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   9942: 		    $sectioncount{$section}++;
                   9943:                 }
1.240     albertel 9944: 	    }
                   9945: 	}
                   9946:     }
1.1075.2.33  raeburn  9947:     if ($only_students) {
                   9948:         return %sectioncount;
                   9949:     }
1.240     albertel 9950:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9951:     foreach my $user (sort(keys(%courseroles))) {
                   9952: 	if ($user !~ /^(\w{2})/) { next; }
                   9953: 	my ($role) = ($user =~ /^(\w{2})/);
                   9954: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  9955: 	my ($section,$status);
1.240     albertel 9956: 	if ($role eq 'cr' &&
                   9957: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   9958: 	    $section=$1;
                   9959: 	}
                   9960: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   9961: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  9962:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   9963:         if ($end == -1 && $start == -1) {
                   9964:             next; #deleted role
                   9965:         }
                   9966:         if (!defined($possible_status)) { 
                   9967:             $sectioncount{$section}++;
                   9968:         } else {
                   9969:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   9970:                 $status = 'active';
                   9971:             } elsif ($end < $now) {
                   9972:                 $status = 'future';
                   9973:             } elsif ($start > $now) {
                   9974:                 $status = 'previous';
                   9975:             }
                   9976:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   9977:                 $sectioncount{$section}++;
                   9978:             }
                   9979:         }
1.233     raeburn  9980:     }
1.366     albertel 9981:     return %sectioncount;
1.233     raeburn  9982: }
                   9983: 
1.274     raeburn  9984: ###############################################
1.294     raeburn  9985: 
                   9986: =pod
1.405     albertel 9987: 
                   9988: =item * &get_course_users()
                   9989: 
1.275     raeburn  9990: Retrieves usernames:domains for users in the specified course
                   9991: with specific role(s), and access status. 
                   9992: 
                   9993: Incoming parameters:
1.277     albertel 9994: 1. course domain
                   9995: 2. course number
                   9996: 3. access status: users must have - either active, 
1.275     raeburn  9997: previous, future, or all.
1.277     albertel 9998: 4. reference to array of permissible roles
1.288     raeburn  9999: 5. reference to array of section restrictions (optional)
                   10000: 6. reference to results object (hash of hashes).
                   10001: 7. reference to optional userdata hash
1.609     raeburn  10002: 8. reference to optional statushash
1.630     raeburn  10003: 9. flag if privileged users (except those set to unhide in
                   10004:    course settings) should be excluded    
1.609     raeburn  10005: Keys of top level results hash are roles.
1.275     raeburn  10006: Keys of inner hashes are username:domain, with 
                   10007: values set to access type.
1.288     raeburn  10008: Optional userdata hash returns an array with arguments in the 
                   10009: same order as loncoursedata::get_classlist() for student data.
                   10010: 
1.609     raeburn  10011: Optional statushash returns
                   10012: 
1.288     raeburn  10013: Entries for end, start, section and status are blank because
                   10014: of the possibility of multiple values for non-student roles.
                   10015: 
1.275     raeburn  10016: =cut
1.405     albertel 10017: 
1.275     raeburn  10018: ###############################################
1.405     albertel 10019: 
1.275     raeburn  10020: sub get_course_users {
1.630     raeburn  10021:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  10022:     my %idx = ();
1.419     raeburn  10023:     my %seclists;
1.288     raeburn  10024: 
                   10025:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   10026:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   10027:     $idx{end} = &Apache::loncoursedata::CL_END();
                   10028:     $idx{start} = &Apache::loncoursedata::CL_START();
                   10029:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   10030:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   10031:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   10032:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   10033: 
1.290     albertel 10034:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 10035:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  10036:         my $now = time;
1.277     albertel 10037:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  10038:             my $match = 0;
1.412     raeburn  10039:             my $secmatch = 0;
1.419     raeburn  10040:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  10041:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  10042:             if ($section eq '') {
                   10043:                 $section = 'none';
                   10044:             }
1.291     albertel 10045:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 10046:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  10047:                     $secmatch = 1;
                   10048:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 10049:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  10050:                         $secmatch = 1;
                   10051:                     }
                   10052:                 } else {  
1.419     raeburn  10053: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  10054: 		        $secmatch = 1;
                   10055:                     }
1.290     albertel 10056: 		}
1.412     raeburn  10057:                 if (!$secmatch) {
                   10058:                     next;
                   10059:                 }
1.419     raeburn  10060:             }
1.275     raeburn  10061:             if (defined($$types{'active'})) {
1.288     raeburn  10062:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  10063:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  10064:                     $match = 1;
1.275     raeburn  10065:                 }
                   10066:             }
                   10067:             if (defined($$types{'previous'})) {
1.609     raeburn  10068:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  10069:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  10070:                     $match = 1;
1.275     raeburn  10071:                 }
                   10072:             }
                   10073:             if (defined($$types{'future'})) {
1.609     raeburn  10074:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  10075:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  10076:                     $match = 1;
1.275     raeburn  10077:                 }
                   10078:             }
1.609     raeburn  10079:             if ($match) {
                   10080:                 push(@{$seclists{$student}},$section);
                   10081:                 if (ref($userdata) eq 'HASH') {
                   10082:                     $$userdata{$student} = $$classlist{$student};
                   10083:                 }
                   10084:                 if (ref($statushash) eq 'HASH') {
                   10085:                     $statushash->{$student}{'st'}{$section} = $status;
                   10086:                 }
1.288     raeburn  10087:             }
1.275     raeburn  10088:         }
                   10089:     }
1.412     raeburn  10090:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  10091:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   10092:         my $now = time;
1.609     raeburn  10093:         my %displaystatus = ( previous => 'Expired',
                   10094:                               active   => 'Active',
                   10095:                               future   => 'Future',
                   10096:                             );
1.1075.2.36  raeburn  10097:         my (%nothide,@possdoms);
1.630     raeburn  10098:         if ($hidepriv) {
                   10099:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   10100:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   10101:                 if ($user !~ /:/) {
                   10102:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   10103:                 } else {
                   10104:                     $nothide{$user} = 1;
                   10105:                 }
                   10106:             }
1.1075.2.36  raeburn  10107:             my @possdoms = ($cdom);
                   10108:             if ($coursehash{'checkforpriv'}) {
                   10109:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   10110:             }
1.630     raeburn  10111:         }
1.439     raeburn  10112:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  10113:             my $match = 0;
1.412     raeburn  10114:             my $secmatch = 0;
1.439     raeburn  10115:             my $status;
1.412     raeburn  10116:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  10117:             $user =~ s/:$//;
1.439     raeburn  10118:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   10119:             if ($end == -1 || $start == -1) {
                   10120:                 next;
                   10121:             }
                   10122:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   10123:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  10124:                 my ($uname,$udom) = split(/:/,$user);
                   10125:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 10126:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  10127:                         $secmatch = 1;
                   10128:                     } elsif ($usec eq '') {
1.420     albertel 10129:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  10130:                             $secmatch = 1;
                   10131:                         }
                   10132:                     } else {
                   10133:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   10134:                             $secmatch = 1;
                   10135:                         }
                   10136:                     }
                   10137:                     if (!$secmatch) {
                   10138:                         next;
                   10139:                     }
1.288     raeburn  10140:                 }
1.419     raeburn  10141:                 if ($usec eq '') {
                   10142:                     $usec = 'none';
                   10143:                 }
1.275     raeburn  10144:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  10145:                     if ($hidepriv) {
1.1075.2.36  raeburn  10146:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  10147:                             (!$nothide{$uname.':'.$udom})) {
                   10148:                             next;
                   10149:                         }
                   10150:                     }
1.503     raeburn  10151:                     if ($end > 0 && $end < $now) {
1.439     raeburn  10152:                         $status = 'previous';
                   10153:                     } elsif ($start > $now) {
                   10154:                         $status = 'future';
                   10155:                     } else {
                   10156:                         $status = 'active';
                   10157:                     }
1.277     albertel 10158:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  10159:                         if ($status eq $type) {
1.420     albertel 10160:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  10161:                                 push(@{$$users{$role}{$user}},$type);
                   10162:                             }
1.288     raeburn  10163:                             $match = 1;
                   10164:                         }
                   10165:                     }
1.419     raeburn  10166:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   10167:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   10168: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   10169:                         }
1.420     albertel 10170:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  10171:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   10172:                         }
1.609     raeburn  10173:                         if (ref($statushash) eq 'HASH') {
                   10174:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   10175:                         }
1.275     raeburn  10176:                     }
                   10177:                 }
                   10178:             }
                   10179:         }
1.290     albertel 10180:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  10181:             if ((defined($cdom)) && (defined($cnum))) {
                   10182:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   10183:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   10184:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  10185:                     next if ($owner eq '');
                   10186:                     my ($ownername,$ownerdom);
                   10187:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   10188:                         $ownername = $1;
                   10189:                         $ownerdom = $2;
                   10190:                     } else {
                   10191:                         $ownername = $owner;
                   10192:                         $ownerdom = $cdom;
                   10193:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  10194:                     }
                   10195:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 10196:                     if (defined($userdata) && 
1.609     raeburn  10197: 			!exists($$userdata{$owner})) {
                   10198: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   10199:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   10200:                             push(@{$seclists{$owner}},'none');
                   10201:                         }
                   10202:                         if (ref($statushash) eq 'HASH') {
                   10203:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  10204:                         }
1.290     albertel 10205: 		    }
1.279     raeburn  10206:                 }
                   10207:             }
                   10208:         }
1.419     raeburn  10209:         foreach my $user (keys(%seclists)) {
                   10210:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   10211:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   10212:         }
1.275     raeburn  10213:     }
                   10214:     return;
                   10215: }
                   10216: 
1.288     raeburn  10217: sub get_user_info {
                   10218:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 10219:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   10220: 	&plainname($uname,$udom,'lastname');
1.291     albertel 10221:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  10222:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  10223:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   10224:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  10225:     return;
                   10226: }
1.275     raeburn  10227: 
1.472     raeburn  10228: ###############################################
                   10229: 
                   10230: =pod
                   10231: 
                   10232: =item * &get_user_quota()
                   10233: 
1.1075.2.41  raeburn  10234: Retrieves quota assigned for storage of user files.
                   10235: Default is to report quota for portfolio files.
1.472     raeburn  10236: 
                   10237: Incoming parameters:
                   10238: 1. user's username
                   10239: 2. user's domain
1.1075.2.41  raeburn  10240: 3. quota name - portfolio, author, or course
                   10241:    (if no quota name provided, defaults to portfolio).
1.1075.2.59  raeburn  10242: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1075.2.42  raeburn  10243:    course
1.472     raeburn  10244: 
                   10245: Returns:
1.1075.2.58  raeburn  10246: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  10247: 2. (Optional) Type of setting: custom or default
                   10248:    (individually assigned or default for user's 
                   10249:    institutional status).
                   10250: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   10251:    or student - types as defined in localenroll::inst_usertypes 
                   10252:    for user's domain, which determines default quota for user.
                   10253: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  10254: 
                   10255: If a value has been stored in the user's environment, 
1.536     raeburn  10256: it will return that, otherwise it returns the maximal default
1.1075.2.41  raeburn  10257: defined for the user's institutional status(es) in the domain.
1.472     raeburn  10258: 
                   10259: =cut
                   10260: 
                   10261: ###############################################
                   10262: 
                   10263: 
                   10264: sub get_user_quota {
1.1075.2.42  raeburn  10265:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  10266:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  10267:     if (!defined($udom)) {
                   10268:         $udom = $env{'user.domain'};
                   10269:     }
                   10270:     if (!defined($uname)) {
                   10271:         $uname = $env{'user.name'};
                   10272:     }
                   10273:     if (($udom eq '' || $uname eq '') ||
                   10274:         ($udom eq 'public') && ($uname eq 'public')) {
                   10275:         $quota = 0;
1.536     raeburn  10276:         $quotatype = 'default';
                   10277:         $defquota = 0; 
1.472     raeburn  10278:     } else {
1.536     raeburn  10279:         my $inststatus;
1.1075.2.41  raeburn  10280:         if ($quotaname eq 'course') {
                   10281:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   10282:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   10283:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   10284:             } else {
                   10285:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   10286:                 $quota = $cenv{'internal.uploadquota'};
                   10287:             }
1.536     raeburn  10288:         } else {
1.1075.2.41  raeburn  10289:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   10290:                 if ($quotaname eq 'author') {
                   10291:                     $quota = $env{'environment.authorquota'};
                   10292:                 } else {
                   10293:                     $quota = $env{'environment.portfolioquota'};
                   10294:                 }
                   10295:                 $inststatus = $env{'environment.inststatus'};
                   10296:             } else {
                   10297:                 my %userenv = 
                   10298:                     &Apache::lonnet::get('environment',['portfolioquota',
                   10299:                                          'authorquota','inststatus'],$udom,$uname);
                   10300:                 my ($tmp) = keys(%userenv);
                   10301:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10302:                     if ($quotaname eq 'author') {
                   10303:                         $quota = $userenv{'authorquota'};
                   10304:                     } else {
                   10305:                         $quota = $userenv{'portfolioquota'};
                   10306:                     }
                   10307:                     $inststatus = $userenv{'inststatus'};
                   10308:                 } else {
                   10309:                     undef(%userenv);
                   10310:                 }
                   10311:             }
                   10312:         }
                   10313:         if ($quota eq '' || wantarray) {
                   10314:             if ($quotaname eq 'course') {
                   10315:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1075.2.59  raeburn  10316:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
                   10317:                     ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1075.2.42  raeburn  10318:                     $defquota = $domdefs{$crstype.'quota'};
                   10319:                 }
                   10320:                 if ($defquota eq '') {
                   10321:                     $defquota = 500;
                   10322:                 }
1.1075.2.41  raeburn  10323:             } else {
                   10324:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   10325:             }
                   10326:             if ($quota eq '') {
                   10327:                 $quota = $defquota;
                   10328:                 $quotatype = 'default';
                   10329:             } else {
                   10330:                 $quotatype = 'custom';
                   10331:             }
1.472     raeburn  10332:         }
                   10333:     }
1.536     raeburn  10334:     if (wantarray) {
                   10335:         return ($quota,$quotatype,$settingstatus,$defquota);
                   10336:     } else {
                   10337:         return $quota;
                   10338:     }
1.472     raeburn  10339: }
                   10340: 
                   10341: ###############################################
                   10342: 
                   10343: =pod
                   10344: 
                   10345: =item * &default_quota()
                   10346: 
1.536     raeburn  10347: Retrieves default quota assigned for storage of user portfolio files,
                   10348: given an (optional) user's institutional status.
1.472     raeburn  10349: 
                   10350: Incoming parameters:
1.1075.2.42  raeburn  10351: 
1.472     raeburn  10352: 1. domain
1.536     raeburn  10353: 2. (Optional) institutional status(es).  This is a : separated list of 
                   10354:    status types (e.g., faculty, staff, student etc.)
                   10355:    which apply to the user for whom the default is being retrieved.
                   10356:    If the institutional status string in undefined, the domain
1.1075.2.41  raeburn  10357:    default quota will be returned.
                   10358: 3.  quota name - portfolio, author, or course
                   10359:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  10360: 
                   10361: Returns:
1.1075.2.42  raeburn  10362: 
1.1075.2.58  raeburn  10363: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  10364: 2. (Optional) institutional type which determined the value of the
                   10365:    default quota.
1.472     raeburn  10366: 
                   10367: If a value has been stored in the domain's configuration db,
                   10368: it will return that, otherwise it returns 20 (for backwards 
                   10369: compatibility with domains which have not set up a configuration
1.1075.2.58  raeburn  10370: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  10371: 
1.536     raeburn  10372: If the user's status includes multiple types (e.g., staff and student),
                   10373: the largest default quota which applies to the user determines the
                   10374: default quota returned.
                   10375: 
1.472     raeburn  10376: =cut
                   10377: 
                   10378: ###############################################
                   10379: 
                   10380: 
                   10381: sub default_quota {
1.1075.2.41  raeburn  10382:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  10383:     my ($defquota,$settingstatus);
                   10384:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  10385:                                             ['quotas'],$udom);
1.1075.2.41  raeburn  10386:     my $key = 'defaultquota';
                   10387:     if ($quotaname eq 'author') {
                   10388:         $key = 'authorquota';
                   10389:     }
1.622     raeburn  10390:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  10391:         if ($inststatus ne '') {
1.765     raeburn  10392:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  10393:             foreach my $item (@statuses) {
1.1075.2.41  raeburn  10394:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   10395:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  10396:                         if ($defquota eq '') {
1.1075.2.41  raeburn  10397:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  10398:                             $settingstatus = $item;
1.1075.2.41  raeburn  10399:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   10400:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  10401:                             $settingstatus = $item;
                   10402:                         }
                   10403:                     }
1.1075.2.41  raeburn  10404:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  10405:                     if ($quotahash{'quotas'}{$item} ne '') {
                   10406:                         if ($defquota eq '') {
                   10407:                             $defquota = $quotahash{'quotas'}{$item};
                   10408:                             $settingstatus = $item;
                   10409:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   10410:                             $defquota = $quotahash{'quotas'}{$item};
                   10411:                             $settingstatus = $item;
                   10412:                         }
1.536     raeburn  10413:                     }
                   10414:                 }
                   10415:             }
                   10416:         }
                   10417:         if ($defquota eq '') {
1.1075.2.41  raeburn  10418:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   10419:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   10420:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  10421:                 $defquota = $quotahash{'quotas'}{'default'};
                   10422:             }
1.536     raeburn  10423:             $settingstatus = 'default';
1.1075.2.42  raeburn  10424:             if ($defquota eq '') {
                   10425:                 if ($quotaname eq 'author') {
                   10426:                     $defquota = 500;
                   10427:                 }
                   10428:             }
1.536     raeburn  10429:         }
                   10430:     } else {
                   10431:         $settingstatus = 'default';
1.1075.2.41  raeburn  10432:         if ($quotaname eq 'author') {
                   10433:             $defquota = 500;
                   10434:         } else {
                   10435:             $defquota = 20;
                   10436:         }
1.536     raeburn  10437:     }
                   10438:     if (wantarray) {
                   10439:         return ($defquota,$settingstatus);
1.472     raeburn  10440:     } else {
1.536     raeburn  10441:         return $defquota;
1.472     raeburn  10442:     }
                   10443: }
                   10444: 
1.1075.2.41  raeburn  10445: ###############################################
                   10446: 
                   10447: =pod
                   10448: 
1.1075.2.42  raeburn  10449: =item * &excess_filesize_warning()
1.1075.2.41  raeburn  10450: 
                   10451: Returns warning message if upload of file to authoring space, or copying
1.1075.2.42  raeburn  10452: of existing file within authoring space will cause quota for the authoring
                   10453: space to be exceeded.
                   10454: 
                   10455: Same, if upload of a file directly to a course/community via Course Editor
                   10456: will cause quota for uploaded content for the course to be exceeded.
1.1075.2.41  raeburn  10457: 
1.1075.2.61  raeburn  10458: Inputs: 7 
1.1075.2.42  raeburn  10459: 1. username or coursenum
1.1075.2.41  raeburn  10460: 2. domain
1.1075.2.42  raeburn  10461: 3. context ('author' or 'course')
1.1075.2.41  raeburn  10462: 4. filename of file for which action is being requested
                   10463: 5. filesize (kB) of file
                   10464: 6. action being taken: copy or upload.
1.1075.2.59  raeburn  10465: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1075.2.41  raeburn  10466: 
                   10467: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
                   10468:          otherwise return null.
                   10469: 
1.1075.2.42  raeburn  10470: =back
                   10471: 
1.1075.2.41  raeburn  10472: =cut
                   10473: 
1.1075.2.42  raeburn  10474: sub excess_filesize_warning {
1.1075.2.59  raeburn  10475:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1075.2.42  raeburn  10476:     my $current_disk_usage = 0;
1.1075.2.59  raeburn  10477:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1075.2.42  raeburn  10478:     if ($context eq 'author') {
                   10479:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   10480:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   10481:     } else {
                   10482:         foreach my $subdir ('docs','supplemental') {
                   10483:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   10484:         }
                   10485:     }
1.1075.2.41  raeburn  10486:     $disk_quota = int($disk_quota * 1000);
                   10487:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1075.2.69  raeburn  10488:         return '<p class="LC_warning">'.
1.1075.2.41  raeburn  10489:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1075.2.69  raeburn  10490:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   10491:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1075.2.41  raeburn  10492:                             $disk_quota,$current_disk_usage).
                   10493:                '</p>';
                   10494:     }
                   10495:     return;
                   10496: }
                   10497: 
                   10498: ###############################################
                   10499: 
                   10500: 
1.384     raeburn  10501: sub get_secgrprole_info {
                   10502:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   10503:     my %sections_count = &get_sections($cdom,$cnum);
                   10504:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   10505:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   10506:     my @groups = sort(keys(%curr_groups));
                   10507:     my $allroles = [];
                   10508:     my $rolehash;
                   10509:     my $accesshash = {
                   10510:                      active => 'Currently has access',
                   10511:                      future => 'Will have future access',
                   10512:                      previous => 'Previously had access',
                   10513:                   };
                   10514:     if ($needroles) {
                   10515:         $rolehash = {'all' => 'all'};
1.385     albertel 10516:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   10517: 	if (&Apache::lonnet::error(%user_roles)) {
                   10518: 	    undef(%user_roles);
                   10519: 	}
                   10520:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  10521:             my ($role)=split(/\:/,$item,2);
                   10522:             if ($role eq 'cr') { next; }
                   10523:             if ($role =~ /^cr/) {
                   10524:                 $$rolehash{$role} = (split('/',$role))[3];
                   10525:             } else {
                   10526:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   10527:             }
                   10528:         }
                   10529:         foreach my $key (sort(keys(%{$rolehash}))) {
                   10530:             push(@{$allroles},$key);
                   10531:         }
                   10532:         push (@{$allroles},'st');
                   10533:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   10534:     }
                   10535:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   10536: }
                   10537: 
1.555     raeburn  10538: sub user_picker {
1.1075.2.127  raeburn  10539:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  10540:     my $currdom = $dom;
1.1075.2.114  raeburn  10541:     my @alldoms = &Apache::lonnet::all_domains();
                   10542:     if (@alldoms == 1) {
                   10543:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   10544:                                                ['directorysrch'],$alldoms[0]);
                   10545:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   10546:         my $showdom = $domdesc;
                   10547:         if ($showdom eq '') {
                   10548:             $showdom = $dom;
                   10549:         }
                   10550:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   10551:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   10552:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   10553:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   10554:             }
                   10555:         }
                   10556:     }
1.555     raeburn  10557:     my %curr_selected = (
                   10558:                         srchin => 'dom',
1.580     raeburn  10559:                         srchby => 'lastname',
1.555     raeburn  10560:                       );
                   10561:     my $srchterm;
1.625     raeburn  10562:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  10563:         if ($srch->{'srchby'} ne '') {
                   10564:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   10565:         }
                   10566:         if ($srch->{'srchin'} ne '') {
                   10567:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   10568:         }
                   10569:         if ($srch->{'srchtype'} ne '') {
                   10570:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   10571:         }
                   10572:         if ($srch->{'srchdomain'} ne '') {
                   10573:             $currdom = $srch->{'srchdomain'};
                   10574:         }
                   10575:         $srchterm = $srch->{'srchterm'};
                   10576:     }
1.1075.2.98  raeburn  10577:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  10578:                     'usr'       => 'Search criteria',
1.563     raeburn  10579:                     'doma'      => 'Domain/institution to search',
1.558     albertel 10580:                     'uname'     => 'username',
                   10581:                     'lastname'  => 'last name',
1.555     raeburn  10582:                     'lastfirst' => 'last name, first name',
1.558     albertel 10583:                     'crs'       => 'in this course',
1.576     raeburn  10584:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 10585:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  10586:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 10587:                     'exact'     => 'is',
                   10588:                     'contains'  => 'contains',
1.569     raeburn  10589:                     'begins'    => 'begins with',
1.1075.2.98  raeburn  10590:                                        );
                   10591:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  10592:                     'youm'      => "You must include some text to search for.",
                   10593:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   10594:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   10595:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   10596:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   10597:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   10598:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   10599:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  10600:                                        );
1.1075.2.98  raeburn  10601:     &html_escape(\%html_lt);
                   10602:     &js_escape(\%js_lt);
1.1075.2.115  raeburn  10603:     my $domform;
1.1075.2.126  raeburn  10604:     my $allow_blank = 1;
1.1075.2.115  raeburn  10605:     if ($fixeddom) {
1.1075.2.126  raeburn  10606:         $allow_blank = 0;
                   10607:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1075.2.115  raeburn  10608:     } else {
1.1075.2.126  raeburn  10609:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1);
1.1075.2.115  raeburn  10610:     }
1.563     raeburn  10611:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  10612: 
                   10613:     my @srchins = ('crs','dom','alc','instd');
                   10614: 
                   10615:     foreach my $option (@srchins) {
                   10616:         # FIXME 'alc' option unavailable until 
                   10617:         #       loncreateuser::print_user_query_page()
                   10618:         #       has been completed.
                   10619:         next if ($option eq 'alc');
1.880     raeburn  10620:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  10621:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1075.2.127  raeburn  10622:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  10623:         if ($curr_selected{'srchin'} eq $option) {
                   10624:             $srchinsel .= ' 
1.1075.2.98  raeburn  10625:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  10626:         } else {
                   10627:             $srchinsel .= '
1.1075.2.98  raeburn  10628:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  10629:         }
1.555     raeburn  10630:     }
1.563     raeburn  10631:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  10632: 
                   10633:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  10634:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  10635:         if ($curr_selected{'srchby'} eq $option) {
                   10636:             $srchbysel .= '
1.1075.2.98  raeburn  10637:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  10638:         } else {
                   10639:             $srchbysel .= '
1.1075.2.98  raeburn  10640:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  10641:          }
                   10642:     }
                   10643:     $srchbysel .= "\n  </select>\n";
                   10644: 
                   10645:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  10646:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  10647:         if ($curr_selected{'srchtype'} eq $option) {
                   10648:             $srchtypesel .= '
1.1075.2.98  raeburn  10649:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  10650:         } else {
                   10651:             $srchtypesel .= '
1.1075.2.98  raeburn  10652:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  10653:         }
                   10654:     }
                   10655:     $srchtypesel .= "\n  </select>\n";
                   10656: 
1.558     albertel 10657:     my ($newuserscript,$new_user_create);
1.994     raeburn  10658:     my $context_dom = $env{'request.role.domain'};
                   10659:     if ($context eq 'requestcrs') {
                   10660:         if ($env{'form.coursedom'} ne '') { 
                   10661:             $context_dom = $env{'form.coursedom'};
                   10662:         }
                   10663:     }
1.556     raeburn  10664:     if ($forcenewuser) {
1.576     raeburn  10665:         if (ref($srch) eq 'HASH') {
1.994     raeburn  10666:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  10667:                 if ($cancreate) {
                   10668:                     $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>';
                   10669:                 } else {
1.799     bisitz   10670:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  10671:                     my %usertypetext = (
                   10672:                         official   => 'institutional',
                   10673:                         unofficial => 'non-institutional',
                   10674:                     );
1.799     bisitz   10675:                     $new_user_create = '<p class="LC_warning">'
                   10676:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   10677:                                       .' '
                   10678:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   10679:                                           ,'<a href="'.$helplink.'">','</a>')
                   10680:                                       .'</p><br />';
1.627     raeburn  10681:                 }
1.576     raeburn  10682:             }
                   10683:         }
                   10684: 
1.556     raeburn  10685:         $newuserscript = <<"ENDSCRIPT";
                   10686: 
1.570     raeburn  10687: function setSearch(createnew,callingForm) {
1.556     raeburn  10688:     if (createnew == 1) {
1.570     raeburn  10689:         for (var i=0; i<callingForm.srchby.length; i++) {
                   10690:             if (callingForm.srchby.options[i].value == 'uname') {
                   10691:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  10692:             }
                   10693:         }
1.570     raeburn  10694:         for (var i=0; i<callingForm.srchin.length; i++) {
                   10695:             if ( callingForm.srchin.options[i].value == 'dom') {
                   10696: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  10697:             }
                   10698:         }
1.570     raeburn  10699:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   10700:             if (callingForm.srchtype.options[i].value == 'exact') {
                   10701:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  10702:             }
                   10703:         }
1.570     raeburn  10704:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  10705:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  10706:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  10707:             }
                   10708:         }
                   10709:     }
                   10710: }
                   10711: ENDSCRIPT
1.558     albertel 10712: 
1.556     raeburn  10713:     }
                   10714: 
1.555     raeburn  10715:     my $output = <<"END_BLOCK";
1.556     raeburn  10716: <script type="text/javascript">
1.824     bisitz   10717: // <![CDATA[
1.570     raeburn  10718: function validateEntry(callingForm) {
1.558     albertel 10719: 
1.556     raeburn  10720:     var checkok = 1;
1.558     albertel 10721:     var srchin;
1.570     raeburn  10722:     for (var i=0; i<callingForm.srchin.length; i++) {
                   10723: 	if ( callingForm.srchin[i].checked ) {
                   10724: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 10725: 	}
                   10726:     }
                   10727: 
1.570     raeburn  10728:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   10729:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   10730:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   10731:     var srchterm =  callingForm.srchterm.value;
                   10732:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  10733:     var msg = "";
                   10734: 
                   10735:     if (srchterm == "") {
                   10736:         checkok = 0;
1.1075.2.98  raeburn  10737:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  10738:     }
                   10739: 
1.569     raeburn  10740:     if (srchtype== 'begins') {
                   10741:         if (srchterm.length < 2) {
                   10742:             checkok = 0;
1.1075.2.98  raeburn  10743:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  10744:         }
                   10745:     }
                   10746: 
1.556     raeburn  10747:     if (srchtype== 'contains') {
                   10748:         if (srchterm.length < 3) {
                   10749:             checkok = 0;
1.1075.2.98  raeburn  10750:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  10751:         }
                   10752:     }
                   10753:     if (srchin == 'instd') {
                   10754:         if (srchdomain == '') {
                   10755:             checkok = 0;
1.1075.2.98  raeburn  10756:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  10757:         }
                   10758:     }
                   10759:     if (srchin == 'dom') {
                   10760:         if (srchdomain == '') {
                   10761:             checkok = 0;
1.1075.2.98  raeburn  10762:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  10763:         }
                   10764:     }
                   10765:     if (srchby == 'lastfirst') {
                   10766:         if (srchterm.indexOf(",") == -1) {
                   10767:             checkok = 0;
1.1075.2.98  raeburn  10768:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  10769:         }
                   10770:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   10771:             checkok = 0;
1.1075.2.98  raeburn  10772:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  10773:         }
                   10774:     }
                   10775:     if (checkok == 0) {
1.1075.2.98  raeburn  10776:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  10777:         return;
                   10778:     }
                   10779:     if (checkok == 1) {
1.570     raeburn  10780:         callingForm.submit();
1.556     raeburn  10781:     }
                   10782: }
                   10783: 
                   10784: $newuserscript
                   10785: 
1.824     bisitz   10786: // ]]>
1.556     raeburn  10787: </script>
1.558     albertel 10788: 
                   10789: $new_user_create
                   10790: 
1.555     raeburn  10791: END_BLOCK
1.558     albertel 10792: 
1.876     raeburn  10793:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1075.2.98  raeburn  10794:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  10795:                $domform.
                   10796:                &Apache::lonhtmlcommon::row_closure().
1.1075.2.98  raeburn  10797:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  10798:                $srchbysel.
                   10799:                $srchtypesel. 
                   10800:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   10801:                $srchinsel.
                   10802:                &Apache::lonhtmlcommon::row_closure(1). 
                   10803:                &Apache::lonhtmlcommon::end_pick_box().
                   10804:                '<br />';
1.1075.2.114  raeburn  10805:     return ($output,1);
1.555     raeburn  10806: }
                   10807: 
1.612     raeburn  10808: sub user_rule_check {
1.615     raeburn  10809:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1075.2.99  raeburn  10810:     my ($response,%inst_response);
1.612     raeburn  10811:     if (ref($usershash) eq 'HASH') {
1.1075.2.99  raeburn  10812:         if (keys(%{$usershash}) > 1) {
                   10813:             my (%by_username,%by_id,%userdoms);
                   10814:             my $checkid;
1.612     raeburn  10815:             if (ref($checks) eq 'HASH') {
1.1075.2.99  raeburn  10816:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   10817:                     $checkid = 1;
                   10818:                 }
                   10819:             }
                   10820:             foreach my $user (keys(%{$usershash})) {
                   10821:                 my ($uname,$udom) = split(/:/,$user);
                   10822:                 if ($checkid) {
                   10823:                     if (ref($usershash->{$user}) eq 'HASH') {
                   10824:                         if ($usershash->{$user}->{'id'} ne '') {
                   10825:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
                   10826:                             $userdoms{$udom} = 1;
                   10827:                             if (ref($inst_results) eq 'HASH') {
                   10828:                                 $inst_results->{$uname.':'.$udom} = {};
                   10829:                             }
                   10830:                         }
                   10831:                     }
                   10832:                 } else {
                   10833:                     $by_username{$udom}{$uname} = 1;
                   10834:                     $userdoms{$udom} = 1;
                   10835:                     if (ref($inst_results) eq 'HASH') {
                   10836:                         $inst_results->{$uname.':'.$udom} = {};
                   10837:                     }
                   10838:                 }
                   10839:             }
                   10840:             foreach my $udom (keys(%userdoms)) {
                   10841:                 if (!$got_rules->{$udom}) {
                   10842:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10843:                                                              ['usercreation'],$udom);
                   10844:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10845:                         foreach my $item ('username','id') {
                   10846:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10847:                                 $$curr_rules{$udom}{$item} =
                   10848:                                     $domconfig{'usercreation'}{$item.'_rule'};
                   10849:                             }
                   10850:                         }
                   10851:                     }
                   10852:                     $got_rules->{$udom} = 1;
                   10853:                 }
                   10854:             }
                   10855:             if ($checkid) {
                   10856:                 foreach my $udom (keys(%by_id)) {
                   10857:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   10858:                     if ($outcome eq 'ok') {
                   10859:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   10860:                             my $uname = $by_id{$udom}{$id};
                   10861:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10862:                         }
                   10863:                         if (ref($results) eq 'HASH') {
                   10864:                             foreach my $uname (keys(%{$results})) {
                   10865:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   10866:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   10867:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10868:                                 }
                   10869:                             }
                   10870:                         }
                   10871:                     }
1.612     raeburn  10872:                 }
1.615     raeburn  10873:             } else {
1.1075.2.99  raeburn  10874:                 foreach my $udom (keys(%by_username)) {
                   10875:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   10876:                     if ($outcome eq 'ok') {
                   10877:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   10878:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10879:                         }
                   10880:                         if (ref($results) eq 'HASH') {
                   10881:                             foreach my $uname (keys(%{$results})) {
                   10882:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10883:                             }
                   10884:                         }
                   10885:                     }
                   10886:                 }
1.612     raeburn  10887:             }
1.1075.2.99  raeburn  10888:         } elsif (keys(%{$usershash}) == 1) {
                   10889:             my $user = (keys(%{$usershash}))[0];
                   10890:             my ($uname,$udom) = split(/:/,$user);
                   10891:             if (($udom ne '') && ($uname ne '')) {
                   10892:                 if (ref($usershash->{$user}) eq 'HASH') {
                   10893:                     if (ref($checks) eq 'HASH') {
                   10894:                         if (defined($checks->{'username'})) {
                   10895:                             ($inst_response{$user},%{$inst_results->{$user}}) =
                   10896:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   10897:                         } elsif (defined($checks->{'id'})) {
                   10898:                             if ($usershash->{$user}->{'id'} ne '') {
                   10899:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10900:                                     &Apache::lonnet::get_instuser($udom,undef,
                   10901:                                                                   $usershash->{$user}->{'id'});
                   10902:                             } else {
                   10903:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10904:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   10905:                             }
                   10906:                         }
                   10907:                     } else {
                   10908:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   10909:                             &Apache::lonnet::get_instuser($udom,$uname);
                   10910:                        return;
                   10911:                     }
                   10912:                     if (!$got_rules->{$udom}) {
                   10913:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10914:                                                                  ['usercreation'],$udom);
                   10915:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10916:                             foreach my $item ('username','id') {
                   10917:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10918:                                    $$curr_rules{$udom}{$item} =
                   10919:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   10920:                                 }
                   10921:                             }
1.585     raeburn  10922:                         }
1.1075.2.99  raeburn  10923:                         $got_rules->{$udom} = 1;
1.585     raeburn  10924:                     }
                   10925:                 }
1.1075.2.99  raeburn  10926:             } else {
                   10927:                 return;
                   10928:             }
                   10929:         } else {
                   10930:             return;
                   10931:         }
                   10932:         foreach my $user (keys(%{$usershash})) {
                   10933:             my ($uname,$udom) = split(/:/,$user);
                   10934:             next if (($udom eq '') || ($uname eq ''));
                   10935:             my $id;
                   10936:             if (ref($inst_results) eq 'HASH') {
                   10937:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   10938:                     $id = $inst_results->{$user}->{'id'};
                   10939:                 }
                   10940:             }
                   10941:             if ($id eq '') {
                   10942:                 if (ref($usershash->{$user})) {
                   10943:                     $id = $usershash->{$user}->{'id'};
                   10944:                 }
1.585     raeburn  10945:             }
1.612     raeburn  10946:             foreach my $item (keys(%{$checks})) {
                   10947:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   10948:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   10949:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1075.2.99  raeburn  10950:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   10951:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  10952:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   10953:                                 if ($rule_check{$rule}) {
                   10954:                                     $$rulematch{$user}{$item} = $rule;
1.1075.2.99  raeburn  10955:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  10956:                                         if (ref($inst_results) eq 'HASH') {
                   10957:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   10958:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   10959:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1075.2.99  raeburn  10960:                                                 } elsif ($item eq 'id') {
                   10961:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   10962:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   10963:                                                     }
1.615     raeburn  10964:                                                 }
1.612     raeburn  10965:                                             }
                   10966:                                         }
1.615     raeburn  10967:                                     }
                   10968:                                     last;
1.585     raeburn  10969:                                 }
                   10970:                             }
                   10971:                         }
                   10972:                     }
                   10973:                 }
                   10974:             }
                   10975:         }
                   10976:     }
1.612     raeburn  10977:     return;
                   10978: }
                   10979: 
                   10980: sub user_rule_formats {
                   10981:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   10982:     my %text = ( 
                   10983:                  'username' => 'Usernames',
                   10984:                  'id'       => 'IDs',
                   10985:                );
                   10986:     my $output;
                   10987:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   10988:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   10989:         if (@{$ruleorder} > 0) {
1.1075.2.20  raeburn  10990:             $output = '<br />'.
                   10991:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   10992:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   10993:                       ' <ul>';
1.612     raeburn  10994:             foreach my $rule (@{$ruleorder}) {
                   10995:                 if (ref($curr_rules) eq 'ARRAY') {
                   10996:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   10997:                         if (ref($rules->{$rule}) eq 'HASH') {
                   10998:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   10999:                                         $rules->{$rule}{'desc'}.'</li>';
                   11000:                         }
                   11001:                     }
                   11002:                 }
                   11003:             }
                   11004:             $output .= '</ul>';
                   11005:         }
                   11006:     }
                   11007:     return $output;
                   11008: }
                   11009: 
                   11010: sub instrule_disallow_msg {
1.615     raeburn  11011:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  11012:     my $response;
                   11013:     my %text = (
                   11014:                   item   => 'username',
                   11015:                   items  => 'usernames',
                   11016:                   match  => 'matches',
                   11017:                   do     => 'does',
                   11018:                   action => 'a username',
                   11019:                   one    => 'one',
                   11020:                );
                   11021:     if ($count > 1) {
                   11022:         $text{'item'} = 'usernames';
                   11023:         $text{'match'} ='match';
                   11024:         $text{'do'} = 'do';
                   11025:         $text{'action'} = 'usernames',
                   11026:         $text{'one'} = 'ones';
                   11027:     }
                   11028:     if ($checkitem eq 'id') {
                   11029:         $text{'items'} = 'IDs';
                   11030:         $text{'item'} = 'ID';
                   11031:         $text{'action'} = 'an ID';
1.615     raeburn  11032:         if ($count > 1) {
                   11033:             $text{'item'} = 'IDs';
                   11034:             $text{'action'} = 'IDs';
                   11035:         }
1.612     raeburn  11036:     }
1.674     bisitz   11037:     $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  11038:     if ($mode eq 'upload') {
                   11039:         if ($checkitem eq 'username') {
                   11040:             $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'}.");
                   11041:         } elsif ($checkitem eq 'id') {
1.674     bisitz   11042:             $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  11043:         }
1.669     raeburn  11044:     } elsif ($mode eq 'selfcreate') {
                   11045:         if ($checkitem eq 'id') {
                   11046:             $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.");
                   11047:         }
1.615     raeburn  11048:     } else {
                   11049:         if ($checkitem eq 'username') {
                   11050:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   11051:         } elsif ($checkitem eq 'id') {
                   11052:             $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.");
                   11053:         }
1.612     raeburn  11054:     }
                   11055:     return $response;
1.585     raeburn  11056: }
                   11057: 
1.624     raeburn  11058: sub personal_data_fieldtitles {
                   11059:     my %fieldtitles = &Apache::lonlocal::texthash (
                   11060:                         id => 'Student/Employee ID',
                   11061:                         permanentemail => 'E-mail address',
                   11062:                         lastname => 'Last Name',
                   11063:                         firstname => 'First Name',
                   11064:                         middlename => 'Middle Name',
                   11065:                         generation => 'Generation',
                   11066:                         gen => 'Generation',
1.765     raeburn  11067:                         inststatus => 'Affiliation',
1.624     raeburn  11068:                    );
                   11069:     return %fieldtitles;
                   11070: }
                   11071: 
1.642     raeburn  11072: sub sorted_inst_types {
                   11073:     my ($dom) = @_;
1.1075.2.70  raeburn  11074:     my ($usertypes,$order);
                   11075:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   11076:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   11077:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   11078:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   11079:     } else {
                   11080:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   11081:     }
1.642     raeburn  11082:     my $othertitle = &mt('All users');
                   11083:     if ($env{'request.course.id'}) {
1.668     raeburn  11084:         $othertitle  = &mt('Any users');
1.642     raeburn  11085:     }
                   11086:     my @types;
                   11087:     if (ref($order) eq 'ARRAY') {
                   11088:         @types = @{$order};
                   11089:     }
                   11090:     if (@types == 0) {
                   11091:         if (ref($usertypes) eq 'HASH') {
                   11092:             @types = sort(keys(%{$usertypes}));
                   11093:         }
                   11094:     }
                   11095:     if (keys(%{$usertypes}) > 0) {
                   11096:         $othertitle = &mt('Other users');
                   11097:     }
                   11098:     return ($othertitle,$usertypes,\@types);
                   11099: }
                   11100: 
1.645     raeburn  11101: sub get_institutional_codes {
1.1075.2.157  raeburn  11102:     my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645     raeburn  11103: # Get complete list of course sections to update
                   11104:     my @currsections = ();
                   11105:     my @currxlists = ();
1.1075.2.157  raeburn  11106:     my (%unclutteredsec,%unclutteredlcsec);
1.645     raeburn  11107:     my $coursecode = $$settings{'internal.coursecode'};
1.1075.2.157  raeburn  11108:     my $crskey = $crs.':'.$coursecode;
                   11109:     @{$unclutteredsec{$crskey}} = ();
                   11110:     @{$unclutteredlcsec{$crskey}} = ();
1.645     raeburn  11111: 
                   11112:     if ($$settings{'internal.sectionnums'} ne '') {
                   11113:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   11114:     }
                   11115: 
                   11116:     if ($$settings{'internal.crosslistings'} ne '') {
                   11117:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   11118:     }
                   11119: 
                   11120:     if (@currxlists > 0) {
1.1075.2.157  raeburn  11121:         foreach my $xl (@currxlists) {
                   11122:             if ($xl =~ /^([^:]+):(\w*)$/) {
1.645     raeburn  11123:                 unless (grep/^$1$/,@{$allcourses}) {
1.1075.2.119  raeburn  11124:                     push(@{$allcourses},$1);
1.645     raeburn  11125:                     $$LC_code{$1} = $2;
                   11126:                 }
                   11127:             }
                   11128:         }
                   11129:     }
1.1075.2.157  raeburn  11130: 
1.645     raeburn  11131:     if (@currsections > 0) {
1.1075.2.157  raeburn  11132:         foreach my $sec (@currsections) {
                   11133:             if ($sec =~ m/^(\w+):(\w*)$/ ) {
                   11134:                 my $instsec = $1;
1.645     raeburn  11135:                 my $lc_sec = $2;
1.1075.2.157  raeburn  11136:                 unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
                   11137:                     push(@{$unclutteredsec{$crskey}},$instsec);
                   11138:                     push(@{$unclutteredlcsec{$crskey}},$lc_sec);
                   11139:                 }
                   11140:             }
                   11141:         }
                   11142:     }
                   11143: 
                   11144:     if (@{$unclutteredsec{$crskey}} > 0) {
                   11145:         my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
                   11146:         if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
                   11147:             for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
                   11148:                 my $sec = $coursecode.$formattedsec{$crskey}[$i];
                   11149:                 unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1075.2.119  raeburn  11150:                     push(@{$allcourses},$sec);
1.1075.2.157  raeburn  11151:                     $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645     raeburn  11152:                 }
                   11153:             }
                   11154:         }
                   11155:     }
                   11156:     return;
                   11157: }
                   11158: 
1.971     raeburn  11159: sub get_standard_codeitems {
                   11160:     return ('Year','Semester','Department','Number','Section');
                   11161: }
                   11162: 
1.112     bowersj2 11163: =pod
                   11164: 
1.780     raeburn  11165: =head1 Slot Helpers
                   11166: 
                   11167: =over 4
                   11168: 
                   11169: =item * sorted_slots()
                   11170: 
1.1040    raeburn  11171: Sorts an array of slot names in order of an optional sort key,
                   11172: default sort is by slot start time (earliest first). 
1.780     raeburn  11173: 
                   11174: Inputs:
                   11175: 
                   11176: =over 4
                   11177: 
                   11178: slotsarr  - Reference to array of unsorted slot names.
                   11179: 
                   11180: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   11181: 
1.1040    raeburn  11182: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   11183: 
1.549     albertel 11184: =back
                   11185: 
1.780     raeburn  11186: Returns:
                   11187: 
                   11188: =over 4
                   11189: 
1.1040    raeburn  11190: sorted   - An array of slot names sorted by a specified sort key 
                   11191:            (default sort key is start time of the slot).
1.780     raeburn  11192: 
                   11193: =back
                   11194: 
                   11195: =cut
                   11196: 
                   11197: 
                   11198: sub sorted_slots {
1.1040    raeburn  11199:     my ($slotsarr,$slots,$sortkey) = @_;
                   11200:     if ($sortkey eq '') {
                   11201:         $sortkey = 'starttime';
                   11202:     }
1.780     raeburn  11203:     my @sorted;
                   11204:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   11205:         @sorted =
                   11206:             sort {
                   11207:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  11208:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  11209:                      }
                   11210:                      if (ref($slots->{$a})) { return -1;}
                   11211:                      if (ref($slots->{$b})) { return 1;}
                   11212:                      return 0;
                   11213:                  } @{$slotsarr};
                   11214:     }
                   11215:     return @sorted;
                   11216: }
                   11217: 
1.1040    raeburn  11218: =pod
                   11219: 
                   11220: =item * get_future_slots()
                   11221: 
                   11222: Inputs:
                   11223: 
                   11224: =over 4
                   11225: 
                   11226: cnum - course number
                   11227: 
                   11228: cdom - course domain
                   11229: 
                   11230: now - current UNIX time
                   11231: 
                   11232: symb - optional symb
                   11233: 
                   11234: =back
                   11235: 
                   11236: Returns:
                   11237: 
                   11238: =over 4
                   11239: 
                   11240: sorted_reservable - ref to array of student_schedulable slots currently 
                   11241:                     reservable, ordered by end date of reservation period.
                   11242: 
                   11243: reservable_now - ref to hash of student_schedulable slots currently
                   11244:                  reservable.
                   11245: 
                   11246:     Keys in inner hash are:
                   11247:     (a) symb: either blank or symb to which slot use is restricted.
1.1075.2.104  raeburn  11248:     (b) endreserve: end date of reservation period.
                   11249:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   11250:         selected.
1.1040    raeburn  11251: 
                   11252: sorted_future - ref to array of student_schedulable slots reservable in
                   11253:                 the future, ordered by start date of reservation period.
                   11254: 
                   11255: future_reservable - ref to hash of student_schedulable slots reservable
                   11256:                     in the future.
                   11257: 
                   11258:     Keys in inner hash are:
                   11259:     (a) symb: either blank or symb to which slot use is restricted.
                   11260:     (b) startreserve:  start date of reservation period.
1.1075.2.104  raeburn  11261:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   11262:         selected.
1.1040    raeburn  11263: 
                   11264: =back
                   11265: 
                   11266: =cut
                   11267: 
                   11268: sub get_future_slots {
                   11269:     my ($cnum,$cdom,$now,$symb) = @_;
                   11270:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   11271:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   11272:     foreach my $slot (keys(%slots)) {
                   11273:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   11274:         if ($symb) {
                   11275:             next if (($slots{$slot}->{'symb'} ne '') && 
                   11276:                      ($slots{$slot}->{'symb'} ne $symb));
                   11277:         }
                   11278:         if (($slots{$slot}->{'starttime'} > $now) &&
                   11279:             ($slots{$slot}->{'endtime'} > $now)) {
                   11280:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   11281:                 my $userallowed = 0;
                   11282:                 if ($slots{$slot}->{'allowedsections'}) {
                   11283:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   11284:                     if (!defined($env{'request.role.sec'})
                   11285:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   11286:                         $userallowed=1;
                   11287:                     } else {
                   11288:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   11289:                             $userallowed=1;
                   11290:                         }
                   11291:                     }
                   11292:                     unless ($userallowed) {
                   11293:                         if (defined($env{'request.course.groups'})) {
                   11294:                             my @groups = split(/:/,$env{'request.course.groups'});
                   11295:                             foreach my $group (@groups) {
                   11296:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   11297:                                     $userallowed=1;
                   11298:                                     last;
                   11299:                                 }
                   11300:                             }
                   11301:                         }
                   11302:                     }
                   11303:                 }
                   11304:                 if ($slots{$slot}->{'allowedusers'}) {
                   11305:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   11306:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   11307:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   11308:                         $userallowed = 1;
                   11309:                     }
                   11310:                 }
                   11311:                 next unless($userallowed);
                   11312:             }
                   11313:             my $startreserve = $slots{$slot}->{'startreserve'};
                   11314:             my $endreserve = $slots{$slot}->{'endreserve'};
                   11315:             my $symb = $slots{$slot}->{'symb'};
1.1075.2.104  raeburn  11316:             my $uniqueperiod;
                   11317:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   11318:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   11319:             }
1.1040    raeburn  11320:             if (($startreserve < $now) &&
                   11321:                 (!$endreserve || $endreserve > $now)) {
                   11322:                 my $lastres = $endreserve;
                   11323:                 if (!$lastres) {
                   11324:                     $lastres = $slots{$slot}->{'starttime'};
                   11325:                 }
                   11326:                 $reservable_now{$slot} = {
                   11327:                                            symb       => $symb,
1.1075.2.104  raeburn  11328:                                            endreserve => $lastres,
                   11329:                                            uniqueperiod => $uniqueperiod,   
1.1040    raeburn  11330:                                          };
                   11331:             } elsif (($startreserve > $now) &&
                   11332:                      (!$endreserve || $endreserve > $startreserve)) {
                   11333:                 $future_reservable{$slot} = {
                   11334:                                               symb         => $symb,
1.1075.2.104  raeburn  11335:                                               startreserve => $startreserve,
                   11336:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  11337:                                             };
                   11338:             }
                   11339:         }
                   11340:     }
                   11341:     my @unsorted_reservable = keys(%reservable_now);
                   11342:     if (@unsorted_reservable > 0) {
                   11343:         @sorted_reservable = 
                   11344:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   11345:     }
                   11346:     my @unsorted_future = keys(%future_reservable);
                   11347:     if (@unsorted_future > 0) {
                   11348:         @sorted_future =
                   11349:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   11350:     }
                   11351:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   11352: }
1.780     raeburn  11353: 
                   11354: =pod
                   11355: 
1.1057    foxr     11356: =back
                   11357: 
1.549     albertel 11358: =head1 HTTP Helpers
                   11359: 
                   11360: =over 4
                   11361: 
1.648     raeburn  11362: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 11363: 
1.258     albertel 11364: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 11365: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 11366: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 11367: 
                   11368: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   11369: $possible_names is an ref to an array of form element names.  As an example:
                   11370: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 11371: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 11372: 
                   11373: =cut
1.1       albertel 11374: 
1.6       albertel 11375: sub get_unprocessed_cgi {
1.25      albertel 11376:   my ($query,$possible_names)= @_;
1.26      matthew  11377:   # $Apache::lonxml::debug=1;
1.356     albertel 11378:   foreach my $pair (split(/&/,$query)) {
                   11379:     my ($name, $value) = split(/=/,$pair);
1.369     www      11380:     $name = &unescape($name);
1.25      albertel 11381:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   11382:       $value =~ tr/+/ /;
                   11383:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 11384:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 11385:     }
1.16      harris41 11386:   }
1.6       albertel 11387: }
                   11388: 
1.112     bowersj2 11389: =pod
                   11390: 
1.648     raeburn  11391: =item * &cacheheader() 
1.112     bowersj2 11392: 
                   11393: returns cache-controlling header code
                   11394: 
                   11395: =cut
                   11396: 
1.7       albertel 11397: sub cacheheader {
1.258     albertel 11398:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 11399:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   11400:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 11401:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   11402:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 11403:     return $output;
1.7       albertel 11404: }
                   11405: 
1.112     bowersj2 11406: =pod
                   11407: 
1.648     raeburn  11408: =item * &no_cache($r) 
1.112     bowersj2 11409: 
                   11410: specifies header code to not have cache
                   11411: 
                   11412: =cut
                   11413: 
1.9       albertel 11414: sub no_cache {
1.216     albertel 11415:     my ($r) = @_;
                   11416:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 11417: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 11418:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   11419:     $r->no_cache(1);
                   11420:     $r->header_out("Expires" => $date);
                   11421:     $r->header_out("Pragma" => "no-cache");
1.123     www      11422: }
                   11423: 
                   11424: sub content_type {
1.181     albertel 11425:     my ($r,$type,$charset) = @_;
1.299     foxr     11426:     if ($r) {
                   11427: 	#  Note that printout.pl calls this with undef for $r.
                   11428: 	&no_cache($r);
                   11429:     }
1.258     albertel 11430:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 11431:     unless ($charset) {
                   11432: 	$charset=&Apache::lonlocal::current_encoding;
                   11433:     }
                   11434:     if ($charset) { $type.='; charset='.$charset; }
                   11435:     if ($r) {
                   11436: 	$r->content_type($type);
                   11437:     } else {
                   11438: 	print("Content-type: $type\n\n");
                   11439:     }
1.9       albertel 11440: }
1.25      albertel 11441: 
1.112     bowersj2 11442: =pod
                   11443: 
1.648     raeburn  11444: =item * &add_to_env($name,$value) 
1.112     bowersj2 11445: 
1.258     albertel 11446: adds $name to the %env hash with value
1.112     bowersj2 11447: $value, if $name already exists, the entry is converted to an array
                   11448: reference and $value is added to the array.
                   11449: 
                   11450: =cut
                   11451: 
1.25      albertel 11452: sub add_to_env {
                   11453:   my ($name,$value)=@_;
1.258     albertel 11454:   if (defined($env{$name})) {
                   11455:     if (ref($env{$name})) {
1.25      albertel 11456:       #already have multiple values
1.258     albertel 11457:       push(@{ $env{$name} },$value);
1.25      albertel 11458:     } else {
                   11459:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 11460:       my $first=$env{$name};
                   11461:       undef($env{$name});
                   11462:       push(@{ $env{$name} },$first,$value);
1.25      albertel 11463:     }
                   11464:   } else {
1.258     albertel 11465:     $env{$name}=$value;
1.25      albertel 11466:   }
1.31      albertel 11467: }
1.149     albertel 11468: 
                   11469: =pod
                   11470: 
1.648     raeburn  11471: =item * &get_env_multiple($name) 
1.149     albertel 11472: 
1.258     albertel 11473: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 11474: values may be defined and end up as an array ref.
                   11475: 
                   11476: returns an array of values
                   11477: 
                   11478: =cut
                   11479: 
                   11480: sub get_env_multiple {
                   11481:     my ($name) = @_;
                   11482:     my @values;
1.258     albertel 11483:     if (defined($env{$name})) {
1.149     albertel 11484:         # exists is it an array
1.258     albertel 11485:         if (ref($env{$name})) {
                   11486:             @values=@{ $env{$name} };
1.149     albertel 11487:         } else {
1.258     albertel 11488:             $values[0]=$env{$name};
1.149     albertel 11489:         }
                   11490:     }
                   11491:     return(@values);
                   11492: }
                   11493: 
1.660     raeburn  11494: sub ask_for_embedded_content {
                   11495:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  11496:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11  raeburn  11497:         %currsubfile,%unused,$rem);
1.1071    raeburn  11498:     my $counter = 0;
                   11499:     my $numnew = 0;
1.987     raeburn  11500:     my $numremref = 0;
                   11501:     my $numinvalid = 0;
                   11502:     my $numpathchg = 0;
                   11503:     my $numexisting = 0;
1.1071    raeburn  11504:     my $numunused = 0;
                   11505:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1075.2.53  raeburn  11506:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  11507:     my $heading = &mt('Upload embedded files');
                   11508:     my $buttontext = &mt('Upload');
                   11509: 
1.1075.2.11  raeburn  11510:     if ($env{'request.course.id'}) {
1.1075.2.35  raeburn  11511:         if ($actionurl eq '/adm/dependencies') {
                   11512:             $navmap = Apache::lonnavmaps::navmap->new();
                   11513:         }
                   11514:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   11515:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11  raeburn  11516:     }
1.1075.2.35  raeburn  11517:     if (($actionurl eq '/adm/portfolio') ||
                   11518:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  11519:         my $current_path='/';
                   11520:         if ($env{'form.currentpath'}) {
                   11521:             $current_path = $env{'form.currentpath'};
                   11522:         }
                   11523:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35  raeburn  11524:             $udom = $cdom;
                   11525:             $uname = $cnum;
1.984     raeburn  11526:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   11527:         } else {
                   11528:             $udom = $env{'user.domain'};
                   11529:             $uname = $env{'user.name'};
                   11530:             $url = '/userfiles/portfolio';
                   11531:         }
1.987     raeburn  11532:         $toplevel = $url.'/';
1.984     raeburn  11533:         $url .= $current_path;
                   11534:         $getpropath = 1;
1.987     raeburn  11535:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   11536:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      11537:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  11538:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  11539:         $toplevel = $url;
1.984     raeburn  11540:         if ($rest ne '') {
1.987     raeburn  11541:             $url .= $rest;
                   11542:         }
                   11543:     } elsif ($actionurl eq '/adm/coursedocs') {
                   11544:         if (ref($args) eq 'HASH') {
1.1071    raeburn  11545:             $url = $args->{'docs_url'};
                   11546:             $toplevel = $url;
1.1075.2.11  raeburn  11547:             if ($args->{'context'} eq 'paste') {
                   11548:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   11549:                 ($path) =
                   11550:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   11551:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   11552:                 $fileloc =~ s{^/}{};
                   11553:             }
1.1071    raeburn  11554:         }
                   11555:     } elsif ($actionurl eq '/adm/dependencies') {
                   11556:         if ($env{'request.course.id'} ne '') {
                   11557:             if (ref($args) eq 'HASH') {
                   11558:                 $url = $args->{'docs_url'};
                   11559:                 $title = $args->{'docs_title'};
1.1075.2.35  raeburn  11560:                 $toplevel = $url;
                   11561:                 unless ($toplevel =~ m{^/}) {
                   11562:                     $toplevel = "/$url";
                   11563:                 }
1.1075.2.11  raeburn  11564:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35  raeburn  11565:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   11566:                     $path = $1;
                   11567:                 } else {
                   11568:                     ($path) =
                   11569:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   11570:                 }
1.1075.2.79  raeburn  11571:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   11572:                     $fileloc = $toplevel;
                   11573:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   11574:                     my ($udom,$uname,$fname) =
                   11575:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   11576:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   11577:                 } else {
                   11578:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   11579:                 }
1.1071    raeburn  11580:                 $fileloc =~ s{^/}{};
                   11581:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   11582:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   11583:             }
1.987     raeburn  11584:         }
1.1075.2.35  raeburn  11585:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   11586:         $udom = $cdom;
                   11587:         $uname = $cnum;
                   11588:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   11589:         $toplevel = $url;
                   11590:         $path = $url;
                   11591:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   11592:         $fileloc =~ s{^/}{};
                   11593:     }
                   11594:     foreach my $file (keys(%{$allfiles})) {
                   11595:         my $embed_file;
                   11596:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   11597:             $embed_file = $1;
                   11598:         } else {
                   11599:             $embed_file = $file;
                   11600:         }
1.1075.2.55  raeburn  11601:         my ($absolutepath,$cleaned_file);
                   11602:         if ($embed_file =~ m{^\w+://}) {
                   11603:             $cleaned_file = $embed_file;
1.1075.2.47  raeburn  11604:             $newfiles{$cleaned_file} = 1;
                   11605:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  11606:         } else {
1.1075.2.55  raeburn  11607:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  11608:             if ($embed_file =~ m{^/}) {
                   11609:                 $absolutepath = $embed_file;
                   11610:             }
1.1075.2.47  raeburn  11611:             if ($cleaned_file =~ m{/}) {
                   11612:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  11613:                 $path = &check_for_traversal($path,$url,$toplevel);
                   11614:                 my $item = $fname;
                   11615:                 if ($path ne '') {
                   11616:                     $item = $path.'/'.$fname;
                   11617:                     $subdependencies{$path}{$fname} = 1;
                   11618:                 } else {
                   11619:                     $dependencies{$item} = 1;
                   11620:                 }
                   11621:                 if ($absolutepath) {
                   11622:                     $mapping{$item} = $absolutepath;
                   11623:                 } else {
                   11624:                     $mapping{$item} = $embed_file;
                   11625:                 }
                   11626:             } else {
                   11627:                 $dependencies{$embed_file} = 1;
                   11628:                 if ($absolutepath) {
1.1075.2.47  raeburn  11629:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  11630:                 } else {
1.1075.2.47  raeburn  11631:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  11632:                 }
                   11633:             }
1.984     raeburn  11634:         }
                   11635:     }
1.1071    raeburn  11636:     my $dirptr = 16384;
1.984     raeburn  11637:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  11638:         $currsubfile{$path} = {};
1.1075.2.35  raeburn  11639:         if (($actionurl eq '/adm/portfolio') ||
                   11640:             ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  11641:             my ($sublistref,$listerror) =
                   11642:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   11643:             if (ref($sublistref) eq 'ARRAY') {
                   11644:                 foreach my $line (@{$sublistref}) {
                   11645:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  11646:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  11647:                 }
1.984     raeburn  11648:             }
1.987     raeburn  11649:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11650:             if (opendir(my $dir,$url.'/'.$path)) {
                   11651:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  11652:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   11653:             }
1.1075.2.11  raeburn  11654:         } elsif (($actionurl eq '/adm/dependencies') ||
                   11655:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11656:                   ($args->{'context'} eq 'paste')) ||
                   11657:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11658:             if ($env{'request.course.id'} ne '') {
1.1075.2.35  raeburn  11659:                 my $dir;
                   11660:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   11661:                     $dir = $fileloc;
                   11662:                 } else {
                   11663:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11664:                 }
1.1071    raeburn  11665:                 if ($dir ne '') {
                   11666:                     my ($sublistref,$listerror) =
                   11667:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   11668:                     if (ref($sublistref) eq 'ARRAY') {
                   11669:                         foreach my $line (@{$sublistref}) {
                   11670:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   11671:                                 undef,$mtime)=split(/\&/,$line,12);
                   11672:                             unless (($testdir&$dirptr) ||
                   11673:                                     ($file_name =~ /^\.\.?$/)) {
                   11674:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   11675:                             }
                   11676:                         }
                   11677:                     }
                   11678:                 }
1.984     raeburn  11679:             }
                   11680:         }
                   11681:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  11682:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  11683:                 my $item = $path.'/'.$file;
                   11684:                 unless ($mapping{$item} eq $item) {
                   11685:                     $pathchanges{$item} = 1;
                   11686:                 }
                   11687:                 $existing{$item} = 1;
                   11688:                 $numexisting ++;
                   11689:             } else {
                   11690:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  11691:             }
                   11692:         }
1.1071    raeburn  11693:         if ($actionurl eq '/adm/dependencies') {
                   11694:             foreach my $path (keys(%currsubfile)) {
                   11695:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   11696:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   11697:                          unless ($subdependencies{$path}{$file}) {
1.1075.2.11  raeburn  11698:                              next if (($rem ne '') &&
                   11699:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   11700:                                        (ref($navmap) &&
                   11701:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   11702:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11703:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  11704:                              $unused{$path.'/'.$file} = 1; 
                   11705:                          }
                   11706:                     }
                   11707:                 }
                   11708:             }
                   11709:         }
1.984     raeburn  11710:     }
1.987     raeburn  11711:     my %currfile;
1.1075.2.35  raeburn  11712:     if (($actionurl eq '/adm/portfolio') ||
                   11713:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  11714:         my ($dirlistref,$listerror) =
                   11715:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   11716:         if (ref($dirlistref) eq 'ARRAY') {
                   11717:             foreach my $line (@{$dirlistref}) {
                   11718:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   11719:                 $currfile{$file_name} = 1;
                   11720:             }
1.984     raeburn  11721:         }
1.987     raeburn  11722:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11723:         if (opendir(my $dir,$url)) {
1.987     raeburn  11724:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  11725:             map {$currfile{$_} = 1;} @dir_list;
                   11726:         }
1.1075.2.11  raeburn  11727:     } elsif (($actionurl eq '/adm/dependencies') ||
                   11728:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11729:               ($args->{'context'} eq 'paste')) ||
                   11730:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11731:         if ($env{'request.course.id'} ne '') {
                   11732:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11733:             if ($dir ne '') {
                   11734:                 my ($dirlistref,$listerror) =
                   11735:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   11736:                 if (ref($dirlistref) eq 'ARRAY') {
                   11737:                     foreach my $line (@{$dirlistref}) {
                   11738:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   11739:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   11740:                         unless (($testdir&$dirptr) ||
                   11741:                                 ($file_name =~ /^\.\.?$/)) {
                   11742:                             $currfile{$file_name} = [$size,$mtime];
                   11743:                         }
                   11744:                     }
                   11745:                 }
                   11746:             }
                   11747:         }
1.984     raeburn  11748:     }
                   11749:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  11750:         if (exists($currfile{$file})) {
1.987     raeburn  11751:             unless ($mapping{$file} eq $file) {
                   11752:                 $pathchanges{$file} = 1;
                   11753:             }
                   11754:             $existing{$file} = 1;
                   11755:             $numexisting ++;
                   11756:         } else {
1.984     raeburn  11757:             $newfiles{$file} = 1;
                   11758:         }
                   11759:     }
1.1071    raeburn  11760:     foreach my $file (keys(%currfile)) {
                   11761:         unless (($file eq $filename) ||
                   11762:                 ($file eq $filename.'.bak') ||
                   11763:                 ($dependencies{$file})) {
1.1075.2.11  raeburn  11764:             if ($actionurl eq '/adm/dependencies') {
1.1075.2.35  raeburn  11765:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   11766:                     next if (($rem ne '') &&
                   11767:                              (($env{"httpref.$rem".$file} ne '') ||
                   11768:                               (ref($navmap) &&
                   11769:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   11770:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11771:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   11772:                 }
1.1075.2.11  raeburn  11773:             }
1.1071    raeburn  11774:             $unused{$file} = 1;
                   11775:         }
                   11776:     }
1.1075.2.11  raeburn  11777:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   11778:         ($args->{'context'} eq 'paste')) {
                   11779:         $counter = scalar(keys(%existing));
                   11780:         $numpathchg = scalar(keys(%pathchanges));
                   11781:         return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35  raeburn  11782:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
                   11783:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   11784:         $counter = scalar(keys(%existing));
                   11785:         $numpathchg = scalar(keys(%pathchanges));
                   11786:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11  raeburn  11787:     }
1.984     raeburn  11788:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  11789:         if ($actionurl eq '/adm/dependencies') {
                   11790:             next if ($embed_file =~ m{^\w+://});
                   11791:         }
1.660     raeburn  11792:         $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11793:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  11794:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  11795:         unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35  raeburn  11796:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   11797:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  11798:         }
1.1075.2.35  raeburn  11799:         $upload_output .= '</td>';
1.1071    raeburn  11800:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1075.2.35  raeburn  11801:             $upload_output.='<td align="right">'.
                   11802:                             '<span class="LC_info LC_fontsize_medium">'.
                   11803:                             &mt("URL points to web address").'</span>';
1.987     raeburn  11804:             $numremref++;
1.660     raeburn  11805:         } elsif ($args->{'error_on_invalid_names'}
                   11806:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35  raeburn  11807:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   11808:                             &mt('Invalid characters').'</span>';
1.987     raeburn  11809:             $numinvalid++;
1.660     raeburn  11810:         } else {
1.1075.2.35  raeburn  11811:             $upload_output .= '<td>'.
                   11812:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  11813:                                                      $embed_file,\%mapping,
1.1071    raeburn  11814:                                                      $allfiles,$codebase,'upload');
                   11815:             $counter ++;
                   11816:             $numnew ++;
1.987     raeburn  11817:         }
                   11818:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   11819:     }
                   11820:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  11821:         if ($actionurl eq '/adm/dependencies') {
                   11822:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   11823:             $modify_output .= &start_data_table_row().
                   11824:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   11825:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   11826:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   11827:                               '<td>'.$size.'</td>'.
                   11828:                               '<td>'.$mtime.'</td>'.
                   11829:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   11830:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   11831:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   11832:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   11833:                               &embedded_file_element('upload_embedded',$counter,
                   11834:                                                      $embed_file,\%mapping,
                   11835:                                                      $allfiles,$codebase,'modify').
                   11836:                               '</div></td>'.
                   11837:                               &end_data_table_row()."\n";
                   11838:             $counter ++;
                   11839:         } else {
                   11840:             $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11841:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   11842:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   11843:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  11844:                               &Apache::loncommon::end_data_table_row()."\n";
                   11845:         }
                   11846:     }
                   11847:     my $delidx = $counter;
                   11848:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   11849:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   11850:         $delete_output .= &start_data_table_row().
                   11851:                           '<td><img src="'.&icon($oldfile).'" />'.
                   11852:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   11853:                           '<td>'.$size.'</td>'.
                   11854:                           '<td>'.$mtime.'</td>'.
                   11855:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   11856:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   11857:                           &embedded_file_element('upload_embedded',$delidx,
                   11858:                                                  $oldfile,\%mapping,$allfiles,
                   11859:                                                  $codebase,'delete').'</td>'.
                   11860:                           &end_data_table_row()."\n"; 
                   11861:         $numunused ++;
                   11862:         $delidx ++;
1.987     raeburn  11863:     }
                   11864:     if ($upload_output) {
                   11865:         $upload_output = &start_data_table().
                   11866:                          $upload_output.
                   11867:                          &end_data_table()."\n";
                   11868:     }
1.1071    raeburn  11869:     if ($modify_output) {
                   11870:         $modify_output = &start_data_table().
                   11871:                          &start_data_table_header_row().
                   11872:                          '<th>'.&mt('File').'</th>'.
                   11873:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11874:                          '<th>'.&mt('Modified').'</th>'.
                   11875:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   11876:                          &end_data_table_header_row().
                   11877:                          $modify_output.
                   11878:                          &end_data_table()."\n";
                   11879:     }
                   11880:     if ($delete_output) {
                   11881:         $delete_output = &start_data_table().
                   11882:                          &start_data_table_header_row().
                   11883:                          '<th>'.&mt('File').'</th>'.
                   11884:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11885:                          '<th>'.&mt('Modified').'</th>'.
                   11886:                          '<th>'.&mt('Delete?').'</th>'.
                   11887:                          &end_data_table_header_row().
                   11888:                          $delete_output.
                   11889:                          &end_data_table()."\n";
                   11890:     }
1.987     raeburn  11891:     my $applies = 0;
                   11892:     if ($numremref) {
                   11893:         $applies ++;
                   11894:     }
                   11895:     if ($numinvalid) {
                   11896:         $applies ++;
                   11897:     }
                   11898:     if ($numexisting) {
                   11899:         $applies ++;
                   11900:     }
1.1071    raeburn  11901:     if ($counter || $numunused) {
1.987     raeburn  11902:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   11903:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  11904:                   $state.'<h3>'.$heading.'</h3>'; 
                   11905:         if ($actionurl eq '/adm/dependencies') {
                   11906:             if ($numnew) {
                   11907:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   11908:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   11909:                            $upload_output.'<br />'."\n";
                   11910:             }
                   11911:             if ($numexisting) {
                   11912:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   11913:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   11914:                            $modify_output.'<br />'."\n";
                   11915:                            $buttontext = &mt('Save changes');
                   11916:             }
                   11917:             if ($numunused) {
                   11918:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   11919:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   11920:                            $delete_output.'<br />'."\n";
                   11921:                            $buttontext = &mt('Save changes');
                   11922:             }
                   11923:         } else {
                   11924:             $output .= $upload_output.'<br />'."\n";
                   11925:         }
                   11926:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   11927:                    $counter.'" />'."\n";
                   11928:         if ($actionurl eq '/adm/dependencies') { 
                   11929:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   11930:                        $numnew.'" />'."\n";
                   11931:         } elsif ($actionurl eq '') {
1.987     raeburn  11932:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   11933:         }
                   11934:     } elsif ($applies) {
                   11935:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   11936:         if ($applies > 1) {
                   11937:             $output .=  
1.1075.2.35  raeburn  11938:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  11939:             if ($numremref) {
                   11940:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   11941:             }
                   11942:             if ($numinvalid) {
                   11943:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   11944:             }
                   11945:             if ($numexisting) {
                   11946:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   11947:             }
                   11948:             $output .= '</ul><br />';
                   11949:         } elsif ($numremref) {
                   11950:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   11951:         } elsif ($numinvalid) {
                   11952:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   11953:         } elsif ($numexisting) {
                   11954:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   11955:         }
                   11956:         $output .= $upload_output.'<br />';
                   11957:     }
                   11958:     my ($pathchange_output,$chgcount);
1.1071    raeburn  11959:     $chgcount = $counter;
1.987     raeburn  11960:     if (keys(%pathchanges) > 0) {
                   11961:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  11962:             if ($counter) {
1.987     raeburn  11963:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   11964:                                                   $embed_file,\%mapping,
1.1071    raeburn  11965:                                                   $allfiles,$codebase,'change');
1.987     raeburn  11966:             } else {
                   11967:                 $pathchange_output .= 
                   11968:                     &start_data_table_row().
                   11969:                     '<td><input type ="checkbox" name="namechange" value="'.
                   11970:                     $chgcount.'" checked="checked" /></td>'.
                   11971:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   11972:                     '<td>'.$embed_file.
                   11973:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  11974:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  11975:                     '</td>'.&end_data_table_row();
1.660     raeburn  11976:             }
1.987     raeburn  11977:             $numpathchg ++;
                   11978:             $chgcount ++;
1.660     raeburn  11979:         }
                   11980:     }
1.1075.2.35  raeburn  11981:     if (($counter) || ($numunused)) {
1.987     raeburn  11982:         if ($numpathchg) {
                   11983:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   11984:                        $numpathchg.'" />'."\n";
                   11985:         }
                   11986:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   11987:             ($actionurl eq '/adm/imsimport')) {
                   11988:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   11989:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   11990:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  11991:         } elsif ($actionurl eq '/adm/dependencies') {
                   11992:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  11993:         }
1.1075.2.35  raeburn  11994:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  11995:     } elsif ($numpathchg) {
                   11996:         my %pathchange = ();
                   11997:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   11998:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11999:             $output .= '<p>'.&mt('or').'</p>'; 
1.1075.2.35  raeburn  12000:         }
1.987     raeburn  12001:     }
1.1071    raeburn  12002:     return ($output,$counter,$numpathchg);
1.987     raeburn  12003: }
                   12004: 
1.1075.2.47  raeburn  12005: =pod
                   12006: 
                   12007: =item * clean_path($name)
                   12008: 
                   12009: Performs clean-up of directories, subdirectories and filename in an
                   12010: embedded object, referenced in an HTML file which is being uploaded
                   12011: to a course or portfolio, where
                   12012: "Upload embedded images/multimedia files if HTML file" checkbox was
                   12013: checked.
                   12014: 
                   12015: Clean-up is similar to replacements in lonnet::clean_filename()
                   12016: except each / between sub-directory and next level is preserved.
                   12017: 
                   12018: =cut
                   12019: 
                   12020: sub clean_path {
                   12021:     my ($embed_file) = @_;
                   12022:     $embed_file =~s{^/+}{};
                   12023:     my @contents;
                   12024:     if ($embed_file =~ m{/}) {
                   12025:         @contents = split(/\//,$embed_file);
                   12026:     } else {
                   12027:         @contents = ($embed_file);
                   12028:     }
                   12029:     my $lastidx = scalar(@contents)-1;
                   12030:     for (my $i=0; $i<=$lastidx; $i++) {
                   12031:         $contents[$i]=~s{\\}{/}g;
                   12032:         $contents[$i]=~s/\s+/\_/g;
                   12033:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   12034:         if ($i == $lastidx) {
                   12035:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   12036:         }
                   12037:     }
                   12038:     if ($lastidx > 0) {
                   12039:         return join('/',@contents);
                   12040:     } else {
                   12041:         return $contents[0];
                   12042:     }
                   12043: }
                   12044: 
1.987     raeburn  12045: sub embedded_file_element {
1.1071    raeburn  12046:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  12047:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   12048:                    (ref($codebase) eq 'HASH'));
                   12049:     my $output;
1.1071    raeburn  12050:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  12051:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   12052:     }
                   12053:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   12054:                &escape($embed_file).'" />';
                   12055:     unless (($context eq 'upload_embedded') && 
                   12056:             ($mapping->{$embed_file} eq $embed_file)) {
                   12057:         $output .='
                   12058:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   12059:     }
                   12060:     my $attrib;
                   12061:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   12062:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   12063:     }
                   12064:     $output .=
                   12065:         "\n\t\t".
                   12066:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   12067:         $attrib.'" />';
                   12068:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   12069:         $output .=
                   12070:             "\n\t\t".
                   12071:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   12072:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  12073:     }
1.987     raeburn  12074:     return $output;
1.660     raeburn  12075: }
                   12076: 
1.1071    raeburn  12077: sub get_dependency_details {
                   12078:     my ($currfile,$currsubfile,$embed_file) = @_;
                   12079:     my ($size,$mtime,$showsize,$showmtime);
                   12080:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   12081:         if ($embed_file =~ m{/}) {
                   12082:             my ($path,$fname) = split(/\//,$embed_file);
                   12083:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   12084:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   12085:             }
                   12086:         } else {
                   12087:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   12088:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   12089:             }
                   12090:         }
                   12091:         $showsize = $size/1024.0;
                   12092:         $showsize = sprintf("%.1f",$showsize);
                   12093:         if ($mtime > 0) {
                   12094:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   12095:         }
                   12096:     }
                   12097:     return ($showsize,$showmtime);
                   12098: }
                   12099: 
                   12100: sub ask_embedded_js {
                   12101:     return <<"END";
                   12102: <script type="text/javascript"">
                   12103: // <![CDATA[
                   12104: function toggleBrowse(counter) {
                   12105:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   12106:     var fileid = document.getElementById('embedded_item_'+counter);
                   12107:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   12108:     if (chkboxid.checked == true) {
                   12109:         uploaddivid.style.display='block';
                   12110:     } else {
                   12111:         uploaddivid.style.display='none';
                   12112:         fileid.value = '';
                   12113:     }
                   12114: }
                   12115: // ]]>
                   12116: </script>
                   12117: 
                   12118: END
                   12119: }
                   12120: 
1.661     raeburn  12121: sub upload_embedded {
                   12122:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  12123:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   12124:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  12125:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   12126:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   12127:         my $orig_uploaded_filename =
                   12128:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  12129:         foreach my $type ('orig','ref','attrib','codebase') {
                   12130:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   12131:                 $env{'form.embedded_'.$type.'_'.$i} =
                   12132:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   12133:             }
                   12134:         }
1.661     raeburn  12135:         my ($path,$fname) =
                   12136:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   12137:         # no path, whole string is fname
                   12138:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   12139:         $fname = &Apache::lonnet::clean_filename($fname);
                   12140:         # See if there is anything left
                   12141:         next if ($fname eq '');
                   12142: 
                   12143:         # Check if file already exists as a file or directory.
                   12144:         my ($state,$msg);
                   12145:         if ($context eq 'portfolio') {
                   12146:             my $port_path = $dirpath;
                   12147:             if ($group ne '') {
                   12148:                 $port_path = "groups/$group/$port_path";
                   12149:             }
1.987     raeburn  12150:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   12151:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  12152:                                               $dir_root,$port_path,$disk_quota,
                   12153:                                               $current_disk_usage,$uname,$udom);
                   12154:             if ($state eq 'will_exceed_quota'
1.984     raeburn  12155:                 || $state eq 'file_locked') {
1.661     raeburn  12156:                 $output .= $msg;
                   12157:                 next;
                   12158:             }
                   12159:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   12160:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   12161:             if ($state eq 'exists') {
                   12162:                 $output .= $msg;
                   12163:                 next;
                   12164:             }
                   12165:         }
                   12166:         # Check if extension is valid
                   12167:         if (($fname =~ /\.(\w+)$/) &&
                   12168:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1075.2.53  raeburn  12169:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   12170:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  12171:             next;
                   12172:         } elsif (($fname =~ /\.(\w+)$/) &&
                   12173:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  12174:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  12175:             next;
                   12176:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34  raeburn  12177:             $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  12178:             next;
                   12179:         }
                   12180:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35  raeburn  12181:         my $subdir = $path;
                   12182:         $subdir =~ s{/+$}{};
1.661     raeburn  12183:         if ($context eq 'portfolio') {
1.984     raeburn  12184:             my $result;
                   12185:             if ($state eq 'existingfile') {
                   12186:                 $result=
                   12187:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35  raeburn  12188:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  12189:             } else {
1.984     raeburn  12190:                 $result=
                   12191:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  12192:                                                     $dirpath.
1.1075.2.35  raeburn  12193:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  12194:                 if ($result !~ m|^/uploaded/|) {
                   12195:                     $output .= '<span class="LC_error">'
                   12196:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   12197:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   12198:                                .'</span><br />';
                   12199:                     next;
                   12200:                 } else {
1.987     raeburn  12201:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   12202:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  12203:                 }
1.661     raeburn  12204:             }
1.1075.2.35  raeburn  12205:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
                   12206:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   12207:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  12208:             my $result =
1.1075.2.35  raeburn  12209:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  12210:             if ($result !~ m|^/uploaded/|) {
                   12211:                 $output .= '<span class="LC_error">'
                   12212:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   12213:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   12214:                            .'</span><br />';
                   12215:                     next;
                   12216:             } else {
                   12217:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   12218:                            $path.$fname.'</span>').'<br />';
1.1075.2.35  raeburn  12219:                 if ($context eq 'syllabus') {
                   12220:                     &Apache::lonnet::make_public_indefinitely($result);
                   12221:                 }
1.987     raeburn  12222:             }
1.661     raeburn  12223:         } else {
                   12224: # Save the file
                   12225:             my $target = $env{'form.embedded_item_'.$i};
                   12226:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   12227:             my $dest = $fullpath.$fname;
                   12228:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  12229:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  12230:             my $count;
                   12231:             my $filepath = $dir_root;
1.1027    raeburn  12232:             foreach my $subdir (@parts) {
                   12233:                 $filepath .= "/$subdir";
                   12234:                 if (!-e $filepath) {
1.661     raeburn  12235:                     mkdir($filepath,0770);
                   12236:                 }
                   12237:             }
                   12238:             my $fh;
                   12239:             if (!open($fh,'>'.$dest)) {
                   12240:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   12241:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  12242:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   12243:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  12244:                            '</span><br />';
                   12245:             } else {
                   12246:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   12247:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   12248:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  12249:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   12250:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  12251:                               '</span><br />';
                   12252:                 } else {
1.987     raeburn  12253:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   12254:                                $url.'</span>').'<br />';
                   12255:                     unless ($context eq 'testbank') {
                   12256:                         $footer .= &mt('View embedded file: [_1]',
                   12257:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   12258:                     }
                   12259:                 }
                   12260:                 close($fh);
                   12261:             }
                   12262:         }
                   12263:         if ($env{'form.embedded_ref_'.$i}) {
                   12264:             $pathchange{$i} = 1;
                   12265:         }
                   12266:     }
                   12267:     if ($output) {
                   12268:         $output = '<p>'.$output.'</p>';
                   12269:     }
                   12270:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   12271:     $returnflag = 'ok';
1.1071    raeburn  12272:     my $numpathchgs = scalar(keys(%pathchange));
                   12273:     if ($numpathchgs > 0) {
1.987     raeburn  12274:         if ($context eq 'portfolio') {
                   12275:             $output .= '<p>'.&mt('or').'</p>';
                   12276:         } elsif ($context eq 'testbank') {
1.1071    raeburn  12277:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   12278:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  12279:             $returnflag = 'modify_orightml';
                   12280:         }
                   12281:     }
1.1071    raeburn  12282:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  12283: }
                   12284: 
                   12285: sub modify_html_form {
                   12286:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   12287:     my $end = 0;
                   12288:     my $modifyform;
                   12289:     if ($context eq 'upload_embedded') {
                   12290:         return unless (ref($pathchange) eq 'HASH');
                   12291:         if ($env{'form.number_embedded_items'}) {
                   12292:             $end += $env{'form.number_embedded_items'};
                   12293:         }
                   12294:         if ($env{'form.number_pathchange_items'}) {
                   12295:             $end += $env{'form.number_pathchange_items'};
                   12296:         }
                   12297:         if ($end) {
                   12298:             for (my $i=0; $i<$end; $i++) {
                   12299:                 if ($i < $env{'form.number_embedded_items'}) {
                   12300:                     next unless($pathchange->{$i});
                   12301:                 }
                   12302:                 $modifyform .=
                   12303:                     &start_data_table_row().
                   12304:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   12305:                     'checked="checked" /></td>'.
                   12306:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   12307:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   12308:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   12309:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   12310:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   12311:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   12312:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   12313:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   12314:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   12315:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   12316:                     &end_data_table_row();
1.1071    raeburn  12317:             }
1.987     raeburn  12318:         }
                   12319:     } else {
                   12320:         $modifyform = $pathchgtable;
                   12321:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   12322:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   12323:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   12324:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   12325:         }
                   12326:     }
                   12327:     if ($modifyform) {
1.1071    raeburn  12328:         if ($actionurl eq '/adm/dependencies') {
                   12329:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   12330:         }
1.987     raeburn  12331:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   12332:                '<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".
                   12333:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   12334:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   12335:                '</ol></p>'."\n".'<p>'.
                   12336:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   12337:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   12338:                &start_data_table()."\n".
                   12339:                &start_data_table_header_row().
                   12340:                '<th>'.&mt('Change?').'</th>'.
                   12341:                '<th>'.&mt('Current reference').'</th>'.
                   12342:                '<th>'.&mt('Required reference').'</th>'.
                   12343:                &end_data_table_header_row()."\n".
                   12344:                $modifyform.
                   12345:                &end_data_table().'<br />'."\n".$hiddenstate.
                   12346:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   12347:                '</form>'."\n";
                   12348:     }
                   12349:     return;
                   12350: }
                   12351: 
                   12352: sub modify_html_refs {
1.1075.2.35  raeburn  12353:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  12354:     my $container;
                   12355:     if ($context eq 'portfolio') {
                   12356:         $container = $env{'form.container'};
                   12357:     } elsif ($context eq 'coursedoc') {
                   12358:         $container = $env{'form.primaryurl'};
1.1071    raeburn  12359:     } elsif ($context eq 'manage_dependencies') {
                   12360:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   12361:         $container = "/$container";
1.1075.2.35  raeburn  12362:     } elsif ($context eq 'syllabus') {
                   12363:         $container = $url;
1.987     raeburn  12364:     } else {
1.1027    raeburn  12365:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  12366:     }
                   12367:     my (%allfiles,%codebase,$output,$content);
                   12368:     my @changes = &get_env_multiple('form.namechange');
1.1075.2.35  raeburn  12369:     unless ((@changes > 0)  || ($context eq 'syllabus')) {
1.1071    raeburn  12370:         if (wantarray) {
                   12371:             return ('',0,0); 
                   12372:         } else {
                   12373:             return;
                   12374:         }
                   12375:     }
                   12376:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  12377:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  12378:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   12379:             if (wantarray) {
                   12380:                 return ('',0,0);
                   12381:             } else {
                   12382:                 return;
                   12383:             }
                   12384:         } 
1.987     raeburn  12385:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  12386:         if ($content eq '-1') {
                   12387:             if (wantarray) {
                   12388:                 return ('',0,0);
                   12389:             } else {
                   12390:                 return;
                   12391:             }
                   12392:         }
1.987     raeburn  12393:     } else {
1.1071    raeburn  12394:         unless ($container =~ /^\Q$dir_root\E/) {
                   12395:             if (wantarray) {
                   12396:                 return ('',0,0);
                   12397:             } else {
                   12398:                 return;
                   12399:             }
                   12400:         } 
1.1075.2.128  raeburn  12401:         if (open(my $fh,'<',$container)) {
1.987     raeburn  12402:             $content = join('', <$fh>);
                   12403:             close($fh);
                   12404:         } else {
1.1071    raeburn  12405:             if (wantarray) {
                   12406:                 return ('',0,0);
                   12407:             } else {
                   12408:                 return;
                   12409:             }
1.987     raeburn  12410:         }
                   12411:     }
                   12412:     my ($count,$codebasecount) = (0,0);
                   12413:     my $mm = new File::MMagic;
                   12414:     my $mime_type = $mm->checktype_contents($content);
                   12415:     if ($mime_type eq 'text/html') {
                   12416:         my $parse_result = 
                   12417:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   12418:                                                     \%codebase,\$content);
                   12419:         if ($parse_result eq 'ok') {
                   12420:             foreach my $i (@changes) {
                   12421:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   12422:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   12423:                 if ($allfiles{$ref}) {
                   12424:                     my $newname =  $orig;
                   12425:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  12426:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  12427:                     if ($attrib_regexp =~ /:/) {
                   12428:                         $attrib_regexp =~ s/\:/|/g;
                   12429:                     }
                   12430:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   12431:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   12432:                         $count += $numchg;
1.1075.2.35  raeburn  12433:                         $allfiles{$newname} = $allfiles{$ref};
1.1075.2.48  raeburn  12434:                         delete($allfiles{$ref});
1.987     raeburn  12435:                     }
                   12436:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  12437:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  12438:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   12439:                         $codebasecount ++;
                   12440:                     }
                   12441:                 }
                   12442:             }
1.1075.2.35  raeburn  12443:             my $skiprewrites;
1.987     raeburn  12444:             if ($count || $codebasecount) {
                   12445:                 my $saveresult;
1.1071    raeburn  12446:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  12447:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  12448:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   12449:                     if ($url eq $container) {
                   12450:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   12451:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   12452:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  12453:                                             $fname.'</span>').'</p>';
1.987     raeburn  12454:                     } else {
                   12455:                          $output = '<p class="LC_error">'.
                   12456:                                    &mt('Error: update failed for: [_1].',
                   12457:                                    '<span class="LC_filename">'.
                   12458:                                    $container.'</span>').'</p>';
                   12459:                     }
1.1075.2.35  raeburn  12460:                     if ($context eq 'syllabus') {
                   12461:                         unless ($saveresult eq 'ok') {
                   12462:                             $skiprewrites = 1;
                   12463:                         }
                   12464:                     }
1.987     raeburn  12465:                 } else {
1.1075.2.128  raeburn  12466:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  12467:                         print $fh $content;
                   12468:                         close($fh);
                   12469:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   12470:                                   $count,'<span class="LC_filename">'.
                   12471:                                   $container.'</span>').'</p>';
1.661     raeburn  12472:                     } else {
1.987     raeburn  12473:                          $output = '<p class="LC_error">'.
                   12474:                                    &mt('Error: could not update [_1].',
                   12475:                                    '<span class="LC_filename">'.
                   12476:                                    $container.'</span>').'</p>';
1.661     raeburn  12477:                     }
                   12478:                 }
                   12479:             }
1.1075.2.35  raeburn  12480:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   12481:                 my ($actionurl,$state);
                   12482:                 $actionurl = "/public/$udom/$uname/syllabus";
                   12483:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   12484:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   12485:                                               \%codebase,
                   12486:                                               {'context' => 'rewrites',
                   12487:                                                'ignore_remote_references' => 1,});
                   12488:                 if (ref($mapping) eq 'HASH') {
                   12489:                     my $rewrites = 0;
                   12490:                     foreach my $key (keys(%{$mapping})) {
                   12491:                         next if ($key =~ m{^https?://});
                   12492:                         my $ref = $mapping->{$key};
                   12493:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   12494:                         my $attrib;
                   12495:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   12496:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   12497:                         }
                   12498:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   12499:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   12500:                             $rewrites += $numchg;
                   12501:                         }
                   12502:                     }
                   12503:                     if ($rewrites) {
                   12504:                         my $saveresult;
                   12505:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   12506:                         if ($url eq $container) {
                   12507:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   12508:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   12509:                                             $count,'<span class="LC_filename">'.
                   12510:                                             $fname.'</span>').'</p>';
                   12511:                         } else {
                   12512:                             $output .= '<p class="LC_error">'.
                   12513:                                        &mt('Error: could not update links in [_1].',
                   12514:                                        '<span class="LC_filename">'.
                   12515:                                        $container.'</span>').'</p>';
                   12516: 
                   12517:                         }
                   12518:                     }
                   12519:                 }
                   12520:             }
1.987     raeburn  12521:         } else {
                   12522:             &logthis('Failed to parse '.$container.
                   12523:                      ' to modify references: '.$parse_result);
1.661     raeburn  12524:         }
                   12525:     }
1.1071    raeburn  12526:     if (wantarray) {
                   12527:         return ($output,$count,$codebasecount);
                   12528:     } else {
                   12529:         return $output;
                   12530:     }
1.661     raeburn  12531: }
                   12532: 
                   12533: sub check_for_existing {
                   12534:     my ($path,$fname,$element) = @_;
                   12535:     my ($state,$msg);
                   12536:     if (-d $path.'/'.$fname) {
                   12537:         $state = 'exists';
                   12538:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   12539:     } elsif (-e $path.'/'.$fname) {
                   12540:         $state = 'exists';
                   12541:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   12542:     }
                   12543:     if ($state eq 'exists') {
                   12544:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   12545:     }
                   12546:     return ($state,$msg);
                   12547: }
                   12548: 
                   12549: sub check_for_upload {
                   12550:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   12551:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  12552:     my $filesize = length($env{'form.'.$element});
                   12553:     if (!$filesize) {
                   12554:         my $msg = '<span class="LC_error">'.
                   12555:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   12556:                       '<span class="LC_filename">'.$fname.'</span>',
                   12557:                       $filesize).'<br />'.
1.1007    raeburn  12558:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  12559:                   '</span>';
                   12560:         return ('zero_bytes',$msg);
                   12561:     }
                   12562:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  12563:     my $getpropath = 1;
1.1021    raeburn  12564:     my ($dirlistref,$listerror) =
                   12565:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  12566:     my $found_file = 0;
                   12567:     my $locked_file = 0;
1.991     raeburn  12568:     my @lockers;
                   12569:     my $navmap;
                   12570:     if ($env{'request.course.id'}) {
                   12571:         $navmap = Apache::lonnavmaps::navmap->new();
                   12572:     }
1.1021    raeburn  12573:     if (ref($dirlistref) eq 'ARRAY') {
                   12574:         foreach my $line (@{$dirlistref}) {
                   12575:             my ($file_name,$rest)=split(/\&/,$line,2);
                   12576:             if ($file_name eq $fname){
                   12577:                 $file_name = $path.$file_name;
                   12578:                 if ($group ne '') {
                   12579:                     $file_name = $group.$file_name;
                   12580:                 }
                   12581:                 $found_file = 1;
                   12582:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   12583:                     foreach my $lock (@lockers) {
                   12584:                         if (ref($lock) eq 'ARRAY') {
                   12585:                             my ($symb,$crsid) = @{$lock};
                   12586:                             if ($crsid eq $env{'request.course.id'}) {
                   12587:                                 if (ref($navmap)) {
                   12588:                                     my $res = $navmap->getBySymb($symb);
                   12589:                                     foreach my $part (@{$res->parts()}) { 
                   12590:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   12591:                                         unless (($slot_status == $res->RESERVED) ||
                   12592:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   12593:                                             $locked_file = 1;
                   12594:                                         }
1.991     raeburn  12595:                                     }
1.1021    raeburn  12596:                                 } else {
                   12597:                                     $locked_file = 1;
1.991     raeburn  12598:                                 }
                   12599:                             } else {
                   12600:                                 $locked_file = 1;
                   12601:                             }
                   12602:                         }
1.1021    raeburn  12603:                    }
                   12604:                 } else {
                   12605:                     my @info = split(/\&/,$rest);
                   12606:                     my $currsize = $info[6]/1000;
                   12607:                     if ($currsize < $filesize) {
                   12608:                         my $extra = $filesize - $currsize;
                   12609:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1075.2.69  raeburn  12610:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  12611:                                       &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  12612:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   12613:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   12614:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  12615:                             return ('will_exceed_quota',$msg);
                   12616:                         }
1.984     raeburn  12617:                     }
                   12618:                 }
1.661     raeburn  12619:             }
                   12620:         }
                   12621:     }
                   12622:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1075.2.69  raeburn  12623:         my $msg = '<p class="LC_warning">'.
                   12624:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
                   12625:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  12626:         return ('will_exceed_quota',$msg);
                   12627:     } elsif ($found_file) {
                   12628:         if ($locked_file) {
1.1075.2.69  raeburn  12629:             my $msg = '<p class="LC_warning">';
1.661     raeburn  12630:             $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  12631:             $msg .= '</p>';
1.661     raeburn  12632:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   12633:             return ('file_locked',$msg);
                   12634:         } else {
1.1075.2.69  raeburn  12635:             my $msg = '<p class="LC_error">';
1.984     raeburn  12636:             $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  12637:             $msg .= '</p>';
1.984     raeburn  12638:             return ('existingfile',$msg);
1.661     raeburn  12639:         }
                   12640:     }
                   12641: }
                   12642: 
1.987     raeburn  12643: sub check_for_traversal {
                   12644:     my ($path,$url,$toplevel) = @_;
                   12645:     my @parts=split(/\//,$path);
                   12646:     my $cleanpath;
                   12647:     my $fullpath = $url;
                   12648:     for (my $i=0;$i<@parts;$i++) {
                   12649:         next if ($parts[$i] eq '.');
                   12650:         if ($parts[$i] eq '..') {
                   12651:             $fullpath =~ s{([^/]+/)$}{};
                   12652:         } else {
                   12653:             $fullpath .= $parts[$i].'/';
                   12654:         }
                   12655:     }
                   12656:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   12657:         $cleanpath = $1;
                   12658:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   12659:         my $curr_toprel = $1;
                   12660:         my @parts = split(/\//,$curr_toprel);
                   12661:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   12662:         my @urlparts = split(/\//,$url_toprel);
                   12663:         my $doubledots;
                   12664:         my $startdiff = -1;
                   12665:         for (my $i=0; $i<@urlparts; $i++) {
                   12666:             if ($startdiff == -1) {
                   12667:                 unless ($urlparts[$i] eq $parts[$i]) {
                   12668:                     $startdiff = $i;
                   12669:                     $doubledots .= '../';
                   12670:                 }
                   12671:             } else {
                   12672:                 $doubledots .= '../';
                   12673:             }
                   12674:         }
                   12675:         if ($startdiff > -1) {
                   12676:             $cleanpath = $doubledots;
                   12677:             for (my $i=$startdiff; $i<@parts; $i++) {
                   12678:                 $cleanpath .= $parts[$i].'/';
                   12679:             }
                   12680:         }
                   12681:     }
                   12682:     $cleanpath =~ s{(/)$}{};
                   12683:     return $cleanpath;
                   12684: }
1.31      albertel 12685: 
1.1053    raeburn  12686: sub is_archive_file {
                   12687:     my ($mimetype) = @_;
                   12688:     if (($mimetype eq 'application/octet-stream') ||
                   12689:         ($mimetype eq 'application/x-stuffit') ||
                   12690:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   12691:         return 1;
                   12692:     }
                   12693:     return;
                   12694: }
                   12695: 
                   12696: sub decompress_form {
1.1065    raeburn  12697:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  12698:     my %lt = &Apache::lonlocal::texthash (
                   12699:         this => 'This file is an archive file.',
1.1067    raeburn  12700:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  12701:         itsc => 'Its contents are as follows:',
1.1053    raeburn  12702:         youm => 'You may wish to extract its contents.',
                   12703:         extr => 'Extract contents',
1.1067    raeburn  12704:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   12705:         proa => 'Process automatically?',
1.1053    raeburn  12706:         yes  => 'Yes',
                   12707:         no   => 'No',
1.1067    raeburn  12708:         fold => 'Title for folder containing movie',
                   12709:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  12710:     );
1.1065    raeburn  12711:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  12712:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  12713:     my $info = &list_archive_contents($fileloc,\@paths);
                   12714:     if (@paths) {
                   12715:         foreach my $path (@paths) {
                   12716:             $path =~ s{^/}{};
1.1067    raeburn  12717:             if ($path =~ m{^([^/]+)/$}) {
                   12718:                 $topdir = $1;
                   12719:             }
1.1065    raeburn  12720:             if ($path =~ m{^([^/]+)/}) {
                   12721:                 $toplevel{$1} = $path;
                   12722:             } else {
                   12723:                 $toplevel{$path} = $path;
                   12724:             }
                   12725:         }
                   12726:     }
1.1067    raeburn  12727:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1075.2.59  raeburn  12728:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  12729:                         "$topdir/media/",
                   12730:                         "$topdir/media/$topdir.mp4",
                   12731:                         "$topdir/media/FirstFrame.png",
                   12732:                         "$topdir/media/player.swf",
                   12733:                         "$topdir/media/swfobject.js",
                   12734:                         "$topdir/media/expressInstall.swf");
1.1075.2.81  raeburn  12735:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1075.2.59  raeburn  12736:                          "$topdir/$topdir.mp4",
                   12737:                          "$topdir/$topdir\_config.xml",
                   12738:                          "$topdir/$topdir\_controller.swf",
                   12739:                          "$topdir/$topdir\_embed.css",
                   12740:                          "$topdir/$topdir\_First_Frame.png",
                   12741:                          "$topdir/$topdir\_player.html",
                   12742:                          "$topdir/$topdir\_Thumbnails.png",
                   12743:                          "$topdir/playerProductInstall.swf",
                   12744:                          "$topdir/scripts/",
                   12745:                          "$topdir/scripts/config_xml.js",
                   12746:                          "$topdir/scripts/handlebars.js",
                   12747:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   12748:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   12749:                          "$topdir/scripts/modernizr.js",
                   12750:                          "$topdir/scripts/player-min.js",
                   12751:                          "$topdir/scripts/swfobject.js",
                   12752:                          "$topdir/skins/",
                   12753:                          "$topdir/skins/configuration_express.xml",
                   12754:                          "$topdir/skins/express_show/",
                   12755:                          "$topdir/skins/express_show/player-min.css",
                   12756:                          "$topdir/skins/express_show/spritesheet.png");
1.1075.2.81  raeburn  12757:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   12758:                          "$topdir/$topdir.mp4",
                   12759:                          "$topdir/$topdir\_config.xml",
                   12760:                          "$topdir/$topdir\_controller.swf",
                   12761:                          "$topdir/$topdir\_embed.css",
                   12762:                          "$topdir/$topdir\_First_Frame.png",
                   12763:                          "$topdir/$topdir\_player.html",
                   12764:                          "$topdir/$topdir\_Thumbnails.png",
                   12765:                          "$topdir/playerProductInstall.swf",
                   12766:                          "$topdir/scripts/",
                   12767:                          "$topdir/scripts/config_xml.js",
                   12768:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   12769:                          "$topdir/skins/",
                   12770:                          "$topdir/skins/configuration_express.xml",
                   12771:                          "$topdir/skins/express_show/",
                   12772:                          "$topdir/skins/express_show/spritesheet.min.css",
                   12773:                          "$topdir/skins/express_show/spritesheet.png",
                   12774:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1075.2.59  raeburn  12775:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  12776:         if (@diffs == 0) {
1.1075.2.59  raeburn  12777:             $is_camtasia = 6;
                   12778:         } else {
1.1075.2.81  raeburn  12779:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1075.2.59  raeburn  12780:             if (@diffs == 0) {
                   12781:                 $is_camtasia = 8;
1.1075.2.81  raeburn  12782:             } else {
                   12783:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   12784:                 if (@diffs == 0) {
                   12785:                     $is_camtasia = 8;
                   12786:                 }
1.1075.2.59  raeburn  12787:             }
1.1067    raeburn  12788:         }
                   12789:     }
                   12790:     my $output;
                   12791:     if ($is_camtasia) {
                   12792:         $output = <<"ENDCAM";
                   12793: <script type="text/javascript" language="Javascript">
                   12794: // <![CDATA[
                   12795: 
                   12796: function camtasiaToggle() {
                   12797:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   12798:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1075.2.59  raeburn  12799:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  12800:                 document.getElementById('camtasia_titles').style.display='block';
                   12801:             } else {
                   12802:                 document.getElementById('camtasia_titles').style.display='none';
                   12803:             }
                   12804:         }
                   12805:     }
                   12806:     return;
                   12807: }
                   12808: 
                   12809: // ]]>
                   12810: </script>
                   12811: <p>$lt{'camt'}</p>
                   12812: ENDCAM
1.1065    raeburn  12813:     } else {
1.1067    raeburn  12814:         $output = '<p>'.$lt{'this'};
                   12815:         if ($info eq '') {
                   12816:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   12817:         } else {
                   12818:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   12819:                        '<div><pre>'.$info.'</pre></div>';
                   12820:         }
1.1065    raeburn  12821:     }
1.1067    raeburn  12822:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  12823:     my $duplicates;
                   12824:     my $num = 0;
                   12825:     if (ref($dirlist) eq 'ARRAY') {
                   12826:         foreach my $item (@{$dirlist}) {
                   12827:             if (ref($item) eq 'ARRAY') {
                   12828:                 if (exists($toplevel{$item->[0]})) {
                   12829:                     $duplicates .= 
                   12830:                         &start_data_table_row().
                   12831:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12832:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   12833:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12834:                         'value="1" />'.&mt('Yes').'</label>'.
                   12835:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   12836:                         '<td>'.$item->[0].'</td>';
                   12837:                     if ($item->[2]) {
                   12838:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   12839:                     } else {
                   12840:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   12841:                     }
                   12842:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   12843:                                    '<td>'.
                   12844:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   12845:                                    '</td>'.
                   12846:                                    &end_data_table_row();
                   12847:                     $num ++;
                   12848:                 }
                   12849:             }
                   12850:         }
                   12851:     }
                   12852:     my $itemcount;
                   12853:     if (@paths > 0) {
                   12854:         $itemcount = scalar(@paths);
                   12855:     } else {
                   12856:         $itemcount = 1;
                   12857:     }
1.1067    raeburn  12858:     if ($is_camtasia) {
                   12859:         $output .= $lt{'auto'}.'<br />'.
                   12860:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1075.2.59  raeburn  12861:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  12862:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   12863:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   12864:                    $lt{'no'}.'</label></span><br />'.
                   12865:                    '<div id="camtasia_titles" style="display:block">'.
                   12866:                    &Apache::lonhtmlcommon::start_pick_box().
                   12867:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   12868:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   12869:                    &Apache::lonhtmlcommon::row_closure().
                   12870:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   12871:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   12872:                    &Apache::lonhtmlcommon::row_closure(1).
                   12873:                    &Apache::lonhtmlcommon::end_pick_box().
                   12874:                    '</div>';
                   12875:     }
1.1065    raeburn  12876:     $output .= 
                   12877:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  12878:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   12879:         "\n";
1.1065    raeburn  12880:     if ($duplicates ne '') {
                   12881:         $output .= '<p><span class="LC_warning">'.
                   12882:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   12883:                    &start_data_table().
                   12884:                    &start_data_table_header_row().
                   12885:                    '<th>'.&mt('Overwrite?').'</th>'.
                   12886:                    '<th>'.&mt('Name').'</th>'.
                   12887:                    '<th>'.&mt('Type').'</th>'.
                   12888:                    '<th>'.&mt('Size').'</th>'.
                   12889:                    '<th>'.&mt('Last modified').'</th>'.
                   12890:                    &end_data_table_header_row().
                   12891:                    $duplicates.
                   12892:                    &end_data_table().
                   12893:                    '</p>';
                   12894:     }
1.1067    raeburn  12895:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  12896:     if (ref($hiddenelements) eq 'HASH') {
                   12897:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   12898:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   12899:         }
                   12900:     }
                   12901:     $output .= <<"END";
1.1067    raeburn  12902: <br />
1.1053    raeburn  12903: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   12904: </form>
                   12905: $noextract
                   12906: END
                   12907:     return $output;
                   12908: }
                   12909: 
1.1065    raeburn  12910: sub decompression_utility {
                   12911:     my ($program) = @_;
                   12912:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   12913:     my $location;
                   12914:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   12915:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   12916:                          '/usr/sbin/') {
                   12917:             if (-x $dir.$program) {
                   12918:                 $location = $dir.$program;
                   12919:                 last;
                   12920:             }
                   12921:         }
                   12922:     }
                   12923:     return $location;
                   12924: }
                   12925: 
                   12926: sub list_archive_contents {
                   12927:     my ($file,$pathsref) = @_;
                   12928:     my (@cmd,$output);
                   12929:     my $needsregexp;
                   12930:     if ($file =~ /\.zip$/) {
                   12931:         @cmd = (&decompression_utility('unzip'),"-l");
                   12932:         $needsregexp = 1;
                   12933:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   12934:              ($file =~ /\.tgz$/)) {
                   12935:         @cmd = (&decompression_utility('tar'),"-ztf");
                   12936:     } elsif ($file =~ /\.tar\.bz2$/) {
                   12937:         @cmd = (&decompression_utility('tar'),"-jtf");
                   12938:     } elsif ($file =~ m|\.tar$|) {
                   12939:         @cmd = (&decompression_utility('tar'),"-tf");
                   12940:     }
                   12941:     if (@cmd) {
                   12942:         undef($!);
                   12943:         undef($@);
                   12944:         if (open(my $fh,"-|", @cmd, $file)) {
                   12945:             while (my $line = <$fh>) {
                   12946:                 $output .= $line;
                   12947:                 chomp($line);
                   12948:                 my $item;
                   12949:                 if ($needsregexp) {
                   12950:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   12951:                 } else {
                   12952:                     $item = $line;
                   12953:                 }
                   12954:                 if ($item ne '') {
                   12955:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   12956:                         push(@{$pathsref},$item);
                   12957:                     } 
                   12958:                 }
                   12959:             }
                   12960:             close($fh);
                   12961:         }
                   12962:     }
                   12963:     return $output;
                   12964: }
                   12965: 
1.1053    raeburn  12966: sub decompress_uploaded_file {
                   12967:     my ($file,$dir) = @_;
                   12968:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   12969:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   12970:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   12971:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   12972:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   12973:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   12974:     my $decompressed = $env{'cgi.decompressed'};
                   12975:     &Apache::lonnet::delenv('cgi.file');
                   12976:     &Apache::lonnet::delenv('cgi.dir');
                   12977:     &Apache::lonnet::delenv('cgi.decompressed');
                   12978:     return ($decompressed,$result);
                   12979: }
                   12980: 
1.1055    raeburn  12981: sub process_decompression {
                   12982:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1075.2.128  raeburn  12983:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   12984:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12985:                &mt('Unexpected file path.').'</p>'."\n";
                   12986:     }
                   12987:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   12988:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12989:                &mt('Unexpected course context.').'</p>'."\n";
                   12990:     }
                   12991:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
                   12992:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12993:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   12994:     }
1.1055    raeburn  12995:     my ($dir,$error,$warning,$output);
1.1075.2.69  raeburn  12996:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1075.2.34  raeburn  12997:         $error = &mt('Filename not a supported archive file type.').
                   12998:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  12999:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   13000:     } else {
                   13001:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   13002:         if ($docuhome eq 'no_host') {
                   13003:             $error = &mt('Could not determine home server for course.');
                   13004:         } else {
                   13005:             my @ids=&Apache::lonnet::current_machine_ids();
                   13006:             my $currdir = "$dir_root/$destination";
                   13007:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   13008:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   13009:                        "$dir_root/$destination";
                   13010:             } else {
                   13011:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   13012:                        "$dir_root/$docudom/$docuname/$destination";
                   13013:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   13014:                     $error = &mt('Archive file not found.');
                   13015:                 }
                   13016:             }
1.1065    raeburn  13017:             my (@to_overwrite,@to_skip);
                   13018:             if ($env{'form.archive_overwrite_total'} > 0) {
                   13019:                 my $total = $env{'form.archive_overwrite_total'};
                   13020:                 for (my $i=0; $i<$total; $i++) {
                   13021:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   13022:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   13023:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   13024:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   13025:                     }
                   13026:                 }
                   13027:             }
                   13028:             my $numskip = scalar(@to_skip);
1.1075.2.128  raeburn  13029:             my $numoverwrite = scalar(@to_overwrite);
                   13030:             if (($numskip) && (!$numoverwrite)) {
1.1065    raeburn  13031:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   13032:             } elsif ($dir eq '') {
1.1055    raeburn  13033:                 $error = &mt('Directory containing archive file unavailable.');
                   13034:             } elsif (!$error) {
1.1065    raeburn  13035:                 my ($decompressed,$display);
1.1075.2.128  raeburn  13036:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  13037:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   13038:                     mkdir("$dir/$tempdir",0755);
1.1075.2.128  raeburn  13039:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   13040:                         ($decompressed,$display) =
                   13041:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   13042:                         foreach my $item (@to_skip) {
                   13043:                             if (($item ne '') && ($item !~ /\.\./)) {
                   13044:                                 if (-f "$dir/$tempdir/$item") {
                   13045:                                     unlink("$dir/$tempdir/$item");
                   13046:                                 } elsif (-d "$dir/$tempdir/$item") {
                   13047:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
                   13048:                                 }
                   13049:                             }
                   13050:                         }
                   13051:                         foreach my $item (@to_overwrite) {
                   13052:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   13053:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   13054:                                     if (-f "$dir/$item") {
                   13055:                                         unlink("$dir/$item");
                   13056:                                     } elsif (-d "$dir/$item") {
                   13057:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
                   13058:                                     }
                   13059:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   13060:                                 }
1.1065    raeburn  13061:                             }
                   13062:                         }
1.1075.2.128  raeburn  13063:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
                   13064:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
                   13065:                         }
1.1065    raeburn  13066:                     }
                   13067:                 } else {
                   13068:                     ($decompressed,$display) = 
                   13069:                         &decompress_uploaded_file($file,$dir);
                   13070:                 }
1.1055    raeburn  13071:                 if ($decompressed eq 'ok') {
1.1065    raeburn  13072:                     $output = '<p class="LC_info">'.
                   13073:                               &mt('Files extracted successfully from archive.').
                   13074:                               '</p>'."\n";
1.1055    raeburn  13075:                     my ($warning,$result,@contents);
                   13076:                     my ($newdirlistref,$newlisterror) =
                   13077:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   13078:                                                  $docuname,1);
                   13079:                     my (%is_dir,%changes,@newitems);
                   13080:                     my $dirptr = 16384;
1.1065    raeburn  13081:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  13082:                         foreach my $dir_line (@{$newdirlistref}) {
                   13083:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1075.2.128  raeburn  13084:                             unless (($item =~ /^\.+$/) || ($item eq $file)) { 
1.1055    raeburn  13085:                                 push(@newitems,$item);
                   13086:                                 if ($dirptr&$testdir) {
                   13087:                                     $is_dir{$item} = 1;
                   13088:                                 }
                   13089:                                 $changes{$item} = 1;
                   13090:                             }
                   13091:                         }
                   13092:                     }
                   13093:                     if (keys(%changes) > 0) {
                   13094:                         foreach my $item (sort(@newitems)) {
                   13095:                             if ($changes{$item}) {
                   13096:                                 push(@contents,$item);
                   13097:                             }
                   13098:                         }
                   13099:                     }
                   13100:                     if (@contents > 0) {
1.1067    raeburn  13101:                         my $wantform;
                   13102:                         unless ($env{'form.autoextract_camtasia'}) {
                   13103:                             $wantform = 1;
                   13104:                         }
1.1056    raeburn  13105:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  13106:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   13107:                                                                 $currdir,\%is_dir,
                   13108:                                                                 \%children,\%parent,
1.1056    raeburn  13109:                                                                 \@contents,\%dirorder,
                   13110:                                                                 \%titles,$wantform);
1.1055    raeburn  13111:                         if ($datatable ne '') {
                   13112:                             $output .= &archive_options_form('decompressed',$datatable,
                   13113:                                                              $count,$hiddenelem);
1.1065    raeburn  13114:                             my $startcount = 6;
1.1055    raeburn  13115:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  13116:                                                            \%titles,\%children);
1.1055    raeburn  13117:                         }
1.1067    raeburn  13118:                         if ($env{'form.autoextract_camtasia'}) {
1.1075.2.59  raeburn  13119:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  13120:                             my %displayed;
                   13121:                             my $total = 1;
                   13122:                             $env{'form.archive_directory'} = [];
                   13123:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   13124:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   13125:                                 $path =~ s{/$}{};
                   13126:                                 my $item;
                   13127:                                 if ($path ne '') {
                   13128:                                     $item = "$path/$titles{$i}";
                   13129:                                 } else {
                   13130:                                     $item = $titles{$i};
                   13131:                                 }
                   13132:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   13133:                                 if ($item eq $contents[0]) {
                   13134:                                     push(@{$env{'form.archive_directory'}},$i);
                   13135:                                     $env{'form.archive_'.$i} = 'display';
                   13136:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   13137:                                     $displayed{'folder'} = $i;
1.1075.2.59  raeburn  13138:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   13139:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067    raeburn  13140:                                     $env{'form.archive_'.$i} = 'display';
                   13141:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   13142:                                     $displayed{'web'} = $i;
                   13143:                                 } else {
1.1075.2.59  raeburn  13144:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   13145:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   13146:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  13147:                                         push(@{$env{'form.archive_directory'}},$i);
                   13148:                                     }
                   13149:                                     $env{'form.archive_'.$i} = 'dependency';
                   13150:                                 }
                   13151:                                 $total ++;
                   13152:                             }
                   13153:                             for (my $i=1; $i<$total; $i++) {
                   13154:                                 next if ($i == $displayed{'web'});
                   13155:                                 next if ($i == $displayed{'folder'});
                   13156:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   13157:                             }
                   13158:                             $env{'form.phase'} = 'decompress_cleanup';
                   13159:                             $env{'form.archivedelete'} = 1;
                   13160:                             $env{'form.archive_count'} = $total-1;
                   13161:                             $output .=
                   13162:                                 &process_extracted_files('coursedocs',$docudom,
                   13163:                                                          $docuname,$destination,
                   13164:                                                          $dir_root,$hiddenelem);
                   13165:                         }
1.1055    raeburn  13166:                     } else {
                   13167:                         $warning = &mt('No new items extracted from archive file.');
                   13168:                     }
                   13169:                 } else {
                   13170:                     $output = $display;
                   13171:                     $error = &mt('An error occurred during extraction from the archive file.');
                   13172:                 }
                   13173:             }
                   13174:         }
                   13175:     }
                   13176:     if ($error) {
                   13177:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   13178:                    $error.'</p>'."\n";
                   13179:     }
                   13180:     if ($warning) {
                   13181:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   13182:     }
                   13183:     return $output;
                   13184: }
                   13185: 
                   13186: sub get_extracted {
1.1056    raeburn  13187:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   13188:         $titles,$wantform) = @_;
1.1055    raeburn  13189:     my $count = 0;
                   13190:     my $depth = 0;
                   13191:     my $datatable;
1.1056    raeburn  13192:     my @hierarchy;
1.1055    raeburn  13193:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  13194:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   13195:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  13196:     foreach my $item (@{$contents}) {
                   13197:         $count ++;
1.1056    raeburn  13198:         @{$dirorder->{$count}} = @hierarchy;
                   13199:         $titles->{$count} = $item;
1.1055    raeburn  13200:         &archive_hierarchy($depth,$count,$parent,$children);
                   13201:         if ($wantform) {
                   13202:             $datatable .= &archive_row($is_dir->{$item},$item,
                   13203:                                        $currdir,$depth,$count);
                   13204:         }
                   13205:         if ($is_dir->{$item}) {
                   13206:             $depth ++;
1.1056    raeburn  13207:             push(@hierarchy,$count);
                   13208:             $parent->{$depth} = $count;
1.1055    raeburn  13209:             $datatable .=
                   13210:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  13211:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   13212:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  13213:             $depth --;
1.1056    raeburn  13214:             pop(@hierarchy);
1.1055    raeburn  13215:         }
                   13216:     }
                   13217:     return ($count,$datatable);
                   13218: }
                   13219: 
                   13220: sub recurse_extracted_archive {
1.1056    raeburn  13221:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   13222:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  13223:     my $result='';
1.1056    raeburn  13224:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   13225:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   13226:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  13227:         return $result;
                   13228:     }
                   13229:     my $dirptr = 16384;
                   13230:     my ($newdirlistref,$newlisterror) =
                   13231:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   13232:     if (ref($newdirlistref) eq 'ARRAY') {
                   13233:         foreach my $dir_line (@{$newdirlistref}) {
                   13234:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   13235:             unless ($item =~ /^\.+$/) {
                   13236:                 $$count ++;
1.1056    raeburn  13237:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   13238:                 $titles->{$$count} = $item;
1.1055    raeburn  13239:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  13240: 
1.1055    raeburn  13241:                 my $is_dir;
                   13242:                 if ($dirptr&$testdir) {
                   13243:                     $is_dir = 1;
                   13244:                 }
                   13245:                 if ($wantform) {
                   13246:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   13247:                 }
                   13248:                 if ($is_dir) {
                   13249:                     $$depth ++;
1.1056    raeburn  13250:                     push(@{$hierarchy},$$count);
                   13251:                     $parent->{$$depth} = $$count;
1.1055    raeburn  13252:                     $result .=
                   13253:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   13254:                                                    $docuname,$depth,$count,
1.1056    raeburn  13255:                                                    $hierarchy,$dirorder,$children,
                   13256:                                                    $parent,$titles,$wantform);
1.1055    raeburn  13257:                     $$depth --;
1.1056    raeburn  13258:                     pop(@{$hierarchy});
1.1055    raeburn  13259:                 }
                   13260:             }
                   13261:         }
                   13262:     }
                   13263:     return $result;
                   13264: }
                   13265: 
                   13266: sub archive_hierarchy {
                   13267:     my ($depth,$count,$parent,$children) =@_;
                   13268:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   13269:         if (exists($parent->{$depth})) {
                   13270:              $children->{$parent->{$depth}} .= $count.':';
                   13271:         }
                   13272:     }
                   13273:     return;
                   13274: }
                   13275: 
                   13276: sub archive_row {
                   13277:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   13278:     my ($name) = ($item =~ m{([^/]+)$});
                   13279:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  13280:                                        'display'    => 'Add as file',
1.1055    raeburn  13281:                                        'dependency' => 'Include as dependency',
                   13282:                                        'discard'    => 'Discard',
                   13283:                                       );
                   13284:     if ($is_dir) {
1.1059    raeburn  13285:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  13286:     }
1.1056    raeburn  13287:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   13288:     my $offset = 0;
1.1055    raeburn  13289:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  13290:         $offset ++;
1.1065    raeburn  13291:         if ($action ne 'display') {
                   13292:             $offset ++;
                   13293:         }  
1.1055    raeburn  13294:         $output .= '<td><span class="LC_nobreak">'.
                   13295:                    '<label><input type="radio" name="archive_'.$count.
                   13296:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   13297:         my $text = $choices{$action};
                   13298:         if ($is_dir) {
                   13299:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   13300:             if ($action eq 'display') {
1.1059    raeburn  13301:                 $text = &mt('Add as folder');
1.1055    raeburn  13302:             }
1.1056    raeburn  13303:         } else {
                   13304:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   13305: 
                   13306:         }
                   13307:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   13308:         if ($action eq 'dependency') {
                   13309:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   13310:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   13311:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   13312:                        '<option value=""></option>'."\n".
                   13313:                        '</select>'."\n".
                   13314:                        '</div>';
1.1059    raeburn  13315:         } elsif ($action eq 'display') {
                   13316:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   13317:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   13318:                        '</div>';
1.1055    raeburn  13319:         }
1.1056    raeburn  13320:         $output .= '</td>';
1.1055    raeburn  13321:     }
                   13322:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   13323:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   13324:     for (my $i=0; $i<$depth; $i++) {
                   13325:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   13326:     }
                   13327:     if ($is_dir) {
                   13328:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   13329:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   13330:     } else {
                   13331:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   13332:     }
                   13333:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   13334:                &end_data_table_row();
                   13335:     return $output;
                   13336: }
                   13337: 
                   13338: sub archive_options_form {
1.1065    raeburn  13339:     my ($form,$display,$count,$hiddenelem) = @_;
                   13340:     my %lt = &Apache::lonlocal::texthash(
                   13341:                perm => 'Permanently remove archive file?',
                   13342:                hows => 'How should each extracted item be incorporated in the course?',
                   13343:                cont => 'Content actions for all',
                   13344:                addf => 'Add as folder/file',
                   13345:                incd => 'Include as dependency for a displayed file',
                   13346:                disc => 'Discard',
                   13347:                no   => 'No',
                   13348:                yes  => 'Yes',
                   13349:                save => 'Save',
                   13350:     );
                   13351:     my $output = <<"END";
                   13352: <form name="$form" method="post" action="">
                   13353: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   13354: <label>
                   13355:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   13356: </label>
                   13357: &nbsp;
                   13358: <label>
                   13359:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   13360: </span>
                   13361: </p>
                   13362: <input type="hidden" name="phase" value="decompress_cleanup" />
                   13363: <br />$lt{'hows'}
                   13364: <div class="LC_columnSection">
                   13365:   <fieldset>
                   13366:     <legend>$lt{'cont'}</legend>
                   13367:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   13368:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   13369:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   13370:   </fieldset>
                   13371: </div>
                   13372: END
                   13373:     return $output.
1.1055    raeburn  13374:            &start_data_table()."\n".
1.1065    raeburn  13375:            $display."\n".
1.1055    raeburn  13376:            &end_data_table()."\n".
                   13377:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   13378:            $hiddenelem.
1.1065    raeburn  13379:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  13380:            '</form>';
                   13381: }
                   13382: 
                   13383: sub archive_javascript {
1.1056    raeburn  13384:     my ($startcount,$numitems,$titles,$children) = @_;
                   13385:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  13386:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  13387:     my $scripttag = <<START;
                   13388: <script type="text/javascript">
                   13389: // <![CDATA[
                   13390: 
                   13391: function checkAll(form,prefix) {
                   13392:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   13393:     for (var i=0; i < form.elements.length; i++) {
                   13394:         var id = form.elements[i].id;
                   13395:         if ((id != '') && (id != undefined)) {
                   13396:             if (idstr.test(id)) {
                   13397:                 if (form.elements[i].type == 'radio') {
                   13398:                     form.elements[i].checked = true;
1.1056    raeburn  13399:                     var nostart = i-$startcount;
1.1059    raeburn  13400:                     var offset = nostart%7;
                   13401:                     var count = (nostart-offset)/7;    
1.1056    raeburn  13402:                     dependencyCheck(form,count,offset);
1.1055    raeburn  13403:                 }
                   13404:             }
                   13405:         }
                   13406:     }
                   13407: }
                   13408: 
                   13409: function propagateCheck(form,count) {
                   13410:     if (count > 0) {
1.1059    raeburn  13411:         var startelement = $startcount + ((count-1) * 7);
                   13412:         for (var j=1; j<6; j++) {
                   13413:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  13414:                 var item = startelement + j; 
                   13415:                 if (form.elements[item].type == 'radio') {
                   13416:                     if (form.elements[item].checked) {
                   13417:                         containerCheck(form,count,j);
                   13418:                         break;
                   13419:                     }
1.1055    raeburn  13420:                 }
                   13421:             }
                   13422:         }
                   13423:     }
                   13424: }
                   13425: 
                   13426: numitems = $numitems
1.1056    raeburn  13427: var titles = new Array(numitems);
                   13428: var parents = new Array(numitems);
1.1055    raeburn  13429: for (var i=0; i<numitems; i++) {
1.1056    raeburn  13430:     parents[i] = new Array;
1.1055    raeburn  13431: }
1.1059    raeburn  13432: var maintitle = '$maintitle';
1.1055    raeburn  13433: 
                   13434: START
                   13435: 
1.1056    raeburn  13436:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   13437:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  13438:         for (my $i=0; $i<@contents; $i ++) {
                   13439:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   13440:         }
                   13441:     }
                   13442: 
1.1056    raeburn  13443:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   13444:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   13445:     }
                   13446: 
1.1055    raeburn  13447:     $scripttag .= <<END;
                   13448: 
                   13449: function containerCheck(form,count,offset) {
                   13450:     if (count > 0) {
1.1056    raeburn  13451:         dependencyCheck(form,count,offset);
1.1059    raeburn  13452:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  13453:         form.elements[item].checked = true;
                   13454:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   13455:             if (parents[count].length > 0) {
                   13456:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  13457:                     containerCheck(form,parents[count][j],offset);
                   13458:                 }
                   13459:             }
                   13460:         }
                   13461:     }
                   13462: }
                   13463: 
                   13464: function dependencyCheck(form,count,offset) {
                   13465:     if (count > 0) {
1.1059    raeburn  13466:         var chosen = (offset+$startcount)+7*(count-1);
                   13467:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  13468:         var currtype = form.elements[depitem].type;
                   13469:         if (form.elements[chosen].value == 'dependency') {
                   13470:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   13471:             form.elements[depitem].options.length = 0;
                   13472:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11  raeburn  13473:             for (var i=1; i<=numitems; i++) {
                   13474:                 if (i == count) {
                   13475:                     continue;
                   13476:                 }
1.1059    raeburn  13477:                 var startelement = $startcount + (i-1) * 7;
                   13478:                 for (var j=1; j<6; j++) {
                   13479:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  13480:                         var item = startelement + j;
                   13481:                         if (form.elements[item].type == 'radio') {
                   13482:                             if (form.elements[item].checked) {
                   13483:                                 if (form.elements[item].value == 'display') {
                   13484:                                     var n = form.elements[depitem].options.length;
                   13485:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   13486:                                 }
                   13487:                             }
                   13488:                         }
                   13489:                     }
                   13490:                 }
                   13491:             }
                   13492:         } else {
                   13493:             document.getElementById('arc_depon_'+count).style.display='none';
                   13494:             form.elements[depitem].options.length = 0;
                   13495:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   13496:         }
1.1059    raeburn  13497:         titleCheck(form,count,offset);
1.1056    raeburn  13498:     }
                   13499: }
                   13500: 
                   13501: function propagateSelect(form,count,offset) {
                   13502:     if (count > 0) {
1.1065    raeburn  13503:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  13504:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   13505:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   13506:             if (parents[count].length > 0) {
                   13507:                 for (var j=0; j<parents[count].length; j++) {
                   13508:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  13509:                 }
                   13510:             }
                   13511:         }
                   13512:     }
                   13513: }
1.1056    raeburn  13514: 
                   13515: function containerSelect(form,count,offset,picked) {
                   13516:     if (count > 0) {
1.1065    raeburn  13517:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  13518:         if (form.elements[item].type == 'radio') {
                   13519:             if (form.elements[item].value == 'dependency') {
                   13520:                 if (form.elements[item+1].type == 'select-one') {
                   13521:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   13522:                         if (form.elements[item+1].options[i].value == picked) {
                   13523:                             form.elements[item+1].selectedIndex = i;
                   13524:                             break;
                   13525:                         }
                   13526:                     }
                   13527:                 }
                   13528:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   13529:                     if (parents[count].length > 0) {
                   13530:                         for (var j=0; j<parents[count].length; j++) {
                   13531:                             containerSelect(form,parents[count][j],offset,picked);
                   13532:                         }
                   13533:                     }
                   13534:                 }
                   13535:             }
                   13536:         }
                   13537:     }
                   13538: }
                   13539: 
1.1059    raeburn  13540: function titleCheck(form,count,offset) {
                   13541:     if (count > 0) {
                   13542:         var chosen = (offset+$startcount)+7*(count-1);
                   13543:         var depitem = $startcount + ((count-1) * 7) + 2;
                   13544:         var currtype = form.elements[depitem].type;
                   13545:         if (form.elements[chosen].value == 'display') {
                   13546:             document.getElementById('arc_title_'+count).style.display='block';
                   13547:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   13548:                 document.getElementById('archive_title_'+count).value=maintitle;
                   13549:             }
                   13550:         } else {
                   13551:             document.getElementById('arc_title_'+count).style.display='none';
                   13552:             if (currtype == 'text') { 
                   13553:                 document.getElementById('archive_title_'+count).value='';
                   13554:             }
                   13555:         }
                   13556:     }
                   13557:     return;
                   13558: }
                   13559: 
1.1055    raeburn  13560: // ]]>
                   13561: </script>
                   13562: END
                   13563:     return $scripttag;
                   13564: }
                   13565: 
                   13566: sub process_extracted_files {
1.1067    raeburn  13567:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  13568:     my $numitems = $env{'form.archive_count'};
1.1075.2.128  raeburn  13569:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  13570:     my @ids=&Apache::lonnet::current_machine_ids();
                   13571:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  13572:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  13573:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   13574:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   13575:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   13576:         $pathtocheck = "$dir_root/$destination";
                   13577:         $dir = $dir_root;
                   13578:         $ishome = 1;
                   13579:     } else {
                   13580:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   13581:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1075.2.128  raeburn  13582:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  13583:     }
                   13584:     my $currdir = "$dir_root/$destination";
                   13585:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   13586:     if ($env{'form.folderpath'}) {
                   13587:         my @items = split('&',$env{'form.folderpath'});
                   13588:         $folders{'0'} = $items[-2];
1.1075.2.17  raeburn  13589:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   13590:             $containers{'0'}='page';
                   13591:         } else {
                   13592:             $containers{'0'}='sequence';
                   13593:         }
1.1055    raeburn  13594:     }
                   13595:     my @archdirs = &get_env_multiple('form.archive_directory');
                   13596:     if ($numitems) {
                   13597:         for (my $i=1; $i<=$numitems; $i++) {
                   13598:             my $path = $env{'form.archive_content_'.$i};
                   13599:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   13600:                 my $item = $1;
                   13601:                 $toplevelitems{$item} = $i;
                   13602:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   13603:                     $is_dir{$item} = 1;
                   13604:                 }
                   13605:             }
                   13606:         }
                   13607:     }
1.1067    raeburn  13608:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  13609:     if (keys(%toplevelitems) > 0) {
                   13610:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  13611:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   13612:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  13613:     }
1.1066    raeburn  13614:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  13615:     if ($numitems) {
                   13616:         for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11  raeburn  13617:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  13618:             my $path = $env{'form.archive_content_'.$i};
                   13619:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13620:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   13621:                     if ($prefix ne '' && $path ne '') {
                   13622:                         if (-e $prefix.$path) {
1.1066    raeburn  13623:                             if ((@archdirs > 0) && 
                   13624:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   13625:                                 $todeletedir{$prefix.$path} = 1;
                   13626:                             } else {
                   13627:                                 $todelete{$prefix.$path} = 1;
                   13628:                             }
1.1055    raeburn  13629:                         }
                   13630:                     }
                   13631:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  13632:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  13633:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  13634:                     $docstitle = $env{'form.archive_title_'.$i};
                   13635:                     if ($docstitle eq '') {
                   13636:                         $docstitle = $title;
                   13637:                     }
1.1055    raeburn  13638:                     $outer = 0;
1.1056    raeburn  13639:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13640:                         if (@{$dirorder{$i}} > 0) {
                   13641:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  13642:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   13643:                                     $outer = $item;
                   13644:                                     last;
                   13645:                                 }
                   13646:                             }
                   13647:                         }
                   13648:                     }
                   13649:                     my ($errtext,$fatal) = 
                   13650:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   13651:                                                '/'.$folders{$outer}.'.'.
                   13652:                                                $containers{$outer});
                   13653:                     next if ($fatal);
                   13654:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   13655:                         if ($context eq 'coursedocs') {
1.1056    raeburn  13656:                             $mapinner{$i} = time;
1.1055    raeburn  13657:                             $folders{$i} = 'default_'.$mapinner{$i};
                   13658:                             $containers{$i} = 'sequence';
                   13659:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   13660:                                       $folders{$i}.'.'.$containers{$i};
                   13661:                             my $newidx = &LONCAPA::map::getresidx();
                   13662:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  13663:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  13664:                             push(@LONCAPA::map::order,$newidx);
                   13665:                             my ($outtext,$errtext) =
                   13666:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13667:                                                         $docuname.'/'.$folders{$outer}.
1.1075.2.11  raeburn  13668:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  13669:                             $newseqid{$i} = $newidx;
1.1067    raeburn  13670:                             unless ($errtext) {
1.1075.2.128  raeburn  13671:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   13672:                                                        &HTML::Entities::encode($docstitle,'<>&"'))..
                   13673:                                             '</li>'."\n";
1.1067    raeburn  13674:                             }
1.1055    raeburn  13675:                         }
                   13676:                     } else {
                   13677:                         if ($context eq 'coursedocs') {
                   13678:                             my $newidx=&LONCAPA::map::getresidx();
                   13679:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   13680:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   13681:                                       $title;
1.1075.2.128  raeburn  13682:                             if (($outer !~ /\D/) && ($mapinner{$outer} !~ /\D/) && ($newidx !~ /\D/)) {
                   13683:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   13684:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
1.1067    raeburn  13685:                                 }
1.1075.2.128  raeburn  13686:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13687:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   13688:                                 }
                   13689:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13690:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   13691:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   13692:                                         unless ($ishome) {
                   13693:                                             my $fetch = "$newdest{$i}/$title";
                   13694:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   13695:                                             $prompttofetch{$fetch} = 1;
                   13696:                                         }
                   13697:                                    }
                   13698:                                 }
                   13699:                                 $LONCAPA::map::resources[$newidx]=
                   13700:                                     $docstitle.':'.$url.':false:normal:res';
                   13701:                                 push(@LONCAPA::map::order, $newidx);
                   13702:                                 my ($outtext,$errtext)=
                   13703:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13704:                                                             $docuname.'/'.$folders{$outer}.
                   13705:                                                             '.'.$containers{$outer},1,1);
                   13706:                                 unless ($errtext) {
                   13707:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   13708:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   13709:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   13710:                                                    '</li>'."\n";
                   13711:                                     }
1.1067    raeburn  13712:                                 }
1.1075.2.128  raeburn  13713:                             } else {
                   13714:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13715:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1067    raeburn  13716:                             }
1.1055    raeburn  13717:                         }
                   13718:                     }
1.1075.2.11  raeburn  13719:                 }
                   13720:             } else {
1.1075.2.128  raeburn  13721:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13722:                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1075.2.11  raeburn  13723:             }
                   13724:         }
                   13725:         for (my $i=1; $i<=$numitems; $i++) {
                   13726:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   13727:             my $path = $env{'form.archive_content_'.$i};
                   13728:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13729:                 my ($title) = ($path =~ m{/([^/]+)$});
                   13730:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   13731:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   13732:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13733:                         my ($itemidx,$fullpath,$relpath);
                   13734:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   13735:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  13736:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11  raeburn  13737:                                 if ($dirorder{$i}->[$j] eq $container) {
                   13738:                                     $itemidx = $j;
1.1056    raeburn  13739:                                 }
                   13740:                             }
1.1075.2.11  raeburn  13741:                         }
                   13742:                         if ($itemidx eq '') {
                   13743:                             $itemidx =  0;
                   13744:                         }
                   13745:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   13746:                             if ($mapinner{$referrer{$i}}) {
                   13747:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   13748:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13749:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13750:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13751:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13752:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13753:                                             if (!-e $fullpath) {
                   13754:                                                 mkdir($fullpath,0755);
1.1056    raeburn  13755:                                             }
                   13756:                                         }
1.1075.2.11  raeburn  13757:                                     } else {
                   13758:                                         last;
1.1056    raeburn  13759:                                     }
1.1075.2.11  raeburn  13760:                                 }
                   13761:                             }
                   13762:                         } elsif ($newdest{$referrer{$i}}) {
                   13763:                             $fullpath = $newdest{$referrer{$i}};
                   13764:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13765:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   13766:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   13767:                                     last;
                   13768:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13769:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13770:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13771:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13772:                                         if (!-e $fullpath) {
                   13773:                                             mkdir($fullpath,0755);
1.1056    raeburn  13774:                                         }
                   13775:                                     }
1.1075.2.11  raeburn  13776:                                 } else {
                   13777:                                     last;
1.1056    raeburn  13778:                                 }
1.1075.2.11  raeburn  13779:                             }
                   13780:                         }
                   13781:                         if ($fullpath ne '') {
                   13782:                             if (-e "$prefix$path") {
1.1075.2.128  raeburn  13783:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   13784:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   13785:                                 }
1.1075.2.11  raeburn  13786:                             }
                   13787:                             if (-e "$fullpath/$title") {
                   13788:                                 my $showpath;
                   13789:                                 if ($relpath ne '') {
                   13790:                                     $showpath = "$relpath/$title";
                   13791:                                 } else {
                   13792:                                     $showpath = "/$title";
1.1056    raeburn  13793:                                 }
1.1075.2.128  raeburn  13794:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   13795:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   13796:                                            '</li>'."\n";
                   13797:                                 unless ($ishome) {
                   13798:                                     my $fetch = "$fullpath/$title";
                   13799:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   13800:                                     $prompttofetch{$fetch} = 1;
                   13801:                                 }
1.1055    raeburn  13802:                             }
                   13803:                         }
                   13804:                     }
1.1075.2.11  raeburn  13805:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   13806:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1075.2.128  raeburn  13807:                                     &HTML::Entities::encode($path,'<>&"'),
                   13808:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   13809:                                 '<br />';
1.1055    raeburn  13810:                 }
                   13811:             } else {
1.1075.2.128  raeburn  13812:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13813:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  13814:             }
                   13815:         }
                   13816:         if (keys(%todelete)) {
                   13817:             foreach my $key (keys(%todelete)) {
                   13818:                 unlink($key);
1.1066    raeburn  13819:             }
                   13820:         }
                   13821:         if (keys(%todeletedir)) {
                   13822:             foreach my $key (keys(%todeletedir)) {
                   13823:                 rmdir($key);
                   13824:             }
                   13825:         }
                   13826:         foreach my $dir (sort(keys(%is_dir))) {
                   13827:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   13828:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  13829:             }
                   13830:         }
1.1067    raeburn  13831:         if ($result ne '') {
                   13832:             $output .= '<ul>'."\n".
                   13833:                        $result."\n".
                   13834:                        '</ul>';
                   13835:         }
                   13836:         unless ($ishome) {
                   13837:             my $replicationfail;
                   13838:             foreach my $item (keys(%prompttofetch)) {
                   13839:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   13840:                 unless ($fetchresult eq 'ok') {
                   13841:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   13842:                 }
                   13843:             }
                   13844:             if ($replicationfail) {
                   13845:                 $output .= '<p class="LC_error">'.
                   13846:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   13847:                            $replicationfail.
                   13848:                            '</ul></p>';
                   13849:             }
                   13850:         }
1.1055    raeburn  13851:     } else {
                   13852:         $warning = &mt('No items found in archive.');
                   13853:     }
                   13854:     if ($error) {
                   13855:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   13856:                    $error.'</p>'."\n";
                   13857:     }
                   13858:     if ($warning) {
                   13859:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   13860:     }
                   13861:     return $output;
                   13862: }
                   13863: 
1.1066    raeburn  13864: sub cleanup_empty_dirs {
                   13865:     my ($path) = @_;
                   13866:     if (($path ne '') && (-d $path)) {
                   13867:         if (opendir(my $dirh,$path)) {
                   13868:             my @dircontents = grep(!/^\./,readdir($dirh));
                   13869:             my $numitems = 0;
                   13870:             foreach my $item (@dircontents) {
                   13871:                 if (-d "$path/$item") {
1.1075.2.28  raeburn  13872:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  13873:                     if (-e "$path/$item") {
                   13874:                         $numitems ++;
                   13875:                     }
                   13876:                 } else {
                   13877:                     $numitems ++;
                   13878:                 }
                   13879:             }
                   13880:             if ($numitems == 0) {
                   13881:                 rmdir($path);
                   13882:             }
                   13883:             closedir($dirh);
                   13884:         }
                   13885:     }
                   13886:     return;
                   13887: }
                   13888: 
1.41      ng       13889: =pod
1.45      matthew  13890: 
1.1075.2.56  raeburn  13891: =item * &get_folder_hierarchy()
1.1068    raeburn  13892: 
                   13893: Provides hierarchy of names of folders/sub-folders containing the current
                   13894: item,
                   13895: 
                   13896: Inputs: 3
                   13897:      - $navmap - navmaps object
                   13898: 
                   13899:      - $map - url for map (either the trigger itself, or map containing
                   13900:                            the resource, which is the trigger).
                   13901: 
                   13902:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   13903: 
                   13904: Outputs: 1 @pathitems - array of folder/subfolder names.
                   13905: 
                   13906: =cut
                   13907: 
                   13908: sub get_folder_hierarchy {
                   13909:     my ($navmap,$map,$showitem) = @_;
                   13910:     my @pathitems;
                   13911:     if (ref($navmap)) {
                   13912:         my $mapres = $navmap->getResourceByUrl($map);
                   13913:         if (ref($mapres)) {
                   13914:             my $pcslist = $mapres->map_hierarchy();
                   13915:             if ($pcslist ne '') {
                   13916:                 my @pcs = split(/,/,$pcslist);
                   13917:                 foreach my $pc (@pcs) {
                   13918:                     if ($pc == 1) {
1.1075.2.38  raeburn  13919:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  13920:                     } else {
                   13921:                         my $res = $navmap->getByMapPc($pc);
                   13922:                         if (ref($res)) {
                   13923:                             my $title = $res->compTitle();
                   13924:                             $title =~ s/\W+/_/g;
                   13925:                             if ($title ne '') {
                   13926:                                 push(@pathitems,$title);
                   13927:                             }
                   13928:                         }
                   13929:                     }
                   13930:                 }
                   13931:             }
1.1071    raeburn  13932:             if ($showitem) {
                   13933:                 if ($mapres->{ID} eq '0.0') {
1.1075.2.38  raeburn  13934:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  13935:                 } else {
                   13936:                     my $maptitle = $mapres->compTitle();
                   13937:                     $maptitle =~ s/\W+/_/g;
                   13938:                     if ($maptitle ne '') {
                   13939:                         push(@pathitems,$maptitle);
                   13940:                     }
1.1068    raeburn  13941:                 }
                   13942:             }
                   13943:         }
                   13944:     }
                   13945:     return @pathitems;
                   13946: }
                   13947: 
                   13948: =pod
                   13949: 
1.1015    raeburn  13950: =item * &get_turnedin_filepath()
                   13951: 
                   13952: Determines path in a user's portfolio file for storage of files uploaded
                   13953: to a specific essayresponse or dropbox item.
                   13954: 
                   13955: Inputs: 3 required + 1 optional.
                   13956: $symb is symb for resource, $uname and $udom are for current user (required).
                   13957: $caller is optional (can be "submission", if routine is called when storing
                   13958: an upoaded file when "Submit Answer" button was pressed).
                   13959: 
                   13960: Returns array containing $path and $multiresp. 
                   13961: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   13962: than one file upload item.  Callers of routine should append partid as a 
                   13963: subdirectory to $path in cases where $multiresp is 1.
                   13964: 
                   13965: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   13966: 
                   13967: =cut
                   13968: 
                   13969: sub get_turnedin_filepath {
                   13970:     my ($symb,$uname,$udom,$caller) = @_;
                   13971:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   13972:     my $turnindir;
                   13973:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   13974:     $turnindir = $userhash{'turnindir'};
                   13975:     my ($path,$multiresp);
                   13976:     if ($turnindir eq '') {
                   13977:         if ($caller eq 'submission') {
                   13978:             $turnindir = &mt('turned in');
                   13979:             $turnindir =~ s/\W+/_/g;
                   13980:             my %newhash = (
                   13981:                             'turnindir' => $turnindir,
                   13982:                           );
                   13983:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   13984:         }
                   13985:     }
                   13986:     if ($turnindir ne '') {
                   13987:         $path = '/'.$turnindir.'/';
                   13988:         my ($multipart,$turnin,@pathitems);
                   13989:         my $navmap = Apache::lonnavmaps::navmap->new();
                   13990:         if (defined($navmap)) {
                   13991:             my $mapres = $navmap->getResourceByUrl($map);
                   13992:             if (ref($mapres)) {
                   13993:                 my $pcslist = $mapres->map_hierarchy();
                   13994:                 if ($pcslist ne '') {
                   13995:                     foreach my $pc (split(/,/,$pcslist)) {
                   13996:                         my $res = $navmap->getByMapPc($pc);
                   13997:                         if (ref($res)) {
                   13998:                             my $title = $res->compTitle();
                   13999:                             $title =~ s/\W+/_/g;
                   14000:                             if ($title ne '') {
1.1075.2.48  raeburn  14001:                                 if (($pc > 1) && (length($title) > 12)) {
                   14002:                                     $title = substr($title,0,12);
                   14003:                                 }
1.1015    raeburn  14004:                                 push(@pathitems,$title);
                   14005:                             }
                   14006:                         }
                   14007:                     }
                   14008:                 }
                   14009:                 my $maptitle = $mapres->compTitle();
                   14010:                 $maptitle =~ s/\W+/_/g;
                   14011:                 if ($maptitle ne '') {
1.1075.2.48  raeburn  14012:                     if (length($maptitle) > 12) {
                   14013:                         $maptitle = substr($maptitle,0,12);
                   14014:                     }
1.1015    raeburn  14015:                     push(@pathitems,$maptitle);
                   14016:                 }
                   14017:                 unless ($env{'request.state'} eq 'construct') {
                   14018:                     my $res = $navmap->getBySymb($symb);
                   14019:                     if (ref($res)) {
                   14020:                         my $partlist = $res->parts();
                   14021:                         my $totaluploads = 0;
                   14022:                         if (ref($partlist) eq 'ARRAY') {
                   14023:                             foreach my $part (@{$partlist}) {
                   14024:                                 my @types = $res->responseType($part);
                   14025:                                 my @ids = $res->responseIds($part);
                   14026:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   14027:                                     if ($types[$i] eq 'essay') {
                   14028:                                         my $partid = $part.'_'.$ids[$i];
                   14029:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   14030:                                             $totaluploads ++;
                   14031:                                         }
                   14032:                                     }
                   14033:                                 }
                   14034:                             }
                   14035:                             if ($totaluploads > 1) {
                   14036:                                 $multiresp = 1;
                   14037:                             }
                   14038:                         }
                   14039:                     }
                   14040:                 }
                   14041:             } else {
                   14042:                 return;
                   14043:             }
                   14044:         } else {
                   14045:             return;
                   14046:         }
                   14047:         my $restitle=&Apache::lonnet::gettitle($symb);
                   14048:         $restitle =~ s/\W+/_/g;
                   14049:         if ($restitle eq '') {
                   14050:             $restitle = ($resurl =~ m{/[^/]+$});
                   14051:             if ($restitle eq '') {
                   14052:                 $restitle = time;
                   14053:             }
                   14054:         }
1.1075.2.48  raeburn  14055:         if (length($restitle) > 12) {
                   14056:             $restitle = substr($restitle,0,12);
                   14057:         }
1.1015    raeburn  14058:         push(@pathitems,$restitle);
                   14059:         $path .= join('/',@pathitems);
                   14060:     }
                   14061:     return ($path,$multiresp);
                   14062: }
                   14063: 
                   14064: =pod
                   14065: 
1.464     albertel 14066: =back
1.41      ng       14067: 
1.112     bowersj2 14068: =head1 CSV Upload/Handling functions
1.38      albertel 14069: 
1.41      ng       14070: =over 4
                   14071: 
1.648     raeburn  14072: =item * &upfile_store($r)
1.41      ng       14073: 
                   14074: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 14075: needs $env{'form.upfile'}
1.41      ng       14076: returns $datatoken to be put into hidden field
                   14077: 
                   14078: =cut
1.31      albertel 14079: 
                   14080: sub upfile_store {
                   14081:     my $r=shift;
1.258     albertel 14082:     $env{'form.upfile'}=~s/\r/\n/gs;
                   14083:     $env{'form.upfile'}=~s/\f/\n/gs;
                   14084:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   14085:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 14086: 
1.1075.2.128  raeburn  14087:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   14088:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   14089:                                      time.'_'.$$);
                   14090:     return if ($datatoken eq '');
                   14091: 
1.31      albertel 14092:     {
1.158     raeburn  14093:         my $datafile = $r->dir_config('lonDaemons').
                   14094:                            '/tmp/'.$datatoken.'.tmp';
1.1075.2.128  raeburn  14095:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 14096:             print $fh $env{'form.upfile'};
1.158     raeburn  14097:             close($fh);
                   14098:         }
1.31      albertel 14099:     }
                   14100:     return $datatoken;
                   14101: }
                   14102: 
1.56      matthew  14103: =pod
                   14104: 
1.1075.2.128  raeburn  14105: =item * &load_tmp_file($r,$datatoken)
1.41      ng       14106: 
                   14107: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1075.2.128  raeburn  14108: $datatoken is the name to assign to the temporary file.
1.258     albertel 14109: sets $env{'form.upfile'} to the contents of the file
1.41      ng       14110: 
                   14111: =cut
1.31      albertel 14112: 
                   14113: sub load_tmp_file {
1.1075.2.128  raeburn  14114:     my ($r,$datatoken) = @_;
                   14115:     return if ($datatoken eq '');
1.31      albertel 14116:     my @studentdata=();
                   14117:     {
1.158     raeburn  14118:         my $studentfile = $r->dir_config('lonDaemons').
1.1075.2.128  raeburn  14119:                               '/tmp/'.$datatoken.'.tmp';
                   14120:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  14121:             @studentdata=<$fh>;
                   14122:             close($fh);
                   14123:         }
1.31      albertel 14124:     }
1.258     albertel 14125:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 14126: }
                   14127: 
1.1075.2.128  raeburn  14128: sub valid_datatoken {
                   14129:     my ($datatoken) = @_;
1.1075.2.131  raeburn  14130:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1075.2.128  raeburn  14131:         return $datatoken;
                   14132:     }
                   14133:     return;
                   14134: }
                   14135: 
1.56      matthew  14136: =pod
                   14137: 
1.648     raeburn  14138: =item * &upfile_record_sep()
1.41      ng       14139: 
                   14140: Separate uploaded file into records
                   14141: returns array of records,
1.258     albertel 14142: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       14143: 
                   14144: =cut
1.31      albertel 14145: 
                   14146: sub upfile_record_sep {
1.258     albertel 14147:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 14148:     } else {
1.248     albertel 14149: 	my @records;
1.258     albertel 14150: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 14151: 	    if ($line=~/^\s*$/) { next; }
                   14152: 	    push(@records,$line);
                   14153: 	}
                   14154: 	return @records;
1.31      albertel 14155:     }
                   14156: }
                   14157: 
1.56      matthew  14158: =pod
                   14159: 
1.648     raeburn  14160: =item * &record_sep($record)
1.41      ng       14161: 
1.258     albertel 14162: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       14163: 
                   14164: =cut
                   14165: 
1.263     www      14166: sub takeleft {
                   14167:     my $index=shift;
                   14168:     return substr('0000'.$index,-4,4);
                   14169: }
                   14170: 
1.31      albertel 14171: sub record_sep {
                   14172:     my $record=shift;
                   14173:     my %components=();
1.258     albertel 14174:     if ($env{'form.upfiletype'} eq 'xml') {
                   14175:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 14176:         my $i=0;
1.356     albertel 14177:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 14178:             $field=~s/^(\"|\')//;
                   14179:             $field=~s/(\"|\')$//;
1.263     www      14180:             $components{&takeleft($i)}=$field;
1.31      albertel 14181:             $i++;
                   14182:         }
1.258     albertel 14183:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 14184:         my $i=0;
1.356     albertel 14185:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 14186:             $field=~s/^(\"|\')//;
                   14187:             $field=~s/(\"|\')$//;
1.263     www      14188:             $components{&takeleft($i)}=$field;
1.31      albertel 14189:             $i++;
                   14190:         }
                   14191:     } else {
1.561     www      14192:         my $separator=',';
1.480     banghart 14193:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      14194:             $separator=';';
1.480     banghart 14195:         }
1.31      albertel 14196:         my $i=0;
1.561     www      14197: # the character we are looking for to indicate the end of a quote or a record 
                   14198:         my $looking_for=$separator;
                   14199: # do not add the characters to the fields
                   14200:         my $ignore=0;
                   14201: # we just encountered a separator (or the beginning of the record)
                   14202:         my $just_found_separator=1;
                   14203: # store the field we are working on here
                   14204:         my $field='';
                   14205: # work our way through all characters in record
                   14206:         foreach my $character ($record=~/(.)/g) {
                   14207:             if ($character eq $looking_for) {
                   14208:                if ($character ne $separator) {
                   14209: # Found the end of a quote, again looking for separator
                   14210:                   $looking_for=$separator;
                   14211:                   $ignore=1;
                   14212:                } else {
                   14213: # Found a separator, store away what we got
                   14214:                   $components{&takeleft($i)}=$field;
                   14215: 	          $i++;
                   14216:                   $just_found_separator=1;
                   14217:                   $ignore=0;
                   14218:                   $field='';
                   14219:                }
                   14220:                next;
                   14221:             }
                   14222: # single or double quotation marks after a separator indicate beginning of a quote
                   14223: # we are now looking for the end of the quote and need to ignore separators
                   14224:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   14225:                $looking_for=$character;
                   14226:                next;
                   14227:             }
                   14228: # ignore would be true after we reached the end of a quote
                   14229:             if ($ignore) { next; }
                   14230:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   14231:             $field.=$character;
                   14232:             $just_found_separator=0; 
1.31      albertel 14233:         }
1.561     www      14234: # catch the very last entry, since we never encountered the separator
                   14235:         $components{&takeleft($i)}=$field;
1.31      albertel 14236:     }
                   14237:     return %components;
                   14238: }
                   14239: 
1.144     matthew  14240: ######################################################
                   14241: ######################################################
                   14242: 
1.56      matthew  14243: =pod
                   14244: 
1.648     raeburn  14245: =item * &upfile_select_html()
1.41      ng       14246: 
1.144     matthew  14247: Return HTML code to select a file from the users machine and specify 
                   14248: the file type.
1.41      ng       14249: 
                   14250: =cut
                   14251: 
1.144     matthew  14252: ######################################################
                   14253: ######################################################
1.31      albertel 14254: sub upfile_select_html {
1.144     matthew  14255:     my %Types = (
                   14256:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 14257:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  14258:                  space => &mt('Space separated'),
                   14259:                  tab   => &mt('Tabulator separated'),
                   14260: #                 xml   => &mt('HTML/XML'),
                   14261:                  );
                   14262:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  14263:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  14264:     foreach my $type (sort(keys(%Types))) {
                   14265:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   14266:     }
                   14267:     $Str .= "</select>\n";
                   14268:     return $Str;
1.31      albertel 14269: }
                   14270: 
1.301     albertel 14271: sub get_samples {
                   14272:     my ($records,$toget) = @_;
                   14273:     my @samples=({});
                   14274:     my $got=0;
                   14275:     foreach my $rec (@$records) {
                   14276: 	my %temp = &record_sep($rec);
                   14277: 	if (! grep(/\S/, values(%temp))) { next; }
                   14278: 	if (%temp) {
                   14279: 	    $samples[$got]=\%temp;
                   14280: 	    $got++;
                   14281: 	    if ($got == $toget) { last; }
                   14282: 	}
                   14283:     }
                   14284:     return \@samples;
                   14285: }
                   14286: 
1.144     matthew  14287: ######################################################
                   14288: ######################################################
                   14289: 
1.56      matthew  14290: =pod
                   14291: 
1.648     raeburn  14292: =item * &csv_print_samples($r,$records)
1.41      ng       14293: 
                   14294: Prints a table of sample values from each column uploaded $r is an
                   14295: Apache Request ref, $records is an arrayref from
                   14296: &Apache::loncommon::upfile_record_sep
                   14297: 
                   14298: =cut
                   14299: 
1.144     matthew  14300: ######################################################
                   14301: ######################################################
1.31      albertel 14302: sub csv_print_samples {
                   14303:     my ($r,$records) = @_;
1.662     bisitz   14304:     my $samples = &get_samples($records,5);
1.301     albertel 14305: 
1.594     raeburn  14306:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   14307:               &start_data_table_header_row());
1.356     albertel 14308:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   14309:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  14310:     $r->print(&end_data_table_header_row());
1.301     albertel 14311:     foreach my $hash (@$samples) {
1.594     raeburn  14312: 	$r->print(&start_data_table_row());
1.356     albertel 14313: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 14314: 	    $r->print('<td>');
1.356     albertel 14315: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 14316: 	    $r->print('</td>');
                   14317: 	}
1.594     raeburn  14318: 	$r->print(&end_data_table_row());
1.31      albertel 14319:     }
1.594     raeburn  14320:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 14321: }
                   14322: 
1.144     matthew  14323: ######################################################
                   14324: ######################################################
                   14325: 
1.56      matthew  14326: =pod
                   14327: 
1.648     raeburn  14328: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       14329: 
                   14330: Prints a table to create associations between values and table columns.
1.144     matthew  14331: 
1.41      ng       14332: $r is an Apache Request ref,
                   14333: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  14334: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       14335: 
                   14336: =cut
                   14337: 
1.144     matthew  14338: ######################################################
                   14339: ######################################################
1.31      albertel 14340: sub csv_print_select_table {
                   14341:     my ($r,$records,$d) = @_;
1.301     albertel 14342:     my $i=0;
                   14343:     my $samples = &get_samples($records,1);
1.144     matthew  14344:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  14345: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  14346:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  14347:               '<th>'.&mt('Column').'</th>'.
                   14348:               &end_data_table_header_row()."\n");
1.356     albertel 14349:     foreach my $array_ref (@$d) {
                   14350: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  14351: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 14352: 
1.875     bisitz   14353: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  14354: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 14355: 	$r->print('<option value="none"></option>');
1.356     albertel 14356: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   14357: 	    $r->print('<option value="'.$sample.'"'.
                   14358:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   14359:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 14360: 	}
1.594     raeburn  14361: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 14362: 	$i++;
                   14363:     }
1.594     raeburn  14364:     $r->print(&end_data_table());
1.31      albertel 14365:     $i--;
                   14366:     return $i;
                   14367: }
1.56      matthew  14368: 
1.144     matthew  14369: ######################################################
                   14370: ######################################################
                   14371: 
1.56      matthew  14372: =pod
1.31      albertel 14373: 
1.648     raeburn  14374: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       14375: 
                   14376: Prints a table of sample values from the upload and can make associate samples to internal names.
                   14377: 
                   14378: $r is an Apache Request ref,
                   14379: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   14380: $d is an array of 2 element arrays (internal name, displayed name)
                   14381: 
                   14382: =cut
                   14383: 
1.144     matthew  14384: ######################################################
                   14385: ######################################################
1.31      albertel 14386: sub csv_samples_select_table {
                   14387:     my ($r,$records,$d) = @_;
                   14388:     my $i=0;
1.144     matthew  14389:     #
1.662     bisitz   14390:     my $max_samples = 5;
                   14391:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  14392:     $r->print(&start_data_table().
                   14393:               &start_data_table_header_row().'<th>'.
                   14394:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   14395:               &end_data_table_header_row());
1.301     albertel 14396: 
                   14397:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  14398: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  14399: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 14400: 	foreach my $option (@$d) {
                   14401: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  14402: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 14403:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  14404:                       $display.'</option>');
1.31      albertel 14405: 	}
                   14406: 	$r->print('</select></td><td>');
1.662     bisitz   14407: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 14408: 	    if (defined($samples->[$line]{$key})) { 
                   14409: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   14410: 	    }
                   14411: 	}
1.594     raeburn  14412: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 14413: 	$i++;
                   14414:     }
1.594     raeburn  14415:     $r->print(&end_data_table());
1.31      albertel 14416:     $i--;
                   14417:     return($i);
1.115     matthew  14418: }
                   14419: 
1.144     matthew  14420: ######################################################
                   14421: ######################################################
                   14422: 
1.115     matthew  14423: =pod
                   14424: 
1.648     raeburn  14425: =item * &clean_excel_name($name)
1.115     matthew  14426: 
                   14427: Returns a replacement for $name which does not contain any illegal characters.
                   14428: 
                   14429: =cut
                   14430: 
1.144     matthew  14431: ######################################################
                   14432: ######################################################
1.115     matthew  14433: sub clean_excel_name {
                   14434:     my ($name) = @_;
                   14435:     $name =~ s/[:\*\?\/\\]//g;
                   14436:     if (length($name) > 31) {
                   14437:         $name = substr($name,0,31);
                   14438:     }
                   14439:     return $name;
1.25      albertel 14440: }
1.84      albertel 14441: 
1.85      albertel 14442: =pod
                   14443: 
1.648     raeburn  14444: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 14445: 
                   14446: Returns either 1 or undef
                   14447: 
                   14448: 1 if the part is to be hidden, undef if it is to be shown
                   14449: 
                   14450: Arguments are:
                   14451: 
                   14452: $id the id of the part to be checked
                   14453: $symb, optional the symb of the resource to check
                   14454: $udom, optional the domain of the user to check for
                   14455: $uname, optional the username of the user to check for
                   14456: 
                   14457: =cut
1.84      albertel 14458: 
                   14459: sub check_if_partid_hidden {
                   14460:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 14461:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 14462: 					 $symb,$udom,$uname);
1.141     albertel 14463:     my $truth=1;
                   14464:     #if the string starts with !, then the list is the list to show not hide
                   14465:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 14466:     my @hiddenlist=split(/,/,$hiddenparts);
                   14467:     foreach my $checkid (@hiddenlist) {
1.141     albertel 14468: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 14469:     }
1.141     albertel 14470:     return !$truth;
1.84      albertel 14471: }
1.127     matthew  14472: 
1.138     matthew  14473: 
                   14474: ############################################################
                   14475: ############################################################
                   14476: 
                   14477: =pod
                   14478: 
1.157     matthew  14479: =back 
                   14480: 
1.138     matthew  14481: =head1 cgi-bin script and graphing routines
                   14482: 
1.157     matthew  14483: =over 4
                   14484: 
1.648     raeburn  14485: =item * &get_cgi_id()
1.138     matthew  14486: 
                   14487: Inputs: none
                   14488: 
                   14489: Returns an id which can be used to pass environment variables
                   14490: to various cgi-bin scripts.  These environment variables will
                   14491: be removed from the users environment after a given time by
                   14492: the routine &Apache::lonnet::transfer_profile_to_env.
                   14493: 
                   14494: =cut
                   14495: 
                   14496: ############################################################
                   14497: ############################################################
1.152     albertel 14498: my $uniq=0;
1.136     matthew  14499: sub get_cgi_id {
1.154     albertel 14500:     $uniq=($uniq+1)%100000;
1.280     albertel 14501:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  14502: }
                   14503: 
1.127     matthew  14504: ############################################################
                   14505: ############################################################
                   14506: 
                   14507: =pod
                   14508: 
1.648     raeburn  14509: =item * &DrawBarGraph()
1.127     matthew  14510: 
1.138     matthew  14511: Facilitates the plotting of data in a (stacked) bar graph.
                   14512: Puts plot definition data into the users environment in order for 
                   14513: graph.png to plot it.  Returns an <img> tag for the plot.
                   14514: The bars on the plot are labeled '1','2',...,'n'.
                   14515: 
                   14516: Inputs:
                   14517: 
                   14518: =over 4
                   14519: 
                   14520: =item $Title: string, the title of the plot
                   14521: 
                   14522: =item $xlabel: string, text describing the X-axis of the plot
                   14523: 
                   14524: =item $ylabel: string, text describing the Y-axis of the plot
                   14525: 
                   14526: =item $Max: scalar, the maximum Y value to use in the plot
                   14527: If $Max is < any data point, the graph will not be rendered.
                   14528: 
1.140     matthew  14529: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  14530: they are plotted.  If undefined, default values will be used.
                   14531: 
1.178     matthew  14532: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   14533: 
1.138     matthew  14534: =item @Values: An array of array references.  Each array reference holds data
                   14535: to be plotted in a stacked bar chart.
                   14536: 
1.239     matthew  14537: =item If the final element of @Values is a hash reference the key/value
                   14538: pairs will be added to the graph definition.
                   14539: 
1.138     matthew  14540: =back
                   14541: 
                   14542: Returns:
                   14543: 
                   14544: An <img> tag which references graph.png and the appropriate identifying
                   14545: information for the plot.
                   14546: 
1.127     matthew  14547: =cut
                   14548: 
                   14549: ############################################################
                   14550: ############################################################
1.134     matthew  14551: sub DrawBarGraph {
1.178     matthew  14552:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  14553:     #
                   14554:     if (! defined($colors)) {
                   14555:         $colors = ['#33ff00', 
                   14556:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   14557:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   14558:                   ]; 
                   14559:     }
1.228     matthew  14560:     my $extra_settings = {};
                   14561:     if (ref($Values[-1]) eq 'HASH') {
                   14562:         $extra_settings = pop(@Values);
                   14563:     }
1.127     matthew  14564:     #
1.136     matthew  14565:     my $identifier = &get_cgi_id();
                   14566:     my $id = 'cgi.'.$identifier;        
1.129     matthew  14567:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  14568:         return '';
                   14569:     }
1.225     matthew  14570:     #
                   14571:     my @Labels;
                   14572:     if (defined($labels)) {
                   14573:         @Labels = @$labels;
                   14574:     } else {
                   14575:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1075.2.119  raeburn  14576:             push(@Labels,$i+1);
1.225     matthew  14577:         }
                   14578:     }
                   14579:     #
1.129     matthew  14580:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  14581:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  14582:     my %ValuesHash;
                   14583:     my $NumSets=1;
                   14584:     foreach my $array (@Values) {
                   14585:         next if (! ref($array));
1.136     matthew  14586:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  14587:             join(',',@$array);
1.129     matthew  14588:     }
1.127     matthew  14589:     #
1.136     matthew  14590:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  14591:     if ($NumBars < 3) {
                   14592:         $width = 120+$NumBars*32;
1.220     matthew  14593:         $xskip = 1;
1.225     matthew  14594:         $bar_width = 30;
                   14595:     } elsif ($NumBars < 5) {
                   14596:         $width = 120+$NumBars*20;
                   14597:         $xskip = 1;
                   14598:         $bar_width = 20;
1.220     matthew  14599:     } elsif ($NumBars < 10) {
1.136     matthew  14600:         $width = 120+$NumBars*15;
                   14601:         $xskip = 1;
                   14602:         $bar_width = 15;
                   14603:     } elsif ($NumBars <= 25) {
                   14604:         $width = 120+$NumBars*11;
                   14605:         $xskip = 5;
                   14606:         $bar_width = 8;
                   14607:     } elsif ($NumBars <= 50) {
                   14608:         $width = 120+$NumBars*8;
                   14609:         $xskip = 5;
                   14610:         $bar_width = 4;
                   14611:     } else {
                   14612:         $width = 120+$NumBars*8;
                   14613:         $xskip = 5;
                   14614:         $bar_width = 4;
                   14615:     }
                   14616:     #
1.137     matthew  14617:     $Max = 1 if ($Max < 1);
                   14618:     if ( int($Max) < $Max ) {
                   14619:         $Max++;
                   14620:         $Max = int($Max);
                   14621:     }
1.127     matthew  14622:     $Title  = '' if (! defined($Title));
                   14623:     $xlabel = '' if (! defined($xlabel));
                   14624:     $ylabel = '' if (! defined($ylabel));
1.369     www      14625:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   14626:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   14627:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  14628:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  14629:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   14630:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   14631:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   14632:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14633:     $ValuesHash{$id.'.height'}   = $height;
                   14634:     $ValuesHash{$id.'.width'}    = $width;
                   14635:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   14636:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   14637:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  14638:     #
1.228     matthew  14639:     # Deal with other parameters
                   14640:     while (my ($key,$value) = each(%$extra_settings)) {
                   14641:         $ValuesHash{$id.'.'.$key} = $value;
                   14642:     }
                   14643:     #
1.646     raeburn  14644:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  14645:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14646: }
                   14647: 
                   14648: ############################################################
                   14649: ############################################################
                   14650: 
                   14651: =pod
                   14652: 
1.648     raeburn  14653: =item * &DrawXYGraph()
1.137     matthew  14654: 
1.138     matthew  14655: Facilitates the plotting of data in an XY graph.
                   14656: Puts plot definition data into the users environment in order for 
                   14657: graph.png to plot it.  Returns an <img> tag for the plot.
                   14658: 
                   14659: Inputs:
                   14660: 
                   14661: =over 4
                   14662: 
                   14663: =item $Title: string, the title of the plot
                   14664: 
                   14665: =item $xlabel: string, text describing the X-axis of the plot
                   14666: 
                   14667: =item $ylabel: string, text describing the Y-axis of the plot
                   14668: 
                   14669: =item $Max: scalar, the maximum Y value to use in the plot
                   14670: If $Max is < any data point, the graph will not be rendered.
                   14671: 
                   14672: =item $colors: Array ref containing the hex color codes for the data to be 
                   14673: plotted in.  If undefined, default values will be used.
                   14674: 
                   14675: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14676: 
                   14677: =item $Ydata: Array ref containing Array refs.  
1.185     www      14678: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  14679: 
                   14680: =item %Values: hash indicating or overriding any default values which are 
                   14681: passed to graph.png.  
                   14682: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14683: 
                   14684: =back
                   14685: 
                   14686: Returns:
                   14687: 
                   14688: An <img> tag which references graph.png and the appropriate identifying
                   14689: information for the plot.
                   14690: 
1.137     matthew  14691: =cut
                   14692: 
                   14693: ############################################################
                   14694: ############################################################
                   14695: sub DrawXYGraph {
                   14696:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   14697:     #
                   14698:     # Create the identifier for the graph
                   14699:     my $identifier = &get_cgi_id();
                   14700:     my $id = 'cgi.'.$identifier;
                   14701:     #
                   14702:     $Title  = '' if (! defined($Title));
                   14703:     $xlabel = '' if (! defined($xlabel));
                   14704:     $ylabel = '' if (! defined($ylabel));
                   14705:     my %ValuesHash = 
                   14706:         (
1.369     www      14707:          $id.'.title'  => &escape($Title),
                   14708:          $id.'.xlabel' => &escape($xlabel),
                   14709:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  14710:          $id.'.y_max_value'=> $Max,
                   14711:          $id.'.labels'     => join(',',@$Xlabels),
                   14712:          $id.'.PlotType'   => 'XY',
                   14713:          );
                   14714:     #
                   14715:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14716:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14717:     }
                   14718:     #
                   14719:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   14720:         return '';
                   14721:     }
                   14722:     my $NumSets=1;
1.138     matthew  14723:     foreach my $array (@{$Ydata}){
1.137     matthew  14724:         next if (! ref($array));
                   14725:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   14726:     }
1.138     matthew  14727:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  14728:     #
                   14729:     # Deal with other parameters
                   14730:     while (my ($key,$value) = each(%Values)) {
                   14731:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  14732:     }
                   14733:     #
1.646     raeburn  14734:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  14735:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14736: }
                   14737: 
                   14738: ############################################################
                   14739: ############################################################
                   14740: 
                   14741: =pod
                   14742: 
1.648     raeburn  14743: =item * &DrawXYYGraph()
1.138     matthew  14744: 
                   14745: Facilitates the plotting of data in an XY graph with two Y axes.
                   14746: Puts plot definition data into the users environment in order for 
                   14747: graph.png to plot it.  Returns an <img> tag for the plot.
                   14748: 
                   14749: Inputs:
                   14750: 
                   14751: =over 4
                   14752: 
                   14753: =item $Title: string, the title of the plot
                   14754: 
                   14755: =item $xlabel: string, text describing the X-axis of the plot
                   14756: 
                   14757: =item $ylabel: string, text describing the Y-axis of the plot
                   14758: 
                   14759: =item $colors: Array ref containing the hex color codes for the data to be 
                   14760: plotted in.  If undefined, default values will be used.
                   14761: 
                   14762: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14763: 
                   14764: =item $Ydata1: The first data set
                   14765: 
                   14766: =item $Min1: The minimum value of the left Y-axis
                   14767: 
                   14768: =item $Max1: The maximum value of the left Y-axis
                   14769: 
                   14770: =item $Ydata2: The second data set
                   14771: 
                   14772: =item $Min2: The minimum value of the right Y-axis
                   14773: 
                   14774: =item $Max2: The maximum value of the left Y-axis
                   14775: 
                   14776: =item %Values: hash indicating or overriding any default values which are 
                   14777: passed to graph.png.  
                   14778: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14779: 
                   14780: =back
                   14781: 
                   14782: Returns:
                   14783: 
                   14784: An <img> tag which references graph.png and the appropriate identifying
                   14785: information for the plot.
1.136     matthew  14786: 
                   14787: =cut
                   14788: 
                   14789: ############################################################
                   14790: ############################################################
1.137     matthew  14791: sub DrawXYYGraph {
                   14792:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   14793:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  14794:     #
                   14795:     # Create the identifier for the graph
                   14796:     my $identifier = &get_cgi_id();
                   14797:     my $id = 'cgi.'.$identifier;
                   14798:     #
                   14799:     $Title  = '' if (! defined($Title));
                   14800:     $xlabel = '' if (! defined($xlabel));
                   14801:     $ylabel = '' if (! defined($ylabel));
                   14802:     my %ValuesHash = 
                   14803:         (
1.369     www      14804:          $id.'.title'  => &escape($Title),
                   14805:          $id.'.xlabel' => &escape($xlabel),
                   14806:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  14807:          $id.'.labels' => join(',',@$Xlabels),
                   14808:          $id.'.PlotType' => 'XY',
                   14809:          $id.'.NumSets' => 2,
1.137     matthew  14810:          $id.'.two_axes' => 1,
                   14811:          $id.'.y1_max_value' => $Max1,
                   14812:          $id.'.y1_min_value' => $Min1,
                   14813:          $id.'.y2_max_value' => $Max2,
                   14814:          $id.'.y2_min_value' => $Min2,
1.136     matthew  14815:          );
                   14816:     #
1.137     matthew  14817:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14818:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14819:     }
                   14820:     #
                   14821:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   14822:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  14823:         return '';
                   14824:     }
                   14825:     my $NumSets=1;
1.137     matthew  14826:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  14827:         next if (! ref($array));
                   14828:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  14829:     }
                   14830:     #
                   14831:     # Deal with other parameters
                   14832:     while (my ($key,$value) = each(%Values)) {
                   14833:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  14834:     }
                   14835:     #
1.646     raeburn  14836:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 14837:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  14838: }
                   14839: 
                   14840: ############################################################
                   14841: ############################################################
                   14842: 
                   14843: =pod
                   14844: 
1.157     matthew  14845: =back 
                   14846: 
1.139     matthew  14847: =head1 Statistics helper routines?  
                   14848: 
                   14849: Bad place for them but what the hell.
                   14850: 
1.157     matthew  14851: =over 4
                   14852: 
1.648     raeburn  14853: =item * &chartlink()
1.139     matthew  14854: 
                   14855: Returns a link to the chart for a specific student.  
                   14856: 
                   14857: Inputs:
                   14858: 
                   14859: =over 4
                   14860: 
                   14861: =item $linktext: The text of the link
                   14862: 
                   14863: =item $sname: The students username
                   14864: 
                   14865: =item $sdomain: The students domain
                   14866: 
                   14867: =back
                   14868: 
1.157     matthew  14869: =back
                   14870: 
1.139     matthew  14871: =cut
                   14872: 
                   14873: ############################################################
                   14874: ############################################################
                   14875: sub chartlink {
                   14876:     my ($linktext, $sname, $sdomain) = @_;
                   14877:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      14878:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 14879:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  14880:        '">'.$linktext.'</a>';
1.153     matthew  14881: }
                   14882: 
                   14883: #######################################################
                   14884: #######################################################
                   14885: 
                   14886: =pod
                   14887: 
                   14888: =head1 Course Environment Routines
1.157     matthew  14889: 
                   14890: =over 4
1.153     matthew  14891: 
1.648     raeburn  14892: =item * &restore_course_settings()
1.153     matthew  14893: 
1.648     raeburn  14894: =item * &store_course_settings()
1.153     matthew  14895: 
                   14896: Restores/Store indicated form parameters from the course environment.
                   14897: Will not overwrite existing values of the form parameters.
                   14898: 
                   14899: Inputs: 
                   14900: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   14901: 
                   14902: a hash ref describing the data to be stored.  For example:
                   14903:    
                   14904: %Save_Parameters = ('Status' => 'scalar',
                   14905:     'chartoutputmode' => 'scalar',
                   14906:     'chartoutputdata' => 'scalar',
                   14907:     'Section' => 'array',
1.373     raeburn  14908:     'Group' => 'array',
1.153     matthew  14909:     'StudentData' => 'array',
                   14910:     'Maps' => 'array');
                   14911: 
                   14912: Returns: both routines return nothing
                   14913: 
1.631     raeburn  14914: =back
                   14915: 
1.153     matthew  14916: =cut
                   14917: 
                   14918: #######################################################
                   14919: #######################################################
                   14920: sub store_course_settings {
1.496     albertel 14921:     return &store_settings($env{'request.course.id'},@_);
                   14922: }
                   14923: 
                   14924: sub store_settings {
1.153     matthew  14925:     # save to the environment
                   14926:     # appenv the same items, just to be safe
1.300     albertel 14927:     my $udom  = $env{'user.domain'};
                   14928:     my $uname = $env{'user.name'};
1.496     albertel 14929:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14930:     my %SaveHash;
                   14931:     my %AppHash;
                   14932:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 14933:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 14934:         my $envname = 'environment.'.$basename;
1.258     albertel 14935:         if (exists($env{'form.'.$setting})) {
1.153     matthew  14936:             # Save this value away
                   14937:             if ($type eq 'scalar' &&
1.258     albertel 14938:                 (! exists($env{$envname}) || 
                   14939:                  $env{$envname} ne $env{'form.'.$setting})) {
                   14940:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   14941:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  14942:             } elsif ($type eq 'array') {
                   14943:                 my $stored_form;
1.258     albertel 14944:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  14945:                     $stored_form = join(',',
                   14946:                                         map {
1.369     www      14947:                                             &escape($_);
1.258     albertel 14948:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  14949:                 } else {
                   14950:                     $stored_form = 
1.369     www      14951:                         &escape($env{'form.'.$setting});
1.153     matthew  14952:                 }
                   14953:                 # Determine if the array contents are the same.
1.258     albertel 14954:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  14955:                     $SaveHash{$basename} = $stored_form;
                   14956:                     $AppHash{$envname}   = $stored_form;
                   14957:                 }
                   14958:             }
                   14959:         }
                   14960:     }
                   14961:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 14962:                                           $udom,$uname);
1.153     matthew  14963:     if ($put_result !~ /^(ok|delayed)/) {
                   14964:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   14965:                                  'got error:'.$put_result);
                   14966:     }
                   14967:     # Make sure these settings stick around in this session, too
1.646     raeburn  14968:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  14969:     return;
                   14970: }
                   14971: 
                   14972: sub restore_course_settings {
1.499     albertel 14973:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 14974: }
                   14975: 
                   14976: sub restore_settings {
                   14977:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14978:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 14979:         next if (exists($env{'form.'.$setting}));
1.496     albertel 14980:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  14981:             '.'.$setting;
1.258     albertel 14982:         if (exists($env{$envname})) {
1.153     matthew  14983:             if ($type eq 'scalar') {
1.258     albertel 14984:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  14985:             } elsif ($type eq 'array') {
1.258     albertel 14986:                 $env{'form.'.$setting} = [ 
1.153     matthew  14987:                                            map { 
1.369     www      14988:                                                &unescape($_); 
1.258     albertel 14989:                                            } split(',',$env{$envname})
1.153     matthew  14990:                                            ];
                   14991:             }
                   14992:         }
                   14993:     }
1.127     matthew  14994: }
                   14995: 
1.618     raeburn  14996: #######################################################
                   14997: #######################################################
                   14998: 
                   14999: =pod
                   15000: 
                   15001: =head1 Domain E-mail Routines  
                   15002: 
                   15003: =over 4
                   15004: 
1.648     raeburn  15005: =item * &build_recipient_list()
1.618     raeburn  15006: 
1.1075.2.44  raeburn  15007: Build recipient lists for following types of e-mail:
1.766     raeburn  15008: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1075.2.44  raeburn  15009: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   15010: module change checking, student/employee ID conflict checks, as
                   15011: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   15012: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  15013: 
                   15014: Inputs:
1.1075.2.44  raeburn  15015: defmail (scalar - email address of default recipient),
                   15016: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   15017: requestsmail, updatesmail, or idconflictsmail).
                   15018: 
1.619     raeburn  15019: defdom (domain for which to retrieve configuration settings),
1.1075.2.44  raeburn  15020: 
                   15021: origmail (scalar - email address of recipient from loncapa.conf,
                   15022: i.e., predates configuration by DC via domainprefs.pm
1.618     raeburn  15023: 
1.1075.2.139  raeburn  15024: $requname username of requester (if mailing type is helpdeskmail)
                   15025: 
                   15026: $requdom domain of requester (if mailing type is helpdeskmail)
                   15027: 
                   15028: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
                   15029: 
1.655     raeburn  15030: Returns: comma separated list of addresses to which to send e-mail.
                   15031: 
                   15032: =back
1.618     raeburn  15033: 
                   15034: =cut
                   15035: 
                   15036: ############################################################
                   15037: ############################################################
                   15038: sub build_recipient_list {
1.1075.2.139  raeburn  15039:     my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618     raeburn  15040:     my @recipients;
1.1075.2.122  raeburn  15041:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  15042:     my %domconfig =
1.1075.2.122  raeburn  15043:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  15044:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  15045:         if (exists($domconfig{'contacts'}{$mailing})) {
                   15046:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   15047:                 my @contacts = ('adminemail','supportemail');
                   15048:                 foreach my $item (@contacts) {
                   15049:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   15050:                         my $addr = $domconfig{'contacts'}{$item}; 
                   15051:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   15052:                             push(@recipients,$addr);
                   15053:                         }
1.619     raeburn  15054:                     }
1.1075.2.122  raeburn  15055:                 }
                   15056:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   15057:                 if ($mailing eq 'helpdeskmail') {
                   15058:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   15059:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   15060:                         my @ok_bccs;
                   15061:                         foreach my $bcc (@bccs) {
                   15062:                             $bcc =~ s/^\s+//g;
                   15063:                             $bcc =~ s/\s+$//g;
                   15064:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   15065:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   15066:                                     push(@ok_bccs,$bcc);
                   15067:                                 }
                   15068:                             }
                   15069:                         }
                   15070:                         if (@ok_bccs > 0) {
                   15071:                             $allbcc = join(', ',@ok_bccs);
                   15072:                         }
                   15073:                     }
                   15074:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  15075:                 }
                   15076:             }
1.766     raeburn  15077:         } elsif ($origmail ne '') {
1.1075.2.122  raeburn  15078:             $lastresort = $origmail;
1.618     raeburn  15079:         }
1.1075.2.139  raeburn  15080:         if ($mailing eq 'helpdeskmail') {
                   15081:             if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
                   15082:                 (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
                   15083:                 my ($inststatus,$inststatus_checked);
                   15084:                 if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
                   15085:                     ($env{'user.domain'} ne 'public')) {
                   15086:                     $inststatus_checked = 1;
                   15087:                     $inststatus = $env{'environment.inststatus'};
                   15088:                 }
                   15089:                 unless ($inststatus_checked) {
                   15090:                     if (($requname ne '') && ($requdom ne '')) {
                   15091:                         if (($requname =~ /^$match_username$/) &&
                   15092:                             ($requdom =~ /^$match_domain$/) &&
                   15093:                             (&Apache::lonnet::domain($requdom))) {
                   15094:                             my $requhome = &Apache::lonnet::homeserver($requname,
                   15095:                                                                       $requdom);
                   15096:                             unless ($requhome eq 'no_host') {
                   15097:                                 my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
                   15098:                                 $inststatus = $userenv{'inststatus'};
                   15099:                                 $inststatus_checked = 1;
                   15100:                             }
                   15101:                         }
                   15102:                     }
                   15103:                 }
                   15104:                 unless ($inststatus_checked) {
                   15105:                     if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
                   15106:                         my %srch = (srchby     => 'email',
                   15107:                                     srchdomain => $defdom,
                   15108:                                     srchterm   => $reqemail,
                   15109:                                     srchtype   => 'exact');
                   15110:                         my %srch_results = &Apache::lonnet::usersearch(\%srch);
                   15111:                         foreach my $uname (keys(%srch_results)) {
                   15112:                             if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   15113:                                 $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   15114:                                 $inststatus_checked = 1;
                   15115:                                 last;
                   15116:                             }
                   15117:                         }
                   15118:                         unless ($inststatus_checked) {
                   15119:                             my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
                   15120:                             if ($dirsrchres eq 'ok') {
                   15121:                                 foreach my $uname (keys(%srch_results)) {
                   15122:                                     if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   15123:                                         $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   15124:                                         $inststatus_checked = 1;
                   15125:                                         last;
                   15126:                                     }
                   15127:                                 }
                   15128:                             }
                   15129:                         }
                   15130:                     }
                   15131:                 }
                   15132:                 if ($inststatus ne '') {
                   15133:                     foreach my $status (split(/\:/,$inststatus)) {
                   15134:                         if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
                   15135:                             my @contacts = ('adminemail','supportemail');
                   15136:                             foreach my $item (@contacts) {
                   15137:                                 if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
                   15138:                                     my $addr = $domconfig{'contacts'}{'overrides'}{$status};
                   15139:                                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   15140:                                         push(@recipients,$addr);
                   15141:                                     }
                   15142:                                 }
                   15143:                             }
                   15144:                             $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
                   15145:                             if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
                   15146:                                 my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
                   15147:                                 my @ok_bccs;
                   15148:                                 foreach my $bcc (@bccs) {
                   15149:                                     $bcc =~ s/^\s+//g;
                   15150:                                     $bcc =~ s/\s+$//g;
                   15151:                                     if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   15152:                                         if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   15153:                                             push(@ok_bccs,$bcc);
                   15154:                                         }
                   15155:                                     }
                   15156:                                 }
                   15157:                                 if (@ok_bccs > 0) {
                   15158:                                     $allbcc = join(', ',@ok_bccs);
                   15159:                                 }
                   15160:                             }
                   15161:                             $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
                   15162:                             last;
                   15163:                         }
                   15164:                     }
                   15165:                 }
                   15166:             }
                   15167:         }
1.619     raeburn  15168:     } elsif ($origmail ne '') {
1.1075.2.122  raeburn  15169:         $lastresort = $origmail;
                   15170:     }
1.1075.2.128  raeburn  15171:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1075.2.122  raeburn  15172:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   15173:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   15174:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   15175:             my %what = (
                   15176:                           perlvar => 1,
                   15177:                        );
                   15178:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   15179:             if ($primary) {
                   15180:                 my $gotaddr;
                   15181:                 my ($result,$returnhash) =
                   15182:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   15183:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   15184:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   15185:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   15186:                         $gotaddr = 1;
                   15187:                     }
                   15188:                 }
                   15189:                 unless ($gotaddr) {
                   15190:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   15191:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   15192:                     unless ($uintdom eq $intdom) {
                   15193:                         my %domconfig =
                   15194:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   15195:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   15196:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   15197:                                 my @contacts = ('adminemail','supportemail');
                   15198:                                 foreach my $item (@contacts) {
                   15199:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   15200:                                         my $addr = $domconfig{'contacts'}{$item};
                   15201:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   15202:                                             push(@recipients,$addr);
                   15203:                                         }
                   15204:                                     }
                   15205:                                 }
                   15206:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   15207:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   15208:                                 }
                   15209:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   15210:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   15211:                                     my @ok_bccs;
                   15212:                                     foreach my $bcc (@bccs) {
                   15213:                                         $bcc =~ s/^\s+//g;
                   15214:                                         $bcc =~ s/\s+$//g;
                   15215:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   15216:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   15217:                                                 push(@ok_bccs,$bcc);
                   15218:                                             }
                   15219:                                         }
                   15220:                                     }
                   15221:                                     if (@ok_bccs > 0) {
                   15222:                                         $allbcc = join(', ',@ok_bccs);
                   15223:                                     }
                   15224:                                 }
                   15225:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   15226:                             }
                   15227:                         }
                   15228:                     }
                   15229:                 }
                   15230:             }
                   15231:         }
1.618     raeburn  15232:     }
1.688     raeburn  15233:     if (defined($defmail)) {
                   15234:         if ($defmail ne '') {
                   15235:             push(@recipients,$defmail);
                   15236:         }
1.618     raeburn  15237:     }
                   15238:     if ($otheremails) {
1.619     raeburn  15239:         my @others;
                   15240:         if ($otheremails =~ /,/) {
                   15241:             @others = split(/,/,$otheremails);
1.618     raeburn  15242:         } else {
1.619     raeburn  15243:             push(@others,$otheremails);
                   15244:         }
                   15245:         foreach my $addr (@others) {
                   15246:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   15247:                 push(@recipients,$addr);
                   15248:             }
1.618     raeburn  15249:         }
                   15250:     }
1.1075.2.128  raeburn  15251:     if ($mailing eq 'helpdeskmail') {
1.1075.2.122  raeburn  15252:         if ((!@recipients) && ($lastresort ne '')) {
                   15253:             push(@recipients,$lastresort);
                   15254:         }
                   15255:     } elsif ($lastresort ne '') {
                   15256:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   15257:             push(@recipients,$lastresort);
                   15258:         }
                   15259:     }
                   15260:     my $recipientlist = join(',',@recipients);
                   15261:     if (wantarray) {
                   15262:         return ($recipientlist,$allbcc,$addtext);
                   15263:     } else {
                   15264:         return $recipientlist;
                   15265:     }
1.618     raeburn  15266: }
                   15267: 
1.127     matthew  15268: ############################################################
                   15269: ############################################################
1.154     albertel 15270: 
1.655     raeburn  15271: =pod
                   15272: 
                   15273: =head1 Course Catalog Routines
                   15274: 
                   15275: =over 4
                   15276: 
                   15277: =item * &gather_categories()
                   15278: 
                   15279: Converts category definitions - keys of categories hash stored in  
                   15280: coursecategories in configuration.db on the primary library server in a 
                   15281: domain - to an array.  Also generates javascript and idx hash used to 
                   15282: generate Domain Coordinator interface for editing Course Categories.
                   15283: 
                   15284: Inputs:
1.663     raeburn  15285: 
1.655     raeburn  15286: categories (reference to hash of category definitions).
1.663     raeburn  15287: 
1.655     raeburn  15288: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   15289:       categories and subcategories).
1.663     raeburn  15290: 
1.655     raeburn  15291: idx (reference to hash of counters used in Domain Coordinator interface for 
                   15292:       editing Course Categories).
1.663     raeburn  15293: 
1.655     raeburn  15294: jsarray (reference to array of categories used to create Javascript arrays for
                   15295:          Domain Coordinator interface for editing Course Categories).
                   15296: 
                   15297: Returns: nothing
                   15298: 
                   15299: Side effects: populates cats, idx and jsarray. 
                   15300: 
                   15301: =cut
                   15302: 
                   15303: sub gather_categories {
                   15304:     my ($categories,$cats,$idx,$jsarray) = @_;
                   15305:     my %counters;
                   15306:     my $num = 0;
                   15307:     foreach my $item (keys(%{$categories})) {
                   15308:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   15309:         if ($container eq '' && $depth == 0) {
                   15310:             $cats->[$depth][$categories->{$item}] = $cat;
                   15311:         } else {
                   15312:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   15313:         }
                   15314:         my ($escitem,$tail) = split(/:/,$item,2);
                   15315:         if ($counters{$tail} eq '') {
                   15316:             $counters{$tail} = $num;
                   15317:             $num ++;
                   15318:         }
                   15319:         if (ref($idx) eq 'HASH') {
                   15320:             $idx->{$item} = $counters{$tail};
                   15321:         }
                   15322:         if (ref($jsarray) eq 'ARRAY') {
                   15323:             push(@{$jsarray->[$counters{$tail}]},$item);
                   15324:         }
                   15325:     }
                   15326:     return;
                   15327: }
                   15328: 
                   15329: =pod
                   15330: 
                   15331: =item * &extract_categories()
                   15332: 
                   15333: Used to generate breadcrumb trails for course categories.
                   15334: 
                   15335: Inputs:
1.663     raeburn  15336: 
1.655     raeburn  15337: categories (reference to hash of category definitions).
1.663     raeburn  15338: 
1.655     raeburn  15339: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   15340:       categories and subcategories).
1.663     raeburn  15341: 
1.655     raeburn  15342: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  15343: 
1.655     raeburn  15344: allitems (reference to hash - key is category key 
                   15345:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  15346: 
1.655     raeburn  15347: idx (reference to hash of counters used in Domain Coordinator interface for
                   15348:       editing Course Categories).
1.663     raeburn  15349: 
1.655     raeburn  15350: jsarray (reference to array of categories used to create Javascript arrays for
                   15351:          Domain Coordinator interface for editing Course Categories).
                   15352: 
1.665     raeburn  15353: subcats (reference to hash of arrays containing all subcategories within each 
                   15354:          category, -recursive)
                   15355: 
1.1075.2.132  raeburn  15356: maxd (reference to hash used to hold max depth for all top-level categories).
                   15357: 
1.655     raeburn  15358: Returns: nothing
                   15359: 
                   15360: Side effects: populates trails and allitems hash references.
                   15361: 
                   15362: =cut
                   15363: 
                   15364: sub extract_categories {
1.1075.2.132  raeburn  15365:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655     raeburn  15366:     if (ref($categories) eq 'HASH') {
                   15367:         &gather_categories($categories,$cats,$idx,$jsarray);
                   15368:         if (ref($cats->[0]) eq 'ARRAY') {
                   15369:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   15370:                 my $name = $cats->[0][$i];
                   15371:                 my $item = &escape($name).'::0';
                   15372:                 my $trailstr;
                   15373:                 if ($name eq 'instcode') {
                   15374:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  15375:                 } elsif ($name eq 'communities') {
                   15376:                     $trailstr = &mt('Communities');
1.655     raeburn  15377:                 } else {
                   15378:                     $trailstr = $name;
                   15379:                 }
                   15380:                 if ($allitems->{$item} eq '') {
                   15381:                     push(@{$trails},$trailstr);
                   15382:                     $allitems->{$item} = scalar(@{$trails})-1;
                   15383:                 }
                   15384:                 my @parents = ($name);
                   15385:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   15386:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   15387:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  15388:                         if (ref($subcats) eq 'HASH') {
                   15389:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   15390:                         }
1.1075.2.132  raeburn  15391:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665     raeburn  15392:                     }
                   15393:                 } else {
                   15394:                     if (ref($subcats) eq 'HASH') {
                   15395:                         $subcats->{$item} = [];
1.655     raeburn  15396:                     }
1.1075.2.132  raeburn  15397:                     if (ref($maxd) eq 'HASH') {
                   15398:                         $maxd->{$name} = 1;
                   15399:                     }
1.655     raeburn  15400:                 }
                   15401:             }
                   15402:         }
                   15403:     }
                   15404:     return;
                   15405: }
                   15406: 
                   15407: =pod
                   15408: 
1.1075.2.56  raeburn  15409: =item * &recurse_categories()
1.655     raeburn  15410: 
                   15411: Recursively used to generate breadcrumb trails for course categories.
                   15412: 
                   15413: Inputs:
1.663     raeburn  15414: 
1.655     raeburn  15415: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   15416:       categories and subcategories).
1.663     raeburn  15417: 
1.655     raeburn  15418: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  15419: 
                   15420: category (current course category, for which breadcrumb trail is being generated).
                   15421: 
                   15422: trails (reference to array of breadcrumb trails for each category).
                   15423: 
1.655     raeburn  15424: allitems (reference to hash - key is category key
                   15425:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  15426: 
1.655     raeburn  15427: parents (array containing containers directories for current category, 
                   15428:          back to top level). 
                   15429: 
                   15430: Returns: nothing
                   15431: 
                   15432: Side effects: populates trails and allitems hash references
                   15433: 
                   15434: =cut
                   15435: 
                   15436: sub recurse_categories {
1.1075.2.132  raeburn  15437:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655     raeburn  15438:     my $shallower = $depth - 1;
                   15439:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   15440:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   15441:             my $name = $cats->[$depth]{$category}[$k];
                   15442:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.161.  .4(raebu 15443:22):             my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  15444:             if ($allitems->{$item} eq '') {
                   15445:                 push(@{$trails},$trailstr);
                   15446:                 $allitems->{$item} = scalar(@{$trails})-1;
                   15447:             }
                   15448:             my $deeper = $depth+1;
                   15449:             push(@{$parents},$category);
1.665     raeburn  15450:             if (ref($subcats) eq 'HASH') {
                   15451:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   15452:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   15453:                     my $higher;
                   15454:                     if ($j > 0) {
                   15455:                         $higher = &escape($parents->[$j]).':'.
                   15456:                                   &escape($parents->[$j-1]).':'.$j;
                   15457:                     } else {
                   15458:                         $higher = &escape($parents->[$j]).'::'.$j;
                   15459:                     }
                   15460:                     push(@{$subcats->{$higher}},$subcat);
                   15461:                 }
                   15462:             }
                   15463:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1075.2.132  raeburn  15464:                                 $subcats,$maxd);
1.655     raeburn  15465:             pop(@{$parents});
                   15466:         }
                   15467:     } else {
                   15468:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.132  raeburn  15469:         my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  15470:         if ($allitems->{$item} eq '') {
                   15471:             push(@{$trails},$trailstr);
                   15472:             $allitems->{$item} = scalar(@{$trails})-1;
                   15473:         }
1.1075.2.132  raeburn  15474:         if (ref($maxd) eq 'HASH') {
                   15475:             if ($depth > $maxd->{$parents->[0]}) {
                   15476:                 $maxd->{$parents->[0]} = $depth;
                   15477:             }
                   15478:         }
1.655     raeburn  15479:     }
                   15480:     return;
                   15481: }
                   15482: 
1.663     raeburn  15483: =pod
                   15484: 
1.1075.2.56  raeburn  15485: =item * &assign_categories_table()
1.663     raeburn  15486: 
                   15487: Create a datatable for display of hierarchical categories in a domain,
                   15488: with checkboxes to allow a course to be categorized. 
                   15489: 
                   15490: Inputs:
                   15491: 
                   15492: cathash - reference to hash of categories defined for the domain (from
                   15493:           configuration.db)
                   15494: 
                   15495: currcat - scalar with an & separated list of categories assigned to a course. 
                   15496: 
1.919     raeburn  15497: type    - scalar contains course type (Course or Community).
                   15498: 
1.1075.2.117  raeburn  15499: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   15500:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   15501: 
1.663     raeburn  15502: Returns: $output (markup to be displayed) 
                   15503: 
                   15504: =cut
                   15505: 
                   15506: sub assign_categories_table {
1.1075.2.117  raeburn  15507:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  15508:     my $output;
                   15509:     if (ref($cathash) eq 'HASH') {
1.1075.2.132  raeburn  15510:         my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
                   15511:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663     raeburn  15512:         $maxdepth = scalar(@cats);
                   15513:         if (@cats > 0) {
                   15514:             my $itemcount = 0;
                   15515:             if (ref($cats[0]) eq 'ARRAY') {
                   15516:                 my @currcategories;
                   15517:                 if ($currcat ne '') {
                   15518:                     @currcategories = split('&',$currcat);
                   15519:                 }
1.919     raeburn  15520:                 my $table;
1.663     raeburn  15521:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   15522:                     my $parent = $cats[0][$i];
1.919     raeburn  15523:                     next if ($parent eq 'instcode');
                   15524:                     if ($type eq 'Community') {
                   15525:                         next unless ($parent eq 'communities');
                   15526:                     } else {
                   15527:                         next if ($parent eq 'communities');
                   15528:                     }
1.663     raeburn  15529:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   15530:                     my $item = &escape($parent).'::0';
                   15531:                     my $checked = '';
                   15532:                     if (@currcategories > 0) {
                   15533:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   15534:                             $checked = ' checked="checked"';
1.663     raeburn  15535:                         }
                   15536:                     }
1.919     raeburn  15537:                     my $parent_title = $parent;
                   15538:                     if ($parent eq 'communities') {
                   15539:                         $parent_title = &mt('Communities');
                   15540:                     }
                   15541:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   15542:                               '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  15543:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  15544:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  15545:                     my $depth = 1;
                   15546:                     push(@path,$parent);
1.1075.2.117  raeburn  15547:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  15548:                     pop(@path);
1.919     raeburn  15549:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  15550:                     $itemcount ++;
                   15551:                 }
1.919     raeburn  15552:                 if ($itemcount) {
                   15553:                     $output = &Apache::loncommon::start_data_table().
                   15554:                               $table.
                   15555:                               &Apache::loncommon::end_data_table();
                   15556:                 }
1.663     raeburn  15557:             }
                   15558:         }
                   15559:     }
                   15560:     return $output;
                   15561: }
                   15562: 
                   15563: =pod
                   15564: 
1.1075.2.56  raeburn  15565: =item * &assign_category_rows()
1.663     raeburn  15566: 
                   15567: Create a datatable row for display of nested categories in a domain,
                   15568: with checkboxes to allow a course to be categorized,called recursively.
                   15569: 
                   15570: Inputs:
                   15571: 
                   15572: itemcount - track row number for alternating colors
                   15573: 
                   15574: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   15575:       categories and subcategories.
                   15576: 
                   15577: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   15578: 
                   15579: parent - parent of current category item
                   15580: 
                   15581: path - Array containing all categories back up through the hierarchy from the
                   15582:        current category to the top level.
                   15583: 
                   15584: currcategories - reference to array of current categories assigned to the course
                   15585: 
1.1075.2.117  raeburn  15586: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   15587:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   15588: 
1.663     raeburn  15589: Returns: $output (markup to be displayed).
                   15590: 
                   15591: =cut
                   15592: 
                   15593: sub assign_category_rows {
1.1075.2.117  raeburn  15594:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  15595:     my ($text,$name,$item,$chgstr);
                   15596:     if (ref($cats) eq 'ARRAY') {
                   15597:         my $maxdepth = scalar(@{$cats});
                   15598:         if (ref($cats->[$depth]) eq 'HASH') {
                   15599:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   15600:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   15601:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1075.2.45  raeburn  15602:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  15603:                 for (my $j=0; $j<$numchildren; $j++) {
                   15604:                     $name = $cats->[$depth]{$parent}[$j];
                   15605:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   15606:                     my $deeper = $depth+1;
                   15607:                     my $checked = '';
                   15608:                     if (ref($currcategories) eq 'ARRAY') {
                   15609:                         if (@{$currcategories} > 0) {
                   15610:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   15611:                                 $checked = ' checked="checked"';
1.663     raeburn  15612:                             }
                   15613:                         }
                   15614:                     }
1.664     raeburn  15615:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   15616:                              '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  15617:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  15618:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   15619:                              '</td><td>';
1.663     raeburn  15620:                     if (ref($path) eq 'ARRAY') {
                   15621:                         push(@{$path},$name);
1.1075.2.117  raeburn  15622:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  15623:                         pop(@{$path});
                   15624:                     }
                   15625:                     $text .= '</td></tr>';
                   15626:                 }
                   15627:                 $text .= '</table></td>';
                   15628:             }
                   15629:         }
                   15630:     }
                   15631:     return $text;
                   15632: }
                   15633: 
1.1075.2.69  raeburn  15634: =pod
                   15635: 
                   15636: =back
                   15637: 
                   15638: =cut
                   15639: 
1.655     raeburn  15640: ############################################################
                   15641: ############################################################
                   15642: 
                   15643: 
1.443     albertel 15644: sub commit_customrole {
1.664     raeburn  15645:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  15646:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 15647:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   15648:                          ($end?', ending '.localtime($end):'').': <b>'.
                   15649:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  15650:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 15651:                  '</b><br />';
                   15652:     return $output;
                   15653: }
                   15654: 
                   15655: sub commit_standardrole {
1.1075.2.31  raeburn  15656:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541     raeburn  15657:     my ($output,$logmsg,$linefeed);
                   15658:     if ($context eq 'auto') {
                   15659:         $linefeed = "\n";
                   15660:     } else {
                   15661:         $linefeed = "<br />\n";
                   15662:     }  
1.443     albertel 15663:     if ($three eq 'st') {
1.541     raeburn  15664:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31  raeburn  15665:                                          $one,$two,$sec,$context,$credits);
1.541     raeburn  15666:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  15667:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   15668:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 15669:         } else {
1.541     raeburn  15670:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 15671:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  15672:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   15673:             if ($context eq 'auto') {
                   15674:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   15675:             } else {
                   15676:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   15677:                &mt('Add to classlist').': <b>ok</b>';
                   15678:             }
                   15679:             $output .= $linefeed;
1.443     albertel 15680:         }
                   15681:     } else {
                   15682:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   15683:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  15684:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  15685:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  15686:         if ($context eq 'auto') {
                   15687:             $output .= $result.$linefeed;
                   15688:         } else {
                   15689:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   15690:         }
1.443     albertel 15691:     }
                   15692:     return $output;
                   15693: }
                   15694: 
                   15695: sub commit_studentrole {
1.1075.2.31  raeburn  15696:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
                   15697:         $credits) = @_;
1.626     raeburn  15698:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  15699:     if ($context eq 'auto') {
                   15700:         $linefeed = "\n";
                   15701:     } else {
                   15702:         $linefeed = '<br />'."\n";
                   15703:     }
1.443     albertel 15704:     if (defined($one) && defined($two)) {
                   15705:         my $cid=$one.'_'.$two;
                   15706:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   15707:         my $secchange = 0;
                   15708:         my $expire_role_result;
                   15709:         my $modify_section_result;
1.628     raeburn  15710:         if ($oldsec ne '-1') { 
                   15711:             if ($oldsec ne $sec) {
1.443     albertel 15712:                 $secchange = 1;
1.628     raeburn  15713:                 my $now = time;
1.443     albertel 15714:                 my $uurl='/'.$cid;
                   15715:                 $uurl=~s/\_/\//g;
                   15716:                 if ($oldsec) {
                   15717:                     $uurl.='/'.$oldsec;
                   15718:                 }
1.626     raeburn  15719:                 $oldsecurl = $uurl;
1.628     raeburn  15720:                 $expire_role_result = 
1.652     raeburn  15721:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  15722:                 if ($env{'request.course.sec'} ne '') { 
                   15723:                     if ($expire_role_result eq 'refused') {
                   15724:                         my @roles = ('st');
                   15725:                         my @statuses = ('previous');
                   15726:                         my @roledoms = ($one);
                   15727:                         my $withsec = 1;
                   15728:                         my %roleshash = 
                   15729:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   15730:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   15731:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   15732:                             my ($oldstart,$oldend) = 
                   15733:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   15734:                             if ($oldend > 0 && $oldend <= $now) {
                   15735:                                 $expire_role_result = 'ok';
                   15736:                             }
                   15737:                         }
                   15738:                     }
                   15739:                 }
1.443     albertel 15740:                 $result = $expire_role_result;
                   15741:             }
                   15742:         }
                   15743:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31  raeburn  15744:             $modify_section_result = 
                   15745:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   15746:                                                            undef,undef,undef,$sec,
                   15747:                                                            $end,$start,'','',$cid,
                   15748:                                                            '',$context,$credits);
1.443     albertel 15749:             if ($modify_section_result =~ /^ok/) {
                   15750:                 if ($secchange == 1) {
1.628     raeburn  15751:                     if ($sec eq '') {
                   15752:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   15753:                     } else {
                   15754:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   15755:                     }
1.443     albertel 15756:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  15757:                     if ($sec eq '') {
                   15758:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   15759:                     } else {
                   15760:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15761:                     }
1.443     albertel 15762:                 } else {
1.628     raeburn  15763:                     if ($sec eq '') {
                   15764:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   15765:                     } else {
                   15766:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15767:                     }
1.443     albertel 15768:                 }
                   15769:             } else {
1.628     raeburn  15770:                 if ($secchange) {       
                   15771:                     $$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;
                   15772:                 } else {
                   15773:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   15774:                 }
1.443     albertel 15775:             }
                   15776:             $result = $modify_section_result;
                   15777:         } elsif ($secchange == 1) {
1.628     raeburn  15778:             if ($oldsec eq '') {
1.1075.2.20  raeburn  15779:                 $$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  15780:             } else {
                   15781:                 $$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;
                   15782:             }
1.626     raeburn  15783:             if ($expire_role_result eq 'refused') {
                   15784:                 my $newsecurl = '/'.$cid;
                   15785:                 $newsecurl =~ s/\_/\//g;
                   15786:                 if ($sec ne '') {
                   15787:                     $newsecurl.='/'.$sec;
                   15788:                 }
                   15789:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   15790:                     if ($sec eq '') {
                   15791:                         $$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;
                   15792:                     } else {
                   15793:                         $$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;
                   15794:                     }
                   15795:                 }
                   15796:             }
1.443     albertel 15797:         }
                   15798:     } else {
1.626     raeburn  15799:         $$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 15800:         $result = "error: incomplete course id\n";
                   15801:     }
                   15802:     return $result;
                   15803: }
                   15804: 
1.1075.2.25  raeburn  15805: sub show_role_extent {
                   15806:     my ($scope,$context,$role) = @_;
                   15807:     $scope =~ s{^/}{};
                   15808:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   15809:     push(@courseroles,'co');
                   15810:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   15811:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   15812:         $scope =~ s{/}{_};
                   15813:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   15814:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   15815:         my ($audom,$auname) = split(/\//,$scope);
                   15816:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   15817:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   15818:     } else {
                   15819:         $scope =~ s{/$}{};
                   15820:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   15821:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   15822:     }
                   15823: }
                   15824: 
1.443     albertel 15825: ############################################################
                   15826: ############################################################
                   15827: 
1.566     albertel 15828: sub check_clone {
1.578     raeburn  15829:     my ($args,$linefeed) = @_;
1.566     albertel 15830:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   15831:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   15832:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1075.2.161.  .1(raebu 15833:21):     my $clonetitle;
                   15834:21):     my @clonemsg;
1.566     albertel 15835:     my $can_clone = 0;
1.944     raeburn  15836:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  15837:     if ($lctype ne 'community') {
                   15838:         $lctype = 'course';
                   15839:     }
1.566     albertel 15840:     if ($clonehome eq 'no_host') {
1.944     raeburn  15841:         if ($args->{'crstype'} eq 'Community') {
1.1075.2.161.  .1(raebu 15842:21):             push(@clonemsg,({
                   15843:21):                               mt => 'No new community created.',
                   15844:21):                               args => [],
                   15845:21):                             },
                   15846:21):                             {
                   15847:21):                               mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
                   15848:21):                               args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
                   15849:21):                             }));
1.908     raeburn  15850:         } else {
1.1075.2.161.  .1(raebu 15851:21):             push(@clonemsg,({
                   15852:21):                               mt => 'No new course created.',
                   15853:21):                               args => [],
                   15854:21):                             },
                   15855:21):                             {
                   15856:21):                               mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
                   15857:21):                               args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   15858:21):                             }));
                   15859:21):         }
1.566     albertel 15860:     } else {
                   15861: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1075.2.161.  .1(raebu 15862:21):         $clonetitle = $clonedesc{'description'};
1.944     raeburn  15863:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15864:             if ($clonedesc{'type'} ne 'Community') {
1.1075.2.161.  .1(raebu 15865:21):                 push(@clonemsg,({
                   15866:21):                                   mt => 'No new community created.',
                   15867:21):                                   args => [],
                   15868:21):                                 },
                   15869:21):                                 {
                   15870:21):                                   mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
                   15871:21):                                   args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   15872:21):                                 }));
                   15873:21):                 return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908     raeburn  15874:             }
                   15875:         }
1.1075.2.119  raeburn  15876: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  15877:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 15878: 	    $can_clone = 1;
                   15879: 	} else {
1.1075.2.95  raeburn  15880: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 15881: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1075.2.95  raeburn  15882:             if ($clonehash{'cloners'} eq '') {
                   15883:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   15884:                 if ($domdefs{'canclone'}) {
                   15885:                     unless ($domdefs{'canclone'} eq 'none') {
                   15886:                         if ($domdefs{'canclone'} eq 'domain') {
                   15887:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   15888:                                 $can_clone = 1;
                   15889:                             }
                   15890:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15891:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   15892:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   15893:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   15894:                                 $can_clone = 1;
                   15895:                             }
                   15896:                         }
                   15897:                     }
1.908     raeburn  15898:                 }
1.1075.2.95  raeburn  15899:             } else {
                   15900: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   15901:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  15902:                     $can_clone = 1;
1.1075.2.95  raeburn  15903:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  15904:                     $can_clone = 1;
1.1075.2.96  raeburn  15905:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   15906:                     $can_clone = 1;
1.1075.2.95  raeburn  15907:                 }
                   15908:                 unless ($can_clone) {
1.1075.2.96  raeburn  15909:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15910:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1075.2.95  raeburn  15911:                         my (%gotdomdefaults,%gotcodedefaults);
                   15912:                         foreach my $cloner (@cloners) {
                   15913:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   15914:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   15915:                                 my (%codedefaults,@code_order);
                   15916:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   15917:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   15918:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   15919:                                     }
                   15920:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   15921:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   15922:                                     }
                   15923:                                 } else {
                   15924:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   15925:                                                                             \%codedefaults,
                   15926:                                                                             \@code_order);
                   15927:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   15928:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   15929:                                 }
                   15930:                                 if (@code_order > 0) {
                   15931:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   15932:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   15933:                                                                                 $args->{'crscode'})) {
                   15934:                                         $can_clone = 1;
                   15935:                                         last;
                   15936:                                     }
                   15937:                                 }
                   15938:                             }
                   15939:                         }
                   15940:                     }
1.1075.2.96  raeburn  15941:                 }
                   15942:             }
                   15943:             unless ($can_clone) {
                   15944:                 my $ccrole = 'cc';
                   15945:                 if ($args->{'crstype'} eq 'Community') {
                   15946:                     $ccrole = 'co';
                   15947:                 }
                   15948:                 my %roleshash =
                   15949:                     &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   15950:                                                   $args->{'ccdomain'},
                   15951:                                                   'userroles',['active'],[$ccrole],
                   15952:                                                   [$args->{'clonedomain'}]);
                   15953:                 if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   15954:                     $can_clone = 1;
                   15955:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   15956:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   15957:                     $can_clone = 1;
1.1075.2.95  raeburn  15958:                 }
                   15959:             }
                   15960:             unless ($can_clone) {
                   15961:                 if ($args->{'crstype'} eq 'Community') {
1.1075.2.161.  .1(raebu 15962:21):                     push(@clonemsg,({
                   15963:21):                                       mt => 'No new community created.',
                   15964:21):                                       args => [],
                   15965:21):                                     },
                   15966:21):                                     {
                   15967: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]).',
                   15968:21):                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   15969:21):                                     }));
1.1075.2.95  raeburn  15970:                 } else {
1.1075.2.161.  .1(raebu 15971:21):                     push(@clonemsg,({
                   15972:21):                                       mt => 'No new course created.',
                   15973:21):                                       args => [],
                   15974:21):                                     },
                   15975:21):                                     {
                   15976: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]).',
                   15977:21):                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   15978:21):                                     }));
1.578     raeburn  15979: 	        }
1.566     albertel 15980: 	    }
1.578     raeburn  15981:         }
1.566     albertel 15982:     }
1.1075.2.161.  .1(raebu 15983:21):     return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566     albertel 15984: }
                   15985: 
1.444     albertel 15986: sub construct_course {
1.1075.2.119  raeburn  15987:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1075.2.161.  .1(raebu 15988:21):         $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
                   15989:21):     my ($outcome,$msgref,$clonemsgref);
1.541     raeburn  15990:     my $linefeed =  '<br />'."\n";
                   15991:     if ($context eq 'auto') {
                   15992:         $linefeed = "\n";
                   15993:     }
1.566     albertel 15994: 
                   15995: #
                   15996: # Are we cloning?
                   15997: #
1.1075.2.161.  .1(raebu 15998:21):     my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566     albertel 15999:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1075.2.161.  .1(raebu 16000:21): 	($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566     albertel 16001:         if (!$can_clone) {
1.1075.2.161.  .1(raebu 16002:21): 	    return (0,$outcome,$clonemsgref);
1.566     albertel 16003: 	}
                   16004:     }
                   16005: 
1.444     albertel 16006: #
                   16007: # Open course
                   16008: #
                   16009:     my $crstype = lc($args->{'crstype'});
                   16010:     my %cenv=();
                   16011:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   16012:                                              $args->{'cdescr'},
                   16013:                                              $args->{'curl'},
                   16014:                                              $args->{'course_home'},
                   16015:                                              $args->{'nonstandard'},
                   16016:                                              $args->{'crscode'},
                   16017:                                              $args->{'ccuname'}.':'.
                   16018:                                              $args->{'ccdomain'},
1.882     raeburn  16019:                                              $args->{'crstype'},
1.1075.2.161.  .1(raebu 16020:21):                                              $cnum,$context,$category,
                   16021:21):                                              $callercontext);
1.444     albertel 16022: 
                   16023:     # Note: The testing routines depend on this being output; see 
                   16024:     # Utils::Course. This needs to at least be output as a comment
                   16025:     # if anyone ever decides to not show this, and Utils::Course::new
                   16026:     # will need to be suitably modified.
1.1075.2.161.  .1(raebu 16027:21):     if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   16028:21):         $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
                   16029:21):     } else {
                   16030:21):         $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
                   16031:21):     }
1.943     raeburn  16032:     if ($$courseid =~ /^error:/) {
1.1075.2.161.  .1(raebu 16033:21):         return (0,$outcome,$clonemsgref);
1.943     raeburn  16034:     }
                   16035: 
1.444     albertel 16036: #
                   16037: # Check if created correctly
                   16038: #
1.479     albertel 16039:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 16040:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  16041:     if ($crsuhome eq 'no_host') {
1.1075.2.161.  .1(raebu 16042:21):         if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   16043:21):             $outcome .= &mt_user($user_lh,
                   16044:21):                             'Course creation failed, unrecognized course home server.');
                   16045:21):         } else {
                   16046:21):             $outcome .= &mt('Course creation failed, unrecognized course home server.');
                   16047:21):         }
                   16048:21):         $outcome .= $linefeed;
                   16049:21):         return (0,$outcome,$clonemsgref);
1.943     raeburn  16050:     }
1.541     raeburn  16051:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 16052: 
1.444     albertel 16053: #
1.566     albertel 16054: # Do the cloning
1.1075.2.161.  .1(raebu 16055:21): #
                   16056:21):     my @clonemsg;
1.566     albertel 16057:     if ($can_clone && $cloneid) {
1.1075.2.161.  .1(raebu 16058:21):         push(@clonemsg,
                   16059:21):                       {
                   16060:21):                           mt => 'Created [_1] by cloning from [_2]',
                   16061:21):                           args => [$crstype,$clonetitle],
                   16062:21):                       });
1.566     albertel 16063: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 16064: # Copy all files
1.1075.2.161.  .1(raebu 16065:21):         my @info =
                   16066:21):             &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
                   16067:21):                                                      $args->{'dateshift'},$args->{'crscode'},
                   16068:21):                                                      $args->{'ccuname'}.':'.$args->{'ccdomain'},
                   16069:21):                                                      $args->{'tinyurls'});
                   16070:21):         if (@info) {
                   16071:21):             push(@clonemsg,@info);
                   16072:21):         }
1.444     albertel 16073: # Restore URL
1.566     albertel 16074: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 16075: # Restore title
1.566     albertel 16076: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  16077: # Restore creation date, creator and creation context.
                   16078:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   16079:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   16080:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 16081: # Mark as cloned
1.566     albertel 16082: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      16083: # Need to clone grading mode
                   16084:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   16085:         $cenv{'grading'}=$newenv{'grading'};
                   16086: # Do not clone these environment entries
                   16087:         &Apache::lonnet::del('environment',
                   16088:                   ['default_enrollment_start_date',
                   16089:                    'default_enrollment_end_date',
                   16090:                    'question.email',
                   16091:                    'policy.email',
                   16092:                    'comment.email',
                   16093:                    'pch.users.denied',
1.725     raeburn  16094:                    'plc.users.denied',
                   16095:                    'hidefromcat',
1.1075.2.36  raeburn  16096:                    'checkforpriv',
1.1075.2.158  raeburn  16097:                    'categories'],
1.638     www      16098:                    $$crsudom,$$crsunum);
1.1075.2.63  raeburn  16099:         if ($args->{'textbook'}) {
                   16100:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   16101:         }
1.444     albertel 16102:     }
1.566     albertel 16103: 
1.444     albertel 16104: #
                   16105: # Set environment (will override cloned, if existing)
                   16106: #
                   16107:     my @sections = ();
                   16108:     my @xlists = ();
                   16109:     if ($args->{'crstype'}) {
                   16110:         $cenv{'type'}=$args->{'crstype'};
                   16111:     }
                   16112:     if ($args->{'crsid'}) {
                   16113:         $cenv{'courseid'}=$args->{'crsid'};
                   16114:     }
                   16115:     if ($args->{'crscode'}) {
                   16116:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   16117:     }
                   16118:     if ($args->{'crsquota'} ne '') {
                   16119:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   16120:     } else {
                   16121:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   16122:     }
                   16123:     if ($args->{'ccuname'}) {
                   16124:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   16125:                                         ':'.$args->{'ccdomain'};
                   16126:     } else {
                   16127:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   16128:     }
1.1075.2.31  raeburn  16129:     if ($args->{'defaultcredits'}) {
                   16130:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   16131:     }
1.444     albertel 16132:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   16133:     if ($args->{'crssections'}) {
                   16134:         $cenv{'internal.sectionnums'} = '';
                   16135:         if ($args->{'crssections'} =~ m/,/) {
                   16136:             @sections = split/,/,$args->{'crssections'};
                   16137:         } else {
                   16138:             $sections[0] = $args->{'crssections'};
                   16139:         }
                   16140:         if (@sections > 0) {
                   16141:             foreach my $item (@sections) {
                   16142:                 my ($sec,$gp) = split/:/,$item;
                   16143:                 my $class = $args->{'crscode'}.$sec;
                   16144:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   16145:                 $cenv{'internal.sectionnums'} .= $item.',';
                   16146:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  16147:                     push(@badclasses,$class);
1.444     albertel 16148:                 }
                   16149:             }
                   16150:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   16151:         }
                   16152:     }
                   16153: # do not hide course coordinator from staff listing, 
                   16154: # even if privileged
                   16155:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36  raeburn  16156: # add course coordinator's domain to domains to check for privileged users
                   16157: # if different to course domain
                   16158:     if ($$crsudom ne $args->{'ccdomain'}) {
                   16159:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   16160:     }
1.444     albertel 16161: # add crosslistings
                   16162:     if ($args->{'crsxlist'}) {
                   16163:         $cenv{'internal.crosslistings'}='';
                   16164:         if ($args->{'crsxlist'} =~ m/,/) {
                   16165:             @xlists = split/,/,$args->{'crsxlist'};
                   16166:         } else {
                   16167:             $xlists[0] = $args->{'crsxlist'};
                   16168:         }
                   16169:         if (@xlists > 0) {
                   16170:             foreach my $item (@xlists) {
                   16171:                 my ($xl,$gp) = split/:/,$item;
                   16172:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   16173:                 $cenv{'internal.crosslistings'} .= $item.',';
                   16174:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  16175:                     push(@badclasses,$xl);
1.444     albertel 16176:                 }
                   16177:             }
                   16178:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   16179:         }
                   16180:     }
                   16181:     if ($args->{'autoadds'}) {
                   16182:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   16183:     }
                   16184:     if ($args->{'autodrops'}) {
                   16185:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   16186:     }
                   16187: # check for notification of enrollment changes
                   16188:     my @notified = ();
                   16189:     if ($args->{'notify_owner'}) {
                   16190:         if ($args->{'ccuname'} ne '') {
                   16191:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   16192:         }
                   16193:     }
                   16194:     if ($args->{'notify_dc'}) {
                   16195:         if ($uname ne '') { 
1.630     raeburn  16196:             push(@notified,$uname.':'.$udom);
1.444     albertel 16197:         }
                   16198:     }
                   16199:     if (@notified > 0) {
                   16200:         my $notifylist;
                   16201:         if (@notified > 1) {
                   16202:             $notifylist = join(',',@notified);
                   16203:         } else {
                   16204:             $notifylist = $notified[0];
                   16205:         }
                   16206:         $cenv{'internal.notifylist'} = $notifylist;
                   16207:     }
                   16208:     if (@badclasses > 0) {
                   16209:         my %lt=&Apache::lonlocal::texthash(
1.1075.2.119  raeburn  16210:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   16211:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   16212:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 16213:         );
1.1075.2.119  raeburn  16214:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   16215:                            &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  16216:         if ($context eq 'auto') {
                   16217:             $outcome .= $badclass_msg.$linefeed;
1.1075.2.119  raeburn  16218:         } else {
1.566     albertel 16219:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1075.2.119  raeburn  16220:         }
                   16221:         foreach my $item (@badclasses) {
1.541     raeburn  16222:             if ($context eq 'auto') {
1.1075.2.119  raeburn  16223:                 $outcome .= " - $item\n";
1.541     raeburn  16224:             } else {
1.1075.2.119  raeburn  16225:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  16226:             }
1.1075.2.119  raeburn  16227:         }
                   16228:         if ($context eq 'auto') {
                   16229:             $outcome .= $linefeed;
                   16230:         } else {
                   16231:             $outcome .= "</ul><br /><br /></div>\n";
                   16232:         }
1.444     albertel 16233:     }
                   16234:     if ($args->{'no_end_date'}) {
                   16235:         $args->{'endaccess'} = 0;
                   16236:     }
                   16237:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   16238:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   16239:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   16240:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   16241:     if ($args->{'showphotos'}) {
                   16242:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   16243:     }
                   16244:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   16245:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   16246:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   16247:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  16248:             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'); 
                   16249:             if ($context eq 'auto') {
                   16250:                 $outcome .= $krb_msg;
                   16251:             } else {
1.566     albertel 16252:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  16253:             }
                   16254:             $outcome .= $linefeed;
1.444     albertel 16255:         }
                   16256:     }
                   16257:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   16258:        if ($args->{'setpolicy'}) {
                   16259:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   16260:        }
                   16261:        if ($args->{'setcontent'}) {
                   16262:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   16263:        }
1.1075.2.110  raeburn  16264:        if ($args->{'setcomment'}) {
                   16265:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   16266:        }
1.444     albertel 16267:     }
                   16268:     if ($args->{'reshome'}) {
                   16269: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   16270: 	$cenv{'reshome'}=~s/\/+$/\//;
                   16271:     }
                   16272: #
                   16273: # course has keyed access
                   16274: #
                   16275:     if ($args->{'setkeys'}) {
                   16276:        $cenv{'keyaccess'}='yes';
                   16277:     }
                   16278: # if specified, key authority is not course, but user
                   16279: # only active if keyaccess is yes
                   16280:     if ($args->{'keyauth'}) {
1.487     albertel 16281: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   16282: 	$user = &LONCAPA::clean_username($user);
                   16283: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     16284: 	if ($user ne '' && $domain ne '') {
1.487     albertel 16285: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 16286: 	}
                   16287:     }
                   16288: 
1.1075.2.59  raeburn  16289: #
                   16290: #  generate and store uniquecode (available to course requester), if course should have one.
                   16291: #
                   16292:     if ($args->{'uniquecode'}) {
                   16293:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   16294:         if ($code) {
                   16295:             $cenv{'internal.uniquecode'} = $code;
                   16296:             my %crsinfo =
                   16297:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   16298:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   16299:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   16300:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   16301:             }
                   16302:             if (ref($coderef)) {
                   16303:                 $$coderef = $code;
                   16304:             }
                   16305:         }
                   16306:     }
                   16307: 
1.444     albertel 16308:     if ($args->{'disresdis'}) {
                   16309:         $cenv{'pch.roles.denied'}='st';
                   16310:     }
                   16311:     if ($args->{'disablechat'}) {
                   16312:         $cenv{'plc.roles.denied'}='st';
                   16313:     }
                   16314: 
                   16315:     # Record we've not yet viewed the Course Initialization Helper for this 
                   16316:     # course
                   16317:     $cenv{'course.helper.not.run'} = 1;
                   16318:     #
                   16319:     # Use new Randomseed
                   16320:     #
                   16321:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   16322:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   16323:     #
                   16324:     # The encryption code and receipt prefix for this course
                   16325:     #
                   16326:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   16327:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   16328:     #
                   16329:     # By default, use standard grading
                   16330:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   16331: 
1.541     raeburn  16332:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   16333:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 16334: #
                   16335: # Open all assignments
                   16336: #
                   16337:     if ($args->{'openall'}) {
1.1075.2.146  raeburn  16338:        my $opendate = time;
                   16339:        if ($args->{'openallfrom'} =~ /^\d+$/) {
                   16340:            $opendate = $args->{'openallfrom'};
                   16341:        }
1.444     albertel 16342:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1075.2.146  raeburn  16343:        my %storecontent = ($storeunder         => $opendate,
1.444     albertel 16344:                            $storeunder.'.type' => 'date_start');
1.1075.2.146  raeburn  16345:        $outcome .= &mt('All assignments open starting [_1]',
                   16346:                        &Apache::lonlocal::locallocaltime($opendate)).': '.
                   16347:                    &Apache::lonnet::cput
                   16348:                        ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 16349:    }
                   16350: #
                   16351: # Set first page
                   16352: #
                   16353:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   16354: 	    || ($cloneid)) {
1.445     albertel 16355: 	use LONCAPA::map;
1.444     albertel 16356: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 16357: 
                   16358: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   16359:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   16360: 
1.444     albertel 16361:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   16362:         my $title; my $url;
                   16363:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   16364: 	    $title=&mt('Syllabus');
1.444     albertel 16365:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   16366:         } else {
1.963     raeburn  16367:             $title=&mt('Table of Contents');
1.444     albertel 16368:             $url='/adm/navmaps';
                   16369:         }
1.445     albertel 16370: 
                   16371:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   16372: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   16373: 
                   16374: 	if ($errtext) { $fatal=2; }
1.541     raeburn  16375:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 16376:     }
1.566     albertel 16377: 
1.1075.2.161.  .1(raebu 16378:21):     return (1,$outcome,\@clonemsg);
1.444     albertel 16379: }
                   16380: 
1.1075.2.59  raeburn  16381: sub make_unique_code {
                   16382:     my ($cdom,$cnum) = @_;
                   16383:     # get lock on uniquecodes db
                   16384:     my $lockhash = {
                   16385:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   16386:                                                   ':'.$env{'user.domain'},
                   16387:                    };
                   16388:     my $tries = 0;
                   16389:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   16390:     my ($code,$error);
                   16391: 
                   16392:     while (($gotlock ne 'ok') && ($tries<3)) {
                   16393:         $tries ++;
                   16394:         sleep 1;
                   16395:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   16396:     }
                   16397:     if ($gotlock eq 'ok') {
                   16398:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   16399:         my $gotcode;
                   16400:         my $attempts = 0;
                   16401:         while ((!$gotcode) && ($attempts < 100)) {
                   16402:             $code = &generate_code();
                   16403:             if (!exists($currcodes{$code})) {
                   16404:                 $gotcode = 1;
                   16405:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   16406:                     $error = 'nostore';
                   16407:                 }
                   16408:             }
                   16409:             $attempts ++;
                   16410:         }
                   16411:         my @del_lock = ($cnum."\0".'uniquecodes');
                   16412:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   16413:     } else {
                   16414:         $error = 'nolock';
                   16415:     }
                   16416:     return ($code,$error);
                   16417: }
                   16418: 
                   16419: sub generate_code {
                   16420:     my $code;
                   16421:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   16422:     for (my $i=0; $i<6; $i++) {
                   16423:         my $lettnum = int (rand 2);
                   16424:         my $item = '';
                   16425:         if ($lettnum) {
                   16426:             $item = $letts[int( rand(18) )];
                   16427:         } else {
                   16428:             $item = 1+int( rand(8) );
                   16429:         }
                   16430:         $code .= $item;
                   16431:     }
                   16432:     return $code;
                   16433: }
                   16434: 
1.444     albertel 16435: ############################################################
                   16436: ############################################################
                   16437: 
1.953     droeschl 16438: #SD
                   16439: # only Community and Course, or anything else?
1.378     raeburn  16440: sub course_type {
                   16441:     my ($cid) = @_;
                   16442:     if (!defined($cid)) {
                   16443:         $cid = $env{'request.course.id'};
                   16444:     }
1.404     albertel 16445:     if (defined($env{'course.'.$cid.'.type'})) {
                   16446:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  16447:     } else {
                   16448:         return 'Course';
1.377     raeburn  16449:     }
                   16450: }
1.156     albertel 16451: 
1.406     raeburn  16452: sub group_term {
                   16453:     my $crstype = &course_type();
                   16454:     my %names = (
                   16455:                   'Course' => 'group',
1.865     raeburn  16456:                   'Community' => 'group',
1.406     raeburn  16457:                 );
                   16458:     return $names{$crstype};
                   16459: }
                   16460: 
1.902     raeburn  16461: sub course_types {
1.1075.2.59  raeburn  16462:     my @types = ('official','unofficial','community','textbook');
1.902     raeburn  16463:     my %typename = (
                   16464:                          official   => 'Official course',
                   16465:                          unofficial => 'Unofficial course',
                   16466:                          community  => 'Community',
1.1075.2.59  raeburn  16467:                          textbook   => 'Textbook course',
1.902     raeburn  16468:                    );
                   16469:     return (\@types,\%typename);
                   16470: }
                   16471: 
1.156     albertel 16472: sub icon {
                   16473:     my ($file)=@_;
1.505     albertel 16474:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 16475:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 16476:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 16477:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   16478: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   16479: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   16480: 	            $curfext.".gif") {
                   16481: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   16482: 		$curfext.".gif";
                   16483: 	}
                   16484:     }
1.249     albertel 16485:     return &lonhttpdurl($iconname);
1.154     albertel 16486: } 
1.84      albertel 16487: 
1.575     albertel 16488: sub lonhttpdurl {
1.692     www      16489: #
                   16490: # Had been used for "small fry" static images on separate port 8080.
                   16491: # Modify here if lightweight http functionality desired again.
                   16492: # Currently eliminated due to increasing firewall issues.
                   16493: #
1.575     albertel 16494:     my ($url)=@_;
1.692     www      16495:     return $url;
1.215     albertel 16496: }
                   16497: 
1.213     albertel 16498: sub connection_aborted {
                   16499:     my ($r)=@_;
                   16500:     $r->print(" ");$r->rflush();
                   16501:     my $c = $r->connection;
                   16502:     return $c->aborted();
                   16503: }
                   16504: 
1.221     foxr     16505: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     16506: #    strings as 'strings'.
                   16507: sub escape_single {
1.221     foxr     16508:     my ($input) = @_;
1.223     albertel 16509:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     16510:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   16511:     return $input;
                   16512: }
1.223     albertel 16513: 
1.222     foxr     16514: #  Same as escape_single, but escape's "'s  This 
                   16515: #  can be used for  "strings"
                   16516: sub escape_double {
                   16517:     my ($input) = @_;
                   16518:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   16519:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   16520:     return $input;
                   16521: }
1.223     albertel 16522:  
1.222     foxr     16523: #   Escapes the last element of a full URL.
                   16524: sub escape_url {
                   16525:     my ($url)   = @_;
1.238     raeburn  16526:     my @urlslices = split(/\//, $url,-1);
1.369     www      16527:     my $lastitem = &escape(pop(@urlslices));
1.1075.2.83  raeburn  16528:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     16529: }
1.462     albertel 16530: 
1.820     raeburn  16531: sub compare_arrays {
                   16532:     my ($arrayref1,$arrayref2) = @_;
                   16533:     my (@difference,%count);
                   16534:     @difference = ();
                   16535:     %count = ();
                   16536:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   16537:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   16538:         foreach my $element (keys(%count)) {
                   16539:             if ($count{$element} == 1) {
                   16540:                 push(@difference,$element);
                   16541:             }
                   16542:         }
                   16543:     }
                   16544:     return @difference;
                   16545: }
                   16546: 
1.1075.2.152  raeburn  16547: sub lon_status_items {
                   16548:     my %defaults = (
                   16549:                      E         => 100,
                   16550:                      W         => 4,
                   16551:                      N         => 1,
                   16552:                      U         => 5,
                   16553:                      threshold => 200,
                   16554:                      sysmail   => 2500,
                   16555:                    );
                   16556:     my %names = (
                   16557:                    E => 'Errors',
                   16558:                    W => 'Warnings',
                   16559:                    N => 'Notices',
                   16560:                    U => 'Unsent',
                   16561:                 );
                   16562:     return (\%defaults,\%names);
                   16563: }
                   16564: 
1.817     bisitz   16565: # -------------------------------------------------------- Initialize user login
1.462     albertel 16566: sub init_user_environment {
1.463     albertel 16567:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 16568:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   16569: 
                   16570:     my $public=($username eq 'public' && $domain eq 'public');
                   16571: 
                   16572: # See if old ID present, if so, remove
                   16573: 
1.1062    raeburn  16574:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 16575:     my $now=time;
                   16576: 
                   16577:     if ($public) {
                   16578: 	my $max_public=100;
                   16579: 	my $oldest;
                   16580: 	my $oldest_time=0;
                   16581: 	for(my $next=1;$next<=$max_public;$next++) {
                   16582: 	    if (-e $lonids."/publicuser_$next.id") {
                   16583: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   16584: 		if ($mtime<$oldest_time || !$oldest_time) {
                   16585: 		    $oldest_time=$mtime;
                   16586: 		    $oldest=$next;
                   16587: 		}
                   16588: 	    } else {
                   16589: 		$cookie="publicuser_$next";
                   16590: 		last;
                   16591: 	    }
                   16592: 	}
                   16593: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   16594:     } else {
1.463     albertel 16595: 	# if this isn't a robot, kill any existing non-robot sessions
                   16596: 	if (!$args->{'robot'}) {
                   16597: 	    opendir(DIR,$lonids);
                   16598: 	    while ($filename=readdir(DIR)) {
                   16599: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1075.2.136  raeburn  16600:                     if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
                   16601:                             &GDBM_READER(),0640)) {
                   16602:                         my $linkedfile;
                   16603:                         if (exists($oldenv{'user.linkedenv'})) {
                   16604:                             $linkedfile = $oldenv{'user.linkedenv'};
                   16605:                         }
                   16606:                         untie(%oldenv);
                   16607:                         if (unlink("$lonids/$filename")) {
                   16608:                             if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                   16609:                                 if (-l "$lonids/$linkedfile.id") {
                   16610:                                     unlink("$lonids/$linkedfile.id");
                   16611:                                 }
                   16612:                             }
                   16613:                         }
                   16614:                     } else {
                   16615:                         unlink($lonids.'/'.$filename);
                   16616:                     }
1.463     albertel 16617: 		}
1.462     albertel 16618: 	    }
1.463     albertel 16619: 	    closedir(DIR);
1.1075.2.84  raeburn  16620: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   16621:             my $namespace = 'nohist_courseeditor';
                   16622:             my $lockingkey = 'paste'."\0".'locked_num';
                   16623:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   16624:                                                 $domain,$username);
                   16625:             if (exists($lockhash{$lockingkey})) {
                   16626:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   16627:                 unless ($delresult eq 'ok') {
                   16628:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   16629:                 }
                   16630:             }
1.462     albertel 16631: 	}
                   16632: # Give them a new cookie
1.463     albertel 16633: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      16634: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 16635: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 16636:     
                   16637: # Initialize roles
                   16638: 
1.1062    raeburn  16639: 	($userroles,$firstaccenv,$timerintenv) = 
                   16640:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 16641:     }
                   16642: # ------------------------------------ Check browser type and MathML capability
                   16643: 
1.1075.2.77  raeburn  16644:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   16645:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 16646: 
                   16647: # ------------------------------------------------------------- Get environment
                   16648: 
                   16649:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   16650:     my ($tmp) = keys(%userenv);
                   16651:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   16652:     } else {
                   16653: 	undef(%userenv);
                   16654:     }
                   16655:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   16656: 	$form->{'interface'}=$userenv{'interface'};
                   16657:     }
                   16658:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   16659: 
                   16660: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   16661:     foreach my $option ('interface','localpath','localres') {
                   16662:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 16663:     }
                   16664: # --------------------------------------------------------- Write first profile
                   16665: 
                   16666:     {
1.1075.2.150  raeburn  16667:         my $ip = &Apache::lonnet::get_requestor_ip();
1.462     albertel 16668: 	my %initial_env = 
                   16669: 	    ("user.name"          => $username,
                   16670: 	     "user.domain"        => $domain,
                   16671: 	     "user.home"          => $authhost,
                   16672: 	     "browser.type"       => $clientbrowser,
                   16673: 	     "browser.version"    => $clientversion,
                   16674: 	     "browser.mathml"     => $clientmathml,
                   16675: 	     "browser.unicode"    => $clientunicode,
                   16676: 	     "browser.os"         => $clientos,
1.1075.2.42  raeburn  16677:              "browser.mobile"     => $clientmobile,
                   16678:              "browser.info"       => $clientinfo,
1.1075.2.77  raeburn  16679:              "browser.osversion"  => $clientosversion,
1.462     albertel 16680: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   16681: 	     "request.course.fn"  => '',
                   16682: 	     "request.course.uri" => '',
                   16683: 	     "request.course.sec" => '',
                   16684: 	     "request.role"       => 'cm',
                   16685: 	     "request.role.adv"   => $env{'user.adv'},
1.1075.2.150  raeburn  16686: 	     "request.host"       => $ip,);
1.462     albertel 16687: 
                   16688:         if ($form->{'localpath'}) {
                   16689: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   16690: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   16691:         }
                   16692: 	
                   16693: 	if ($form->{'interface'}) {
                   16694: 	    $form->{'interface'}=~s/\W//gs;
                   16695: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   16696: 	    $env{'browser.interface'}=$form->{'interface'};
                   16697: 	}
                   16698: 
1.1075.2.54  raeburn  16699:         if ($form->{'iptoken'}) {
                   16700:             my $lonhost = $r->dir_config('lonHostID');
                   16701:             $initial_env{"user.noloadbalance"} = $lonhost;
                   16702:             $env{'user.noloadbalance'} = $lonhost;
                   16703:         }
                   16704: 
1.1075.2.120  raeburn  16705:         if ($form->{'noloadbalance'}) {
                   16706:             my @hosts = &Apache::lonnet::current_machine_ids();
                   16707:             my $hosthere = $form->{'noloadbalance'};
                   16708:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   16709:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   16710:                 $env{'user.noloadbalance'} = $hosthere;
                   16711:             }
                   16712:         }
                   16713: 
1.1016    raeburn  16714:         unless ($domain eq 'public') {
1.1075.2.125  raeburn  16715:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   16716:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
1.980     raeburn  16717: 
1.1075.2.125  raeburn  16718:             foreach my $tool ('aboutme','blog','webdav','portfolio') {
                   16719:                 $userenv{'availabletools.'.$tool} = 
                   16720:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   16721:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   16722:             }
1.724     raeburn  16723: 
1.1075.2.125  raeburn  16724:             foreach my $crstype ('official','unofficial','community','textbook') {
                   16725:                 $userenv{'canrequest.'.$crstype} =
                   16726:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   16727:                                                       'reload','requestcourses',
                   16728:                                                       \%userenv,\%domdef,\%is_adv);
                   16729:             }
1.765     raeburn  16730: 
1.1075.2.125  raeburn  16731:             $userenv{'canrequest.author'} =
                   16732:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   16733:                                                   'reload','requestauthor',
                   16734:                                                   \%userenv,\%domdef,\%is_adv);
                   16735:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   16736:                                                  $domain,$username);
                   16737:             my $reqstatus = $reqauthor{'author_status'};
                   16738:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
                   16739:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   16740:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   16741:                                                       $reqauthor{'author'}{'timestamp'};
                   16742:                 }
1.1075.2.14  raeburn  16743:             }
                   16744:         }
                   16745: 
1.462     albertel 16746: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  16747: 
1.462     albertel 16748: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   16749: 		 &GDBM_WRCREAT(),0640)) {
                   16750: 	    &_add_to_env(\%disk_env,\%initial_env);
                   16751: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   16752: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  16753:             if (ref($firstaccenv) eq 'HASH') {
                   16754:                 &_add_to_env(\%disk_env,$firstaccenv);
                   16755:             }
                   16756:             if (ref($timerintenv) eq 'HASH') {
                   16757:                 &_add_to_env(\%disk_env,$timerintenv);
                   16758:             }
1.463     albertel 16759: 	    if (ref($args->{'extra_env'})) {
                   16760: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   16761: 	    }
1.462     albertel 16762: 	    untie(%disk_env);
                   16763: 	} else {
1.705     tempelho 16764: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   16765: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 16766: 	    return 'error: '.$!;
                   16767: 	}
                   16768:     }
                   16769:     $env{'request.role'}='cm';
                   16770:     $env{'request.role.adv'}=$env{'user.adv'};
                   16771:     $env{'browser.type'}=$clientbrowser;
                   16772: 
                   16773:     return $cookie;
                   16774: 
                   16775: }
                   16776: 
                   16777: sub _add_to_env {
                   16778:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  16779:     if (ref($env_data) eq 'HASH') {
                   16780:         while (my ($key,$value) = each(%$env_data)) {
                   16781: 	    $idf->{$prefix.$key} = $value;
                   16782: 	    $env{$prefix.$key}   = $value;
                   16783:         }
1.462     albertel 16784:     }
                   16785: }
                   16786: 
1.685     tempelho 16787: # --- Get the symbolic name of a problem and the url
                   16788: sub get_symb {
                   16789:     my ($request,$silent) = @_;
1.726     raeburn  16790:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 16791:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   16792:     if ($symb eq '') {
                   16793:         if (!$silent) {
1.1071    raeburn  16794:             if (ref($request)) { 
                   16795:                 $request->print("Unable to handle ambiguous references:$url:.");
                   16796:             }
1.685     tempelho 16797:             return ();
                   16798:         }
                   16799:     }
                   16800:     &Apache::lonenc::check_decrypt(\$symb);
                   16801:     return ($symb);
                   16802: }
                   16803: 
                   16804: # --------------------------------------------------------------Get annotation
                   16805: 
                   16806: sub get_annotation {
                   16807:     my ($symb,$enc) = @_;
                   16808: 
                   16809:     my $key = $symb;
                   16810:     if (!$enc) {
                   16811:         $key =
                   16812:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   16813:     }
                   16814:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   16815:     return $annotation{$key};
                   16816: }
                   16817: 
                   16818: sub clean_symb {
1.731     raeburn  16819:     my ($symb,$delete_enc) = @_;
1.685     tempelho 16820: 
                   16821:     &Apache::lonenc::check_decrypt(\$symb);
                   16822:     my $enc = $env{'request.enc'};
1.731     raeburn  16823:     if ($delete_enc) {
1.730     raeburn  16824:         delete($env{'request.enc'});
                   16825:     }
1.685     tempelho 16826: 
                   16827:     return ($symb,$enc);
                   16828: }
1.462     albertel 16829: 
1.1075.2.69  raeburn  16830: ############################################################
                   16831: ############################################################
                   16832: 
                   16833: =pod
                   16834: 
                   16835: =head1 Routines for building display used to search for courses
                   16836: 
                   16837: 
                   16838: =over 4
                   16839: 
                   16840: =item * &build_filters()
                   16841: 
                   16842: Create markup for a table used to set filters to use when selecting
                   16843: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   16844: and quotacheck.pl
                   16845: 
                   16846: 
                   16847: Inputs:
                   16848: 
                   16849: filterlist - anonymous array of fields to include as potential filters
                   16850: 
                   16851: crstype - course type
                   16852: 
                   16853: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   16854:               to pop-open a course selector (will contain "extra element").
                   16855: 
                   16856: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   16857: 
                   16858: filter - anonymous hash of criteria and their values
                   16859: 
                   16860: action - form action
                   16861: 
                   16862: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   16863: 
                   16864: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
                   16865: 
                   16866: cloneruname - username of owner of new course who wants to clone
                   16867: 
                   16868: clonerudom - domain of owner of new course who wants to clone
                   16869: 
                   16870: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
                   16871: 
                   16872: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   16873: 
                   16874: codedom - domain
                   16875: 
                   16876: formname - value of form element named "form".
                   16877: 
                   16878: fixeddom - domain, if fixed.
                   16879: 
                   16880: prevphase - value to assign to form element named "phase" when going back to the previous screen
                   16881: 
                   16882: cnameelement - name of form element in form on opener page which will receive title of selected course
                   16883: 
                   16884: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   16885: 
                   16886: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   16887: 
                   16888: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   16889: 
                   16890: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   16891: 
                   16892: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   16893: 
                   16894: 
                   16895: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   16896: 
                   16897: 
                   16898: Side Effects: None
                   16899: 
                   16900: =cut
                   16901: 
                   16902: # ---------------------------------------------- search for courses based on last activity etc.
                   16903: 
                   16904: sub build_filters {
                   16905:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   16906:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   16907:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   16908:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   16909:         $clonetext,$clonewarning) = @_;
                   16910:     my ($list,$jscript);
                   16911:     my $onchange = 'javascript:updateFilters(this)';
                   16912:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   16913:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   16914:         $typeselectform,$instcodetitle);
                   16915:     if ($formname eq '') {
                   16916:         $formname = $caller;
                   16917:     }
                   16918:     foreach my $item (@{$filterlist}) {
                   16919:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   16920:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   16921:             if ($item eq 'domainfilter') {
                   16922:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   16923:             } elsif ($item eq 'coursefilter') {
                   16924:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   16925:             } elsif ($item eq 'ownerfilter') {
                   16926:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16927:             } elsif ($item eq 'ownerdomfilter') {
                   16928:                 $filter->{'ownerdomfilter'} =
                   16929:                     &LONCAPA::clean_domain($filter->{$item});
                   16930:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   16931:                                                        'ownerdomfilter',1);
                   16932:             } elsif ($item eq 'personfilter') {
                   16933:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16934:             } elsif ($item eq 'persondomfilter') {
                   16935:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   16936:                                                         'persondomfilter',1);
                   16937:             } else {
                   16938:                 $filter->{$item} =~ s/\W//g;
                   16939:             }
                   16940:             if (!$filter->{$item}) {
                   16941:                 $filter->{$item} = '';
                   16942:             }
                   16943:         }
                   16944:         if ($item eq 'domainfilter') {
                   16945:             my $allow_blank = 1;
                   16946:             if ($formname eq 'portform') {
                   16947:                 $allow_blank=0;
                   16948:             } elsif ($formname eq 'studentform') {
                   16949:                 $allow_blank=0;
                   16950:             }
                   16951:             if ($fixeddom) {
                   16952:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   16953:                                     ' value="'.$codedom.'" />'.
                   16954:                                     &Apache::lonnet::domain($codedom,'description');
                   16955:             } else {
                   16956:                 $domainselectform = &select_dom_form($filter->{$item},
                   16957:                                                      'domainfilter',
                   16958:                                                       $allow_blank,'',$onchange);
                   16959:             }
                   16960:         } else {
                   16961:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   16962:         }
                   16963:     }
                   16964: 
                   16965:     # last course activity filter and selection
                   16966:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   16967: 
                   16968:     # course created filter and selection
                   16969:     if (exists($filter->{'createdfilter'})) {
                   16970:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   16971:     }
                   16972: 
                   16973:     my %lt = &Apache::lonlocal::texthash(
                   16974:                 'cac' => "$crstype Activity",
                   16975:                 'ccr' => "$crstype Created",
                   16976:                 'cde' => "$crstype Title",
                   16977:                 'cdo' => "$crstype Domain",
                   16978:                 'ins' => 'Institutional Code',
                   16979:                 'inc' => 'Institutional Categorization',
                   16980:                 'cow' => "$crstype Owner/Co-owner",
                   16981:                 'cop' => "$crstype Personnel Includes",
                   16982:                 'cog' => 'Type',
                   16983:              );
                   16984: 
                   16985:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16986:         my $typeval = 'Course';
                   16987:         if ($crstype eq 'Community') {
                   16988:             $typeval = 'Community';
                   16989:         }
                   16990:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   16991:     } else {
                   16992:         $typeselectform =  '<select name="type" size="1"';
                   16993:         if ($onchange) {
                   16994:             $typeselectform .= ' onchange="'.$onchange.'"';
                   16995:         }
                   16996:         $typeselectform .= '>'."\n";
                   16997:         foreach my $posstype ('Course','Community') {
                   16998:             $typeselectform.='<option value="'.$posstype.'"'.
                   16999:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
                   17000:         }
                   17001:         $typeselectform.="</select>";
                   17002:     }
                   17003: 
                   17004:     my ($cloneableonlyform,$cloneabletitle);
                   17005:     if (exists($filter->{'cloneableonly'})) {
                   17006:         my $cloneableon = '';
                   17007:         my $cloneableoff = ' checked="checked"';
                   17008:         if ($filter->{'cloneableonly'}) {
                   17009:             $cloneableon = $cloneableoff;
                   17010:             $cloneableoff = '';
                   17011:         }
                   17012:         $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>';
                   17013:         if ($formname eq 'ccrs') {
1.1075.2.71  raeburn  17014:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1075.2.69  raeburn  17015:         } else {
                   17016:             $cloneabletitle = &mt('Cloneable by you');
                   17017:         }
                   17018:     }
                   17019:     my $officialjs;
                   17020:     if ($crstype eq 'Course') {
                   17021:         if (exists($filter->{'instcodefilter'})) {
                   17022: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   17023: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   17024:             if ($codedom) {
                   17025:                 $officialjs = 1;
                   17026:                 ($instcodeform,$jscript,$$numtitlesref) =
                   17027:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   17028:                                                                   $officialjs,$codetitlesref);
                   17029:                 if ($jscript) {
                   17030:                     $jscript = '<script type="text/javascript">'."\n".
                   17031:                                '// <![CDATA['."\n".
                   17032:                                $jscript."\n".
                   17033:                                '// ]]>'."\n".
                   17034:                                '</script>'."\n";
                   17035:                 }
                   17036:             }
                   17037:             if ($instcodeform eq '') {
                   17038:                 $instcodeform =
                   17039:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   17040:                     $list->{'instcodefilter'}.'" />';
                   17041:                 $instcodetitle = $lt{'ins'};
                   17042:             } else {
                   17043:                 $instcodetitle = $lt{'inc'};
                   17044:             }
                   17045:             if ($fixeddom) {
                   17046:                 $instcodetitle .= '<br />('.$codedom.')';
                   17047:             }
                   17048:         }
                   17049:     }
                   17050:     my $output = qq|
                   17051: <form method="post" name="filterpicker" action="$action">
                   17052: <input type="hidden" name="form" value="$formname" />
                   17053: |;
                   17054:     if ($formname eq 'modifycourse') {
                   17055:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   17056:                    '<input type="hidden" name="prevphase" value="'.
                   17057:                    $prevphase.'" />'."\n";
1.1075.2.82  raeburn  17058:     } elsif ($formname eq 'quotacheck') {
                   17059:         $output .= qq|
                   17060: <input type="hidden" name="sortby" value="" />
                   17061: <input type="hidden" name="sortorder" value="" />
                   17062: |;
                   17063:     } else {
1.1075.2.69  raeburn  17064:         my $name_input;
                   17065:         if ($cnameelement ne '') {
                   17066:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   17067:                           $cnameelement.'" />';
                   17068:         }
                   17069:         $output .= qq|
                   17070: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   17071: <input type="hidden" name="cdomelement" value="$cdomelement" />
                   17072: $name_input
                   17073: $roleelement
                   17074: $multelement
                   17075: $typeelement
                   17076: |;
                   17077:         if ($formname eq 'portform') {
                   17078:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   17079:         }
                   17080:     }
                   17081:     if ($fixeddom) {
                   17082:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   17083:     }
                   17084:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   17085:     if ($sincefilterform) {
                   17086:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   17087:                   .$sincefilterform
                   17088:                   .&Apache::lonhtmlcommon::row_closure();
                   17089:     }
                   17090:     if ($createdfilterform) {
                   17091:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   17092:                   .$createdfilterform
                   17093:                   .&Apache::lonhtmlcommon::row_closure();
                   17094:     }
                   17095:     if ($domainselectform) {
                   17096:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   17097:                   .$domainselectform
                   17098:                   .&Apache::lonhtmlcommon::row_closure();
                   17099:     }
                   17100:     if ($typeselectform) {
                   17101:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   17102:             $output .= $typeselectform;
                   17103:         } else {
                   17104:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   17105:                       .$typeselectform
                   17106:                       .&Apache::lonhtmlcommon::row_closure();
                   17107:         }
                   17108:     }
                   17109:     if ($instcodeform) {
                   17110:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   17111:                   .$instcodeform
                   17112:                   .&Apache::lonhtmlcommon::row_closure();
                   17113:     }
                   17114:     if (exists($filter->{'ownerfilter'})) {
                   17115:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   17116:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   17117:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   17118:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   17119:                    $ownerdomselectform.'</td></tr></table>'.
                   17120:                    &Apache::lonhtmlcommon::row_closure();
                   17121:     }
                   17122:     if (exists($filter->{'personfilter'})) {
                   17123:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   17124:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   17125:                    '<input type="text" name="personfilter" size="20" value="'.
                   17126:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   17127:                    $persondomselectform.'</td></tr></table>'.
                   17128:                    &Apache::lonhtmlcommon::row_closure();
                   17129:     }
                   17130:     if (exists($filter->{'coursefilter'})) {
                   17131:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   17132:                   .'<input type="text" name="coursefilter" size="25" value="'
                   17133:                   .$list->{'coursefilter'}.'" />'
                   17134:                   .&Apache::lonhtmlcommon::row_closure();
                   17135:     }
                   17136:     if ($cloneableonlyform) {
                   17137:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   17138:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   17139:     }
                   17140:     if (exists($filter->{'descriptfilter'})) {
                   17141:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   17142:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   17143:                   .$list->{'descriptfilter'}.'" />'
                   17144:                   .&Apache::lonhtmlcommon::row_closure(1);
                   17145:     }
                   17146:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   17147:                '<input type="hidden" name="updater" value="" />'."\n".
                   17148:                '<input type="submit" name="gosearch" value="'.
                   17149:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   17150:     return $jscript.$clonewarning.$output;
                   17151: }
                   17152: 
                   17153: =pod
                   17154: 
                   17155: =item * &timebased_select_form()
                   17156: 
                   17157: Create markup for a dropdown list used to select a time-based
                   17158: filter e.g., Course Activity, Course Created, when searching for courses
                   17159: or communities
                   17160: 
                   17161: Inputs:
                   17162: 
                   17163: item - name of form element (sincefilter or createdfilter)
                   17164: 
                   17165: filter - anonymous hash of criteria and their values
                   17166: 
                   17167: Returns: HTML for a select box contained a blank, then six time selections,
                   17168:          with value set in incoming form variables currently selected.
                   17169: 
                   17170: Side Effects: None
                   17171: 
                   17172: =cut
                   17173: 
                   17174: sub timebased_select_form {
                   17175:     my ($item,$filter) = @_;
                   17176:     if (ref($filter) eq 'HASH') {
                   17177:         $filter->{$item} =~ s/[^\d-]//g;
                   17178:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   17179:         return &select_form(
                   17180:                             $filter->{$item},
                   17181:                             $item,
                   17182:                             {      '-1' => '',
                   17183:                                 '86400' => &mt('today'),
                   17184:                                '604800' => &mt('last week'),
                   17185:                               '2592000' => &mt('last month'),
                   17186:                               '7776000' => &mt('last three months'),
                   17187:                              '15552000' => &mt('last six months'),
                   17188:                              '31104000' => &mt('last year'),
                   17189:                     'select_form_order' =>
                   17190:                            ['-1','86400','604800','2592000','7776000',
                   17191:                             '15552000','31104000']});
                   17192:     }
                   17193: }
                   17194: 
                   17195: =pod
                   17196: 
                   17197: =item * &js_changer()
                   17198: 
                   17199: Create script tag containing Javascript used to submit course search form
                   17200: when course type or domain is changed, and also to hide 'Searching ...' on
                   17201: page load completion for page showing search result.
                   17202: 
                   17203: Inputs: None
                   17204: 
                   17205: Returns: markup containing updateFilters() and hideSearching() javascript functions.
                   17206: 
                   17207: Side Effects: None
                   17208: 
                   17209: =cut
                   17210: 
                   17211: sub js_changer {
                   17212:     return <<ENDJS;
                   17213: <script type="text/javascript">
                   17214: // <![CDATA[
                   17215: function updateFilters(caller) {
                   17216:     if (typeof(caller) != "undefined") {
                   17217:         document.filterpicker.updater.value = caller.name;
                   17218:     }
                   17219:     document.filterpicker.submit();
                   17220: }
                   17221: 
                   17222: function hideSearching() {
                   17223:     if (document.getElementById('searching')) {
                   17224:         document.getElementById('searching').style.display = 'none';
                   17225:     }
                   17226:     return;
                   17227: }
                   17228: 
                   17229: // ]]>
                   17230: </script>
                   17231: 
                   17232: ENDJS
                   17233: }
                   17234: 
                   17235: =pod
                   17236: 
                   17237: =item * &search_courses()
                   17238: 
                   17239: Process selected filters form course search form and pass to lonnet::courseiddump
                   17240: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   17241: 
                   17242: Inputs:
                   17243: 
                   17244: dom - domain being searched
                   17245: 
                   17246: type - course type ('Course' or 'Community' or '.' if any).
                   17247: 
                   17248: filter - anonymous hash of criteria and their values
                   17249: 
                   17250: numtitles - for institutional codes - number of categories
                   17251: 
                   17252: cloneruname - optional username of new course owner
                   17253: 
                   17254: clonerudom - optional domain of new course owner
                   17255: 
1.1075.2.95  raeburn  17256: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1075.2.69  raeburn  17257:             (used when DC is using course creation form)
                   17258: 
                   17259: codetitles - reference to array of titles of components in institutional codes (official courses).
                   17260: 
1.1075.2.95  raeburn  17261: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   17262:            (and so can clone automatically)
                   17263: 
                   17264: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   17265: 
                   17266: reqinstcode - institutional code of new course, where search_courses is used to identify potential
                   17267:               courses to clone
1.1075.2.69  raeburn  17268: 
                   17269: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   17270: 
                   17271: 
                   17272: Side Effects: None
                   17273: 
                   17274: =cut
                   17275: 
                   17276: 
                   17277: sub search_courses {
1.1075.2.95  raeburn  17278:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   17279:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1075.2.69  raeburn  17280:     my (%courses,%showcourses,$cloner);
                   17281:     if (($filter->{'ownerfilter'} ne '') ||
                   17282:         ($filter->{'ownerdomfilter'} ne '')) {
                   17283:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   17284:                                        $filter->{'ownerdomfilter'};
                   17285:     }
                   17286:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   17287:         if (!$filter->{$item}) {
                   17288:             $filter->{$item}='.';
                   17289:         }
                   17290:     }
                   17291:     my $now = time;
                   17292:     my $timefilter =
                   17293:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   17294:     my ($createdbefore,$createdafter);
                   17295:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   17296:         $createdbefore = $now;
                   17297:         $createdafter = $now-$filter->{'createdfilter'};
                   17298:     }
                   17299:     my ($instcodefilter,$regexpok);
                   17300:     if ($numtitles) {
                   17301:         if ($env{'form.official'} eq 'on') {
                   17302:             $instcodefilter =
                   17303:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   17304:             $regexpok = 1;
                   17305:         } elsif ($env{'form.official'} eq 'off') {
                   17306:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   17307:             unless ($instcodefilter eq '') {
                   17308:                 $regexpok = -1;
                   17309:             }
                   17310:         }
                   17311:     } else {
                   17312:         $instcodefilter = $filter->{'instcodefilter'};
                   17313:     }
                   17314:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   17315:     if ($type eq '') { $type = '.'; }
                   17316: 
                   17317:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   17318:         $cloner = $cloneruname.':'.$clonerudom;
                   17319:     }
                   17320:     %courses = &Apache::lonnet::courseiddump($dom,
                   17321:                                              $filter->{'descriptfilter'},
                   17322:                                              $timefilter,
                   17323:                                              $instcodefilter,
                   17324:                                              $filter->{'combownerfilter'},
                   17325:                                              $filter->{'coursefilter'},
                   17326:                                              undef,undef,$type,$regexpok,undef,undef,
1.1075.2.95  raeburn  17327:                                              undef,undef,$cloner,$cc_clone,
1.1075.2.69  raeburn  17328:                                              $filter->{'cloneableonly'},
                   17329:                                              $createdbefore,$createdafter,undef,
1.1075.2.95  raeburn  17330:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1075.2.69  raeburn  17331:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   17332:         my $ccrole;
                   17333:         if ($type eq 'Community') {
                   17334:             $ccrole = 'co';
                   17335:         } else {
                   17336:             $ccrole = 'cc';
                   17337:         }
                   17338:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   17339:                                                      $filter->{'persondomfilter'},
                   17340:                                                      'userroles',undef,
                   17341:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   17342:                                                      $dom);
                   17343:         foreach my $role (keys(%rolehash)) {
                   17344:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   17345:             my $cid = $cdom.'_'.$cnum;
                   17346:             if (exists($courses{$cid})) {
                   17347:                 if (ref($courses{$cid}) eq 'HASH') {
                   17348:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   17349:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1075.2.119  raeburn  17350:                             push(@{$courses{$cid}{roles}},$courserole);
1.1075.2.69  raeburn  17351:                         }
                   17352:                     } else {
                   17353:                         $courses{$cid}{roles} = [$courserole];
                   17354:                     }
                   17355:                     $showcourses{$cid} = $courses{$cid};
                   17356:                 }
                   17357:             }
                   17358:         }
                   17359:         %courses = %showcourses;
                   17360:     }
                   17361:     return %courses;
                   17362: }
                   17363: 
                   17364: =pod
                   17365: 
                   17366: =back
                   17367: 
1.1075.2.88  raeburn  17368: =head1 Routines for version requirements for current course.
                   17369: 
                   17370: =over 4
                   17371: 
                   17372: =item * &check_release_required()
                   17373: 
                   17374: Compares required LON-CAPA version with version on server, and
                   17375: if required version is newer looks for a server with the required version.
                   17376: 
                   17377: Looks first at servers in user's owen domain; if none suitable, looks at
                   17378: servers in course's domain are permitted to host sessions for user's domain.
                   17379: 
                   17380: Inputs:
                   17381: 
                   17382: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   17383: 
                   17384: $courseid - Course ID of current course
                   17385: 
                   17386: $rolecode - User's current role in course (for switchserver query string).
                   17387: 
                   17388: $required - LON-CAPA version needed by course (format: Major.Minor).
                   17389: 
                   17390: 
                   17391: Returns:
                   17392: 
                   17393: $switchserver - query string tp append to /adm/switchserver call (if
                   17394:                 current server's LON-CAPA version is too old.
                   17395: 
                   17396: $warning - Message is displayed if no suitable server could be found.
                   17397: 
                   17398: =cut
                   17399: 
                   17400: sub check_release_required {
                   17401:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   17402:     my ($switchserver,$warning);
                   17403:     if ($required ne '') {
                   17404:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   17405:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   17406:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   17407:             my $otherserver;
                   17408:             if (($major eq '' && $minor eq '') ||
                   17409:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   17410:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   17411:                 my $switchlcrev =
                   17412:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   17413:                                                            $userdomserver);
                   17414:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   17415:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   17416:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   17417:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   17418:                     if ($cdom ne $env{'user.domain'}) {
                   17419:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   17420:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   17421:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   17422:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   17423:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   17424:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   17425:                         my $canhost =
                   17426:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   17427:                                                               $coursedomserver,
                   17428:                                                               $remoterev,
                   17429:                                                               $udomdefaults{'remotesessions'},
                   17430:                                                               $defdomdefaults{'hostedsessions'});
                   17431: 
                   17432:                         if ($canhost) {
                   17433:                             $otherserver = $coursedomserver;
                   17434:                         } else {
                   17435:                             $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.");
                   17436:                         }
                   17437:                     } else {
                   17438:                         $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).");
                   17439:                     }
                   17440:                 } else {
                   17441:                     $otherserver = $userdomserver;
                   17442:                 }
                   17443:             }
                   17444:             if ($otherserver ne '') {
                   17445:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   17446:             }
                   17447:         }
                   17448:     }
                   17449:     return ($switchserver,$warning);
                   17450: }
                   17451: 
                   17452: =pod
                   17453: 
                   17454: =item * &check_release_result()
                   17455: 
                   17456: Inputs:
                   17457: 
                   17458: $switchwarning - Warning message if no suitable server found to host session.
                   17459: 
                   17460: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   17461:                 and current role.
                   17462: 
                   17463: Returns: HTML to display with information about requirement to switch server.
                   17464:          Either displaying warning with link to Roles/Courses screen or
                   17465:          display link to switchserver.
                   17466: 
1.1075.2.69  raeburn  17467: =cut
                   17468: 
1.1075.2.88  raeburn  17469: sub check_release_result {
                   17470:     my ($switchwarning,$switchserver) = @_;
                   17471:     my $output = &start_page('Selected course unavailable on this server').
                   17472:                  '<p class="LC_warning">';
                   17473:     if ($switchwarning) {
                   17474:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   17475:         if (&show_course()) {
                   17476:             $output .= &mt('Display courses');
                   17477:         } else {
                   17478:             $output .= &mt('Display roles');
                   17479:         }
                   17480:         $output .= '</a>';
                   17481:     } elsif ($switchserver) {
                   17482:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   17483:                    '<br />'.
                   17484:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   17485:                    &mt('Switch Server').
                   17486:                    '</a>';
                   17487:     }
                   17488:     $output .= '</p>'.&end_page();
                   17489:     return $output;
                   17490: }
                   17491: 
                   17492: =pod
                   17493: 
                   17494: =item * &needs_coursereinit()
                   17495: 
                   17496: Determine if course contents stored for user's session needs to be
                   17497: refreshed, because content has changed since "Big Hash" last tied.
                   17498: 
                   17499: Check for change is made if time last checked is more than 10 minutes ago
                   17500: (by default).
                   17501: 
                   17502: Inputs:
                   17503: 
                   17504: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   17505: 
                   17506: $interval (optional) - Time which may elapse (in s) between last check for content
                   17507:                        change in current course. (default: 600 s).
                   17508: 
                   17509: Returns: an array; first element is:
                   17510: 
                   17511: =over 4
                   17512: 
                   17513: 'switch' - if content updates mean user's session
                   17514:            needs to be switched to a server running a newer LON-CAPA version
                   17515: 
                   17516: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   17517:            on current server hosting user's session
                   17518: 
                   17519: ''       - if no action required.
                   17520: 
                   17521: =back
                   17522: 
                   17523: If first item element is 'switch':
                   17524: 
                   17525: second item is $switchwarning - Warning message if no suitable server found to host session.
                   17526: 
                   17527: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   17528:                               and current role.
                   17529: 
                   17530: otherwise: no other elements returned.
                   17531: 
                   17532: =back
                   17533: 
                   17534: =cut
                   17535: 
                   17536: sub needs_coursereinit {
                   17537:     my ($loncaparev,$interval) = @_;
                   17538:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   17539:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   17540:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   17541:     my $now = time;
                   17542:     if ($interval eq '') {
                   17543:         $interval = 600;
                   17544:     }
                   17545:     if (($now-$env{'request.course.timechecked'})>$interval) {
                   17546:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1075.2.161.  .4(raebu 17547:22):         my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
          .1(raebu 17548:21):         if ($blocked) {
                   17549:21):             return ();
                   17550:21):         }
                   17551:21):         my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
1.1075.2.88  raeburn  17552:         if ($lastchange > $env{'request.course.tied'}) {
                   17553:             my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   17554:             if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   17555:                 my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   17556:                 if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   17557:                     &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   17558:                                              $curr_reqd_hash{'internal.releaserequired'}});
                   17559:                     my ($switchserver,$switchwarning) =
                   17560:                         &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   17561:                                                 $curr_reqd_hash{'internal.releaserequired'});
                   17562:                     if ($switchwarning ne '' || $switchserver ne '') {
                   17563:                         return ('switch',$switchwarning,$switchserver);
                   17564:                     }
                   17565:                 }
                   17566:             }
                   17567:             return ('update');
                   17568:         }
                   17569:     }
                   17570:     return ();
                   17571: }
1.1075.2.69  raeburn  17572: 
1.1075.2.11  raeburn  17573: sub update_content_constraints {
                   17574:     my ($cdom,$cnum,$chome,$cid) = @_;
                   17575:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   17576:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   17577:     my %checkresponsetypes;
                   17578:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   17579:         my ($item,$name,$value) = split(/:/,$key);
                   17580:         if ($item eq 'resourcetag') {
                   17581:             if ($name eq 'responsetype') {
                   17582:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   17583:             }
                   17584:         }
                   17585:     }
                   17586:     my $navmap = Apache::lonnavmaps::navmap->new();
                   17587:     if (defined($navmap)) {
                   17588:         my %allresponses;
                   17589:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
                   17590:             my %responses = $res->responseTypes();
                   17591:             foreach my $key (keys(%responses)) {
                   17592:                 next unless(exists($checkresponsetypes{$key}));
                   17593:                 $allresponses{$key} += $responses{$key};
                   17594:             }
                   17595:         }
                   17596:         foreach my $key (keys(%allresponses)) {
                   17597:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   17598:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   17599:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   17600:             }
                   17601:         }
                   17602:         undef($navmap);
                   17603:     }
                   17604:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   17605:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   17606:     }
                   17607:     return;
                   17608: }
                   17609: 
1.1075.2.27  raeburn  17610: sub allmaps_incourse {
                   17611:     my ($cdom,$cnum,$chome,$cid) = @_;
                   17612:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   17613:         $cid = $env{'request.course.id'};
                   17614:         $cdom = $env{'course.'.$cid.'.domain'};
                   17615:         $cnum = $env{'course.'.$cid.'.num'};
                   17616:         $chome = $env{'course.'.$cid.'.home'};
                   17617:     }
                   17618:     my %allmaps = ();
                   17619:     my $lastchange =
                   17620:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   17621:     if ($lastchange > $env{'request.course.tied'}) {
                   17622:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   17623:         unless ($ferr) {
                   17624:             &update_content_constraints($cdom,$cnum,$chome,$cid);
                   17625:         }
                   17626:     }
                   17627:     my $navmap = Apache::lonnavmaps::navmap->new();
                   17628:     if (defined($navmap)) {
                   17629:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   17630:             $allmaps{$res->src()} = 1;
                   17631:         }
                   17632:     }
                   17633:     return \%allmaps;
                   17634: }
                   17635: 
1.1075.2.11  raeburn  17636: sub parse_supplemental_title {
                   17637:     my ($title) = @_;
                   17638: 
                   17639:     my ($foldertitle,$renametitle);
                   17640:     if ($title =~ /&amp;&amp;&amp;/) {
                   17641:         $title = &HTML::Entites::decode($title);
                   17642:     }
                   17643:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   17644:         $renametitle=$4;
                   17645:         my ($time,$uname,$udom) = ($1,$2,$3);
                   17646:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   17647:         my $name =  &plainname($uname,$udom);
                   17648:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   17649:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
                   17650:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
                   17651:             $name.': <br />'.$foldertitle;
                   17652:     }
                   17653:     if (wantarray) {
                   17654:         return ($title,$foldertitle,$renametitle);
                   17655:     }
                   17656:     return $title;
                   17657: }
                   17658: 
1.1075.2.43  raeburn  17659: sub recurse_supplemental {
                   17660:     my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
                   17661:     if ($suppmap) {
                   17662:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   17663:         if ($fatal) {
                   17664:             $errors ++;
                   17665:         } else {
                   17666:             if ($#LONCAPA::map::resources > 0) {
                   17667:                 foreach my $res (@LONCAPA::map::resources) {
                   17668:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
                   17669:                     if (($src ne '') && ($status eq 'res')) {
1.1075.2.46  raeburn  17670:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
                   17671:                             ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1075.2.43  raeburn  17672:                         } else {
                   17673:                             $numfiles ++;
                   17674:                         }
                   17675:                     }
                   17676:                 }
                   17677:             }
                   17678:         }
                   17679:     }
                   17680:     return ($numfiles,$errors);
                   17681: }
                   17682: 
1.1075.2.18  raeburn  17683: sub symb_to_docspath {
1.1075.2.119  raeburn  17684:     my ($symb,$navmapref) = @_;
                   17685:     return unless ($symb && ref($navmapref));
1.1075.2.18  raeburn  17686:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   17687:     if ($resurl=~/\.(sequence|page)$/) {
                   17688:         $mapurl=$resurl;
                   17689:     } elsif ($resurl eq 'adm/navmaps') {
                   17690:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   17691:     }
                   17692:     my $mapresobj;
1.1075.2.119  raeburn  17693:     unless (ref($$navmapref)) {
                   17694:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   17695:     }
                   17696:     if (ref($$navmapref)) {
                   17697:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1075.2.18  raeburn  17698:     }
                   17699:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   17700:     my $type=$2;
                   17701:     my $path;
                   17702:     if (ref($mapresobj)) {
                   17703:         my $pcslist = $mapresobj->map_hierarchy();
                   17704:         if ($pcslist ne '') {
                   17705:             foreach my $pc (split(/,/,$pcslist)) {
                   17706:                 next if ($pc <= 1);
1.1075.2.119  raeburn  17707:                 my $res = $$navmapref->getByMapPc($pc);
1.1075.2.18  raeburn  17708:                 if (ref($res)) {
                   17709:                     my $thisurl = $res->src();
                   17710:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   17711:                     my $thistitle = $res->title();
                   17712:                     $path .= '&'.
                   17713:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1075.2.46  raeburn  17714:                              &escape($thistitle).
1.1075.2.18  raeburn  17715:                              ':'.$res->randompick().
                   17716:                              ':'.$res->randomout().
                   17717:                              ':'.$res->encrypted().
                   17718:                              ':'.$res->randomorder().
                   17719:                              ':'.$res->is_page();
                   17720:                 }
                   17721:             }
                   17722:         }
                   17723:         $path =~ s/^\&//;
                   17724:         my $maptitle = $mapresobj->title();
                   17725:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  17726:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17727:         }
                   17728:         $path .= (($path ne '')? '&' : '').
                   17729:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17730:                  &escape($maptitle).
1.1075.2.18  raeburn  17731:                  ':'.$mapresobj->randompick().
                   17732:                  ':'.$mapresobj->randomout().
                   17733:                  ':'.$mapresobj->encrypted().
                   17734:                  ':'.$mapresobj->randomorder().
                   17735:                  ':'.$mapresobj->is_page();
                   17736:     } else {
                   17737:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   17738:         my $ispage = (($type eq 'page')? 1 : '');
                   17739:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  17740:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17741:         }
                   17742:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17743:                 &escape($maptitle).':::::'.$ispage;
1.1075.2.18  raeburn  17744:     }
                   17745:     unless ($mapurl eq 'default') {
                   17746:         $path = 'default&'.
1.1075.2.46  raeburn  17747:                 &escape('Main Content').
1.1075.2.18  raeburn  17748:                 ':::::&'.$path;
                   17749:     }
                   17750:     return $path;
                   17751: }
                   17752: 
1.1075.2.14  raeburn  17753: sub captcha_display {
1.1075.2.137  raeburn  17754:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17755:     my ($output,$error);
1.1075.2.107  raeburn  17756:     my ($captcha,$pubkey,$privkey,$version) =
1.1075.2.137  raeburn  17757:         &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17758:     if ($captcha eq 'original') {
                   17759:         $output = &create_captcha();
                   17760:         unless ($output) {
                   17761:             $error = 'captcha';
                   17762:         }
                   17763:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17764:         $output = &create_recaptcha($pubkey,$version);
1.1075.2.14  raeburn  17765:         unless ($output) {
                   17766:             $error = 'recaptcha';
                   17767:         }
                   17768:     }
1.1075.2.107  raeburn  17769:     return ($output,$error,$captcha,$version);
1.1075.2.14  raeburn  17770: }
                   17771: 
                   17772: sub captcha_response {
1.1075.2.137  raeburn  17773:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17774:     my ($captcha_chk,$captcha_error);
1.1075.2.137  raeburn  17775:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17776:     if ($captcha eq 'original') {
                   17777:         ($captcha_chk,$captcha_error) = &check_captcha();
                   17778:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17779:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1075.2.14  raeburn  17780:     } else {
                   17781:         $captcha_chk = 1;
                   17782:     }
                   17783:     return ($captcha_chk,$captcha_error);
                   17784: }
                   17785: 
                   17786: sub get_captcha_config {
1.1075.2.137  raeburn  17787:     my ($context,$lonhost,$dom_in_effect) = @_;
1.1075.2.107  raeburn  17788:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1075.2.14  raeburn  17789:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   17790:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   17791:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   17792:     if ($context eq 'usercreation') {
                   17793:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   17794:         if (ref($domconfig{$context}) eq 'HASH') {
                   17795:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   17796:             if (ref($hashtocheck) eq 'HASH') {
                   17797:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   17798:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   17799:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   17800:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   17801:                     }
                   17802:                     if ($privkey && $pubkey) {
                   17803:                         $captcha = 'recaptcha';
1.1075.2.107  raeburn  17804:                         $version = $hashtocheck->{'recaptchaversion'};
                   17805:                         if ($version ne '2') {
                   17806:                             $version = 1;
                   17807:                         }
1.1075.2.14  raeburn  17808:                     } else {
                   17809:                         $captcha = 'original';
                   17810:                     }
                   17811:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   17812:                     $captcha = 'original';
                   17813:                 }
                   17814:             }
                   17815:         } else {
                   17816:             $captcha = 'captcha';
                   17817:         }
                   17818:     } elsif ($context eq 'login') {
                   17819:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   17820:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   17821:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   17822:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
                   17823:             if ($privkey && $pubkey) {
                   17824:                 $captcha = 'recaptcha';
1.1075.2.107  raeburn  17825:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   17826:                 if ($version ne '2') {
                   17827:                     $version = 1;
                   17828:                 }
1.1075.2.14  raeburn  17829:             } else {
                   17830:                 $captcha = 'original';
                   17831:             }
                   17832:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   17833:             $captcha = 'original';
                   17834:         }
1.1075.2.137  raeburn  17835:     } elsif ($context eq 'passwords') {
                   17836:         if ($dom_in_effect) {
                   17837:             my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
                   17838:             if ($passwdconf{'captcha'} eq 'recaptcha') {
                   17839:                 if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
                   17840:                     $pubkey = $passwdconf{'recaptchakeys'}{'public'};
                   17841:                     $privkey = $passwdconf{'recaptchakeys'}{'private'};
                   17842:                 }
                   17843:                 if ($privkey && $pubkey) {
                   17844:                     $captcha = 'recaptcha';
                   17845:                     $version = $passwdconf{'recaptchaversion'};
                   17846:                     if ($version ne '2') {
                   17847:                         $version = 1;
                   17848:                     }
                   17849:                 } else {
                   17850:                     $captcha = 'original';
                   17851:                 }
                   17852:             } elsif ($passwdconf{'captcha'} ne 'notused') {
                   17853:                 $captcha = 'original';
                   17854:             }
                   17855:         }
1.1075.2.14  raeburn  17856:     }
1.1075.2.107  raeburn  17857:     return ($captcha,$pubkey,$privkey,$version);
1.1075.2.14  raeburn  17858: }
                   17859: 
                   17860: sub create_captcha {
                   17861:     my %captcha_params = &captcha_settings();
                   17862:     my ($output,$maxtries,$tries) = ('',10,0);
                   17863:     while ($tries < $maxtries) {
                   17864:         $tries ++;
                   17865:         my $captcha = Authen::Captcha->new (
                   17866:                                            output_folder => $captcha_params{'output_dir'},
                   17867:                                            data_folder   => $captcha_params{'db_dir'},
                   17868:                                           );
                   17869:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   17870: 
                   17871:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   17872:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1075.2.158  raeburn  17873:                       '<span class="LC_nobreak">'.
1.1075.2.14  raeburn  17874:                       &mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1075.2.66  raeburn  17875:                       '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
1.1075.2.158  raeburn  17876:                       '</span><br />'.
1.1075.2.66  raeburn  17877:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1075.2.14  raeburn  17878:             last;
                   17879:         }
                   17880:     }
1.1075.2.158  raeburn  17881:     if ($output eq '') {
                   17882:         &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
                   17883:     }
1.1075.2.14  raeburn  17884:     return $output;
                   17885: }
                   17886: 
                   17887: sub captcha_settings {
                   17888:     my %captcha_params = (
                   17889:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   17890:                            www_output_dir => "/captchaspool",
                   17891:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   17892:                            numchars       => '5',
                   17893:                          );
                   17894:     return %captcha_params;
                   17895: }
                   17896: 
                   17897: sub check_captcha {
                   17898:     my ($captcha_chk,$captcha_error);
                   17899:     my $code = $env{'form.code'};
                   17900:     my $md5sum = $env{'form.crypt'};
                   17901:     my %captcha_params = &captcha_settings();
                   17902:     my $captcha = Authen::Captcha->new(
                   17903:                       output_folder => $captcha_params{'output_dir'},
                   17904:                       data_folder   => $captcha_params{'db_dir'},
                   17905:                   );
1.1075.2.26  raeburn  17906:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14  raeburn  17907:     my %captcha_hash = (
                   17908:                         0       => 'Code not checked (file error)',
                   17909:                        -1      => 'Failed: code expired',
                   17910:                        -2      => 'Failed: invalid code (not in database)',
                   17911:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   17912:     );
                   17913:     if ($captcha_chk != 1) {
                   17914:         $captcha_error = $captcha_hash{$captcha_chk}
                   17915:     }
                   17916:     return ($captcha_chk,$captcha_error);
                   17917: }
                   17918: 
                   17919: sub create_recaptcha {
1.1075.2.107  raeburn  17920:     my ($pubkey,$version) = @_;
                   17921:     if ($version >= 2) {
1.1075.2.158  raeburn  17922:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
                   17923:                '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1075.2.107  raeburn  17924:     } else {
                   17925:         my $use_ssl;
                   17926:         if ($ENV{'SERVER_PORT'} == 443) {
                   17927:             $use_ssl = 1;
                   17928:         }
                   17929:         my $captcha = Captcha::reCAPTCHA->new;
                   17930:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   17931:                $captcha->get_html($pubkey,undef,$use_ssl).
                   17932:                &mt('If the text is hard to read, [_1] will replace them.',
                   17933:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   17934:                '<br /><br />';
                   17935:      }
1.1075.2.14  raeburn  17936: }
                   17937: 
                   17938: sub check_recaptcha {
1.1075.2.107  raeburn  17939:     my ($privkey,$version) = @_;
1.1075.2.14  raeburn  17940:     my $captcha_chk;
1.1075.2.150  raeburn  17941:     my $ip = &Apache::lonnet::get_requestor_ip(); 
1.1075.2.107  raeburn  17942:     if ($version >= 2) {
                   17943:         my $ua = LWP::UserAgent->new;
                   17944:         $ua->timeout(10);
                   17945:         my %info = (
                   17946:                      secret   => $privkey,
                   17947:                      response => $env{'form.g-recaptcha-response'},
1.1075.2.150  raeburn  17948:                      remoteip => $ip,
1.1075.2.107  raeburn  17949:                    );
                   17950:         my $response = $ua->post('https://www.google.com/recaptcha/api/siteverify',\%info);
                   17951:         if ($response->is_success)  {
                   17952:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   17953:             if (ref($data) eq 'HASH') {
                   17954:                 if ($data->{'success'}) {
                   17955:                     $captcha_chk = 1;
                   17956:                 }
                   17957:             }
                   17958:         }
                   17959:     } else {
                   17960:         my $captcha = Captcha::reCAPTCHA->new;
                   17961:         my $captcha_result =
                   17962:             $captcha->check_answer(
                   17963:                                     $privkey,
1.1075.2.150  raeburn  17964:                                     $ip,
1.1075.2.107  raeburn  17965:                                     $env{'form.recaptcha_challenge_field'},
                   17966:                                     $env{'form.recaptcha_response_field'},
                   17967:                                   );
                   17968:         if ($captcha_result->{is_valid}) {
                   17969:             $captcha_chk = 1;
                   17970:         }
1.1075.2.14  raeburn  17971:     }
                   17972:     return $captcha_chk;
                   17973: }
                   17974: 
1.1075.2.64  raeburn  17975: sub emailusername_info {
1.1075.2.103  raeburn  17976:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1075.2.64  raeburn  17977:     my %titles = &Apache::lonlocal::texthash (
                   17978:                      lastname      => 'Last Name',
                   17979:                      firstname     => 'First Name',
                   17980:                      institution   => 'School/college/university',
                   17981:                      location      => "School's city, state/province, country",
                   17982:                      web           => "School's web address",
                   17983:                      officialemail => 'E-mail address at institution (if different)',
1.1075.2.103  raeburn  17984:                      id            => 'Student/Employee ID',
1.1075.2.64  raeburn  17985:                  );
                   17986:     return (\@fields,\%titles);
                   17987: }
                   17988: 
1.1075.2.56  raeburn  17989: sub cleanup_html {
                   17990:     my ($incoming) = @_;
                   17991:     my $outgoing;
                   17992:     if ($incoming ne '') {
                   17993:         $outgoing = $incoming;
                   17994:         $outgoing =~ s/;/&#059;/g;
                   17995:         $outgoing =~ s/\#/&#035;/g;
                   17996:         $outgoing =~ s/\&/&#038;/g;
                   17997:         $outgoing =~ s/</&#060;/g;
                   17998:         $outgoing =~ s/>/&#062;/g;
                   17999:         $outgoing =~ s/\(/&#040/g;
                   18000:         $outgoing =~ s/\)/&#041;/g;
                   18001:         $outgoing =~ s/"/&#034;/g;
                   18002:         $outgoing =~ s/'/&#039;/g;
                   18003:         $outgoing =~ s/\$/&#036;/g;
                   18004:         $outgoing =~ s{/}{&#047;}g;
                   18005:         $outgoing =~ s/=/&#061;/g;
                   18006:         $outgoing =~ s/\\/&#092;/g
                   18007:     }
                   18008:     return $outgoing;
                   18009: }
                   18010: 
1.1075.2.74  raeburn  18011: # Checks for critical messages and returns a redirect url if one exists.
                   18012: # $interval indicates how often to check for messages.
1.1075.2.161.  .1(raebu 18013:21): # $context is the calling context -- roles, grades, contents, menu or flip.
1.1075.2.74  raeburn  18014: sub critical_redirect {
1.1075.2.161.  .1(raebu 18015:21):     my ($interval,$context) = @_;
1.1075.2.158  raeburn  18016:     unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
                   18017:         return ();
                   18018:     }
1.1075.2.74  raeburn  18019:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1075.2.161.  .1(raebu 18020:21):         if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
                   18021:21):             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   18022:21):             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
          .4(raebu 18023:22):             my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
          .1(raebu 18024:21):             if ($blocked) {
                   18025:21):                 my $checkrole = "cm./$cdom/$cnum";
                   18026:21):                 if ($env{'request.course.sec'} ne '') {
                   18027:21):                     $checkrole .= "/$env{'request.course.sec'}";
                   18028:21):                 }
                   18029:21):                 unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   18030:21):                         ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   18031:21):                     return;
                   18032:21):                 }
                   18033:21):             }
                   18034:21):         }
1.1075.2.74  raeburn  18035:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
                   18036:                                         $env{'user.name'});
                   18037:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
                   18038:         my $redirecturl;
                   18039:         if ($what[0]) {
1.1075.2.158  raeburn  18040:             if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1075.2.74  raeburn  18041:                 $redirecturl='/adm/email?critical=display';
                   18042:                 my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   18043:                 return (1, $url);
                   18044:             }
                   18045:         }
                   18046:     }
                   18047:     return ();
                   18048: }
                   18049: 
1.1075.2.64  raeburn  18050: # Use:
                   18051: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   18052: #
                   18053: ##################################################
                   18054: #          password associated functions         #
                   18055: ##################################################
                   18056: sub des_keys {
                   18057:     # Make a new key for DES encryption.
                   18058:     # Each key has two parts which are returned separately.
                   18059:     # Please note:  Each key must be passed through the &hex function
                   18060:     # before it is output to the web browser.  The hex versions cannot
                   18061:     # be used to decrypt.
                   18062:     my @hexstr=('0','1','2','3','4','5','6','7',
                   18063:                 '8','9','a','b','c','d','e','f');
                   18064:     my $lkey='';
                   18065:     for (0..7) {
                   18066:         $lkey.=$hexstr[rand(15)];
                   18067:     }
                   18068:     my $ukey='';
                   18069:     for (0..7) {
                   18070:         $ukey.=$hexstr[rand(15)];
                   18071:     }
                   18072:     return ($lkey,$ukey);
                   18073: }
                   18074: 
                   18075: sub des_decrypt {
                   18076:     my ($key,$cyphertext) = @_;
                   18077:     my $keybin=pack("H16",$key);
                   18078:     my $cypher;
                   18079:     if ($Crypt::DES::VERSION>=2.03) {
                   18080:         $cypher=new Crypt::DES $keybin;
                   18081:     } else {
                   18082:         $cypher=new DES $keybin;
                   18083:     }
1.1075.2.106  raeburn  18084:     my $plaintext='';
                   18085:     my $cypherlength = length($cyphertext);
                   18086:     my $numchunks = int($cypherlength/32);
                   18087:     for (my $j=0; $j<$numchunks; $j++) {
                   18088:         my $start = $j*32;
                   18089:         my $cypherblock = substr($cyphertext,$start,32);
                   18090:         my $chunk =
                   18091:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   18092:         $chunk .=
                   18093:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   18094:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   18095:         $plaintext .= $chunk;
                   18096:     }
1.1075.2.64  raeburn  18097:     return $plaintext;
                   18098: }
                   18099: 
1.1075.2.161.  .1(raebu 18100:21): sub get_requested_shorturls {
                   18101:21):     my ($cdom,$cnum,$navmap) = @_;
                   18102:21):     return unless (ref($navmap));
                   18103:21):     my ($numnew,$errors);
                   18104:21):     my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
                   18105:21):     if (@toshorten) {
                   18106:21):         my (%maps,%resources,%titles);
                   18107:21):         &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
                   18108:21):                                                                'shorturls',$cdom,$cnum);
                   18109:21):         if (keys(%resources)) {
                   18110:21):             my %tocreate;
                   18111:21):             foreach my $item (sort {$a <=> $b} (@toshorten)) {
                   18112:21):                 my $symb = $resources{$item};
                   18113:21):                 if ($symb) {
                   18114:21):                     $tocreate{$cnum.'&'.$symb} = 1;
                   18115:21):                 }
                   18116:21):             }
                   18117:21):             if (keys(%tocreate)) {
                   18118:21):                 ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
                   18119:21):                                                       \%tocreate);
                   18120:21):             }
                   18121:21):         }
                   18122:21):     }
                   18123:21):     return ($numnew,$errors);
                   18124:21): }
                   18125:21): 
                   18126:21): sub make_short_symbs {
                   18127:21):     my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
                   18128:21):     my ($numnew,@errors);
                   18129:21):     if (ref($tocreateref) eq 'HASH') {
                   18130:21):         my %tocreate = %{$tocreateref};
                   18131:21):         if (keys(%tocreate)) {
                   18132:21):             my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
                   18133:21):             my $su = Short::URL->new(no_vowels => 1);
                   18134:21):             my $init = '';
                   18135:21):             my (%newunique,%addcourse,%courseonly,%failed);
                   18136:21):             # get lock on tiny db
                   18137:21):             my $now = time;
                   18138:21):             if ($lockuser eq '') {
                   18139:21):                 $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
                   18140:21):             }
                   18141:21):             my $lockhash = {
                   18142:21):                                 "lock\0$now" => $lockuser,
                   18143:21):                             };
                   18144:21):             my $tries = 0;
                   18145:21):             my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
                   18146:21):             my ($code,$error);
                   18147:21):             while (($gotlock ne 'ok') && ($tries<3)) {
                   18148:21):                 $tries ++;
                   18149:21):                 sleep 1;
                   18150:21):                 $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
                   18151:21):             }
                   18152:21):             if ($gotlock eq 'ok') {
                   18153:21):                 $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
                   18154:21):                                        \%addcourse,\%courseonly,\%failed);
                   18155:21):                 if (keys(%failed)) {
                   18156:21):                     my $numfailed = scalar(keys(%failed));
                   18157:21):                     push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
                   18158:21):                 }
                   18159:21):                 if (keys(%newunique)) {
                   18160:21):                     my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
                   18161:21):                     if ($putres eq 'ok') {
                   18162:21):                         $numnew = scalar(keys(%newunique));
                   18163:21):                         my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
                   18164:21):                         unless ($newputres eq 'ok') {
                   18165:21):                             push(@errors,&mt('error: could not store course look-up of short URLs'));
                   18166:21):                         }
                   18167:21):                     } else {
                   18168:21):                         push(@errors,&mt('error: could not store unique six character URLs'));
                   18169:21):                     }
                   18170:21):                 }
                   18171:21):                 my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
                   18172:21):                 unless ($dellockres eq 'ok') {
                   18173:21):                     push(@errors,&mt('error: could not release lockfile'));
                   18174:21):                 }
                   18175:21):             } else {
                   18176:21):                 push(@errors,&mt('error: could not obtain lockfile'));
                   18177:21):             }
                   18178:21):             if (keys(%courseonly)) {
                   18179:21):                 my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
                   18180:21):                 if ($result ne 'ok') {
                   18181:21):                     push(@errors,&mt('error: could not update course look-up of short URLs'));
                   18182:21):                 }
                   18183:21):             }
                   18184:21):         }
                   18185:21):     }
                   18186:21):     return ($numnew,\@errors);
                   18187:21): }
                   18188:21): 
                   18189:21): sub shorten_symbs {
                   18190:21):     my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
                   18191:21):     return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
                   18192:21):                    (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
                   18193:21):                    (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
                   18194:21):     my (%possibles,%collisions);
                   18195:21):     foreach my $key (keys(%{$tocreate})) {
                   18196:21):         my $num = String::CRC32::crc32($key);
                   18197:21):         my $tiny = $su->encode($num,$init);
                   18198:21):         if ($tiny) {
                   18199:21):             $possibles{$tiny} = $key;
                   18200:21):         }
                   18201:21):     }
                   18202:21):     if (!$init) {
                   18203:21):         $init = 1;
                   18204:21):     } else {
                   18205:21):         $init ++;
                   18206:21):     }
                   18207:21):     if (keys(%possibles)) {
                   18208:21):         my @posstiny = keys(%possibles);
                   18209:21):         my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
                   18210:21):         my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
                   18211:21):         if (keys(%currtiny)) {
                   18212:21):             foreach my $key (keys(%currtiny)) {
                   18213:21):                 next if ($currtiny{$key} eq '');
                   18214:21):                 if ($currtiny{$key} eq $possibles{$key}) {
                   18215:21):                     my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
                   18216:21):                     unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   18217:21):                         $courseonly->{$tsymb} = $key;
                   18218:21):                     }
                   18219:21):                 } else {
                   18220:21):                     $collisions{$possibles{$key}} = 1;
                   18221:21):                 }
                   18222:21):                 delete($possibles{$key});
                   18223:21):             }
                   18224:21):         }
                   18225:21):         foreach my $key (keys(%possibles)) {
                   18226:21):             $newunique->{$key} = $possibles{$key};
                   18227:21):             my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
                   18228:21):             unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   18229:21):                 $addcourse->{$tsymb} = $key;
                   18230:21):             }
                   18231:21):         }
                   18232:21):     }
                   18233:21):     if (keys(%collisions)) {
                   18234:21):         if ($init <5) {
                   18235:21):             if (!$init) {
                   18236:21):                 $init = 1;
                   18237:21):             } else {
                   18238:21):                 $init ++;
                   18239:21):             }
                   18240:21):             $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
                   18241:21):                                    $newunique,$addcourse,$courseonly,$failed);
                   18242:21):         } else {
                   18243:21):             foreach my $key (keys(%collisions)) {
                   18244:21):                 $failed->{$key} = 1;
                   18245:21):                 $failed->{$key} = 1;
                   18246:21):             }
                   18247:21):         }
                   18248:21):     }
                   18249:21):     return $init;
                   18250:21): }
                   18251:21): 
1.1075.2.135  raeburn  18252: sub is_nonframeable {
                   18253:     my ($url,$absolute,$hostname,$ip,$nocache) = @_;
                   18254:     my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
                   18255:     return if (($remprotocol eq '') || ($remhost eq ''));
                   18256: 
                   18257:     $remprotocol = lc($remprotocol);
                   18258:     $remhost = lc($remhost);
                   18259:     my $remport = 80;
                   18260:     if ($remprotocol eq 'https') {
                   18261:         $remport = 443;
                   18262:     }
                   18263:     my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
                   18264:     if ($cached) {
                   18265:         unless ($nocache) {
                   18266:             if ($result) {
                   18267:                 return 1;
                   18268:             } else {
                   18269:                 return 0;
                   18270:             }
                   18271:         }
                   18272:     }
                   18273:     my $uselink;
                   18274:     my $request = new HTTP::Request('HEAD',$url);
1.1075.2.142  raeburn  18275:     my $ua = LWP::UserAgent->new;
                   18276:     $ua->timeout(5);
                   18277:     my $response=$ua->request($request);
1.1075.2.135  raeburn  18278:     if ($response->is_success()) {
                   18279:         my $secpolicy = lc($response->header('content-security-policy'));
                   18280:         my $xframeop = lc($response->header('x-frame-options'));
                   18281:         $secpolicy =~ s/^\s+|\s+$//g;
                   18282:         $xframeop =~ s/^\s+|\s+$//g;
                   18283:         if (($secpolicy ne '') || ($xframeop ne '')) {
                   18284:             my $remotehost = $remprotocol.'://'.$remhost;
                   18285:             my ($origin,$protocol,$port);
                   18286:             if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
                   18287:                 $port = $ENV{'SERVER_PORT'};
                   18288:             } else {
                   18289:                 $port = 80;
                   18290:             }
                   18291:             if ($absolute eq '') {
                   18292:                 $protocol = 'http:';
                   18293:                 if ($port == 443) {
                   18294:                     $protocol = 'https:';
                   18295:                 }
                   18296:                 $origin = $protocol.'//'.lc($hostname);
                   18297:             } else {
                   18298:                 $origin = lc($absolute);
                   18299:                 ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
                   18300:             }
                   18301:             if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
                   18302:                 my $framepolicy = $1;
                   18303:                 $framepolicy =~ s/^\s+|\s+$//g;
                   18304:                 my @policies = split(/\s+/,$framepolicy);
                   18305:                 if (@policies) {
                   18306:                     if (grep(/^\Q'none'\E$/,@policies)) {
                   18307:                         $uselink = 1;
                   18308:                     } else {
                   18309:                         $uselink = 1;
                   18310:                         if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
                   18311:                                 (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
                   18312:                                 (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
                   18313:                             undef($uselink);
                   18314:                         }
                   18315:                         if ($uselink) {
                   18316:                             if (grep(/^\Q'self'\E$/,@policies)) {
                   18317:                                 if (($origin ne '') && ($remotehost eq $origin)) {
                   18318:                                     undef($uselink);
                   18319:                                 }
                   18320:                             }
                   18321:                         }
                   18322:                         if ($uselink) {
                   18323:                             my @possok;
                   18324:                             if ($ip ne '') {
                   18325:                                 push(@possok,$ip);
                   18326:                             }
                   18327:                             my $hoststr = '';
                   18328:                             foreach my $part (reverse(split(/\./,$hostname))) {
                   18329:                                 if ($hoststr eq '') {
                   18330:                                     $hoststr = $part;
                   18331:                                 } else {
                   18332:                                     $hoststr = "$part.$hoststr";
                   18333:                                 }
                   18334:                                 if ($hoststr eq $hostname) {
                   18335:                                     push(@possok,$hostname);
                   18336:                                 } else {
                   18337:                                     push(@possok,"*.$hoststr");
                   18338:                                 }
                   18339:                             }
                   18340:                             if (@possok) {
                   18341:                                 foreach my $poss (@possok) {
                   18342:                                     last if (!$uselink);
                   18343:                                     foreach my $policy (@policies) {
                   18344:                                         if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
                   18345:                                             undef($uselink);
                   18346:                                             last;
                   18347:                                         }
                   18348:                                     }
                   18349:                                 }
                   18350:                             }
                   18351:                         }
                   18352:                     }
                   18353:                 }
                   18354:             } elsif ($xframeop ne '') {
                   18355:                 $uselink = 1;
                   18356:                 my @policies = split(/\s*,\s*/,$xframeop);
                   18357:                 if (@policies) {
                   18358:                     unless (grep(/^deny$/,@policies)) {
                   18359:                         if ($origin ne '') {
                   18360:                             if (grep(/^sameorigin$/,@policies)) {
                   18361:                                 if ($remotehost eq $origin) {
                   18362:                                     undef($uselink);
                   18363:                                 }
                   18364:                             }
                   18365:                             if ($uselink) {
                   18366:                                 foreach my $policy (@policies) {
                   18367:                                     if ($policy =~ /^allow-from\s*(.+)$/) {
                   18368:                                         my $allowfrom = $1;
                   18369:                                         if (($allowfrom ne '') && ($allowfrom eq $origin)) {
                   18370:                                             undef($uselink);
                   18371:                                             last;
                   18372:                                         }
                   18373:                                     }
                   18374:                                 }
                   18375:                             }
                   18376:                         }
                   18377:                     }
                   18378:                 }
                   18379:             }
                   18380:         }
                   18381:     }
                   18382:     if ($nocache) {
                   18383:         if ($cached) {
                   18384:             my $devalidate;
                   18385:             if ($uselink && !$result) {
                   18386:                 $devalidate = 1;
                   18387:             } elsif (!$uselink && $result) {
                   18388:                 $devalidate = 1;
                   18389:             }
                   18390:             if ($devalidate) {
                   18391:                 &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
                   18392:             }
                   18393:         }
                   18394:     } else {
                   18395:         if ($uselink) {
                   18396:             $result = 1;
                   18397:         } else {
                   18398:             $result = 0;
                   18399:         }
                   18400:         &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
                   18401:     }
                   18402:     return $uselink;
                   18403: }
                   18404: 
1.1075.2.161.  .1(raebu 18405:21): sub page_menu {
                   18406:21):     my ($menucolls,$menunum) = @_;
                   18407:21):     my %menu;
                   18408:21):     foreach my $item (split(/;/,$menucolls)) {
                   18409:21):         my ($num,$value) = split(/\%/,$item);
                   18410:21):         if ($num eq $menunum) {
                   18411:21):             my @entries = split(/\&/,$value);
                   18412:21):             foreach my $entry (@entries) {
                   18413:21):                 my ($name,$fields) = split(/=/,$entry);
                   18414:21):                 if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
                   18415:21):                     $menu{$name} = $fields;
                   18416:21):                 } else {
                   18417:21):                     my @shown;
                   18418:21):                     if ($fields =~ /,/) {
                   18419:21):                         @shown = split(/,/,$fields);
                   18420:21):                     } else {
                   18421:21):                         @shown = ($fields);
                   18422:21):                     }
                   18423:21):                     if (@shown) {
                   18424:21):                         foreach my $field (@shown) {
                   18425:21):                             next if ($field eq '');
                   18426:21):                             $menu{$field} = 1;
                   18427:21):                         }
                   18428:21):                     }
                   18429:21):                 }
                   18430:21):             }
                   18431:21):         }
                   18432:21):     }
                   18433:21):     return %menu;
                   18434:21): }
                   18435:21): 
1.112     bowersj2 18436: 1;
                   18437: __END__;
1.41      ng       18438: 

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