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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.1075.2.141.  .7(raebu    4:20): # $Id: loncommon.pm,v 1.1075.2.141.2.6 2020/09/08 04:19:48 raeburn Exp $
1.10      albertel    5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
1.1       albertel   28: 
                     29: # Makes a table out of the previous attempts
1.2       albertel   30: # Inputs result_from_symbread, user, domain, course_id
1.16      harris41   31: # Reads in non-network-related .tab files
1.1       albertel   32: 
1.35      matthew    33: # POD header:
                     34: 
1.45      matthew    35: =pod
                     36: 
1.35      matthew    37: =head1 NAME
                     38: 
                     39: Apache::loncommon - pile of common routines
                     40: 
                     41: =head1 SYNOPSIS
                     42: 
1.112     bowersj2   43: Common routines for manipulating connections, student answers,
                     44:     domains, common Javascript fragments, etc.
1.35      matthew    45: 
1.112     bowersj2   46: =head1 OVERVIEW
1.35      matthew    47: 
1.112     bowersj2   48: A collection of commonly used subroutines that don't have a natural
                     49: home anywhere else. This collection helps remove
1.35      matthew    50: redundancy from other modules and increase efficiency of memory usage.
                     51: 
                     52: =cut 
                     53: 
                     54: # End of POD header
1.1       albertel   55: package Apache::loncommon;
                     56: 
                     57: use strict;
1.258     albertel   58: use Apache::lonnet;
1.46      matthew    59: use GDBM_File;
1.51      www        60: use POSIX qw(strftime mktime);
1.82      www        61: use Apache::lonmenu();
1.498     albertel   62: use Apache::lonenc();
1.117     www        63: use Apache::lonlocal;
1.685     tempelho   64: use Apache::lonnet();
1.139     matthew    65: use HTML::Entities;
1.334     albertel   66: use Apache::lonhtmlcommon();
                     67: use Apache::loncoursedata();
1.344     albertel   68: use Apache::lontexconvert();
1.444     albertel   69: use Apache::lonclonecourse();
1.1075.2.25  raeburn    70: use Apache::lonuserutils();
1.1075.2.27  raeburn    71: use Apache::lonuserstate();
1.1075.2.69  raeburn    72: use Apache::courseclassifier();
1.479     albertel   73: use LONCAPA qw(:DEFAULT :match);
1.1075.2.135  raeburn    74: use HTTP::Request;
1.657     raeburn    75: use DateTime::TimeZone;
1.1075.2.102  raeburn    76: use DateTime::Locale;
1.1075.2.94  raeburn    77: use Encode();
1.1075.2.14  raeburn    78: use Authen::Captcha;
                     79: use Captcha::reCAPTCHA;
1.1075.2.107  raeburn    80: use JSON::DWIW;
                     81: use LWP::UserAgent;
1.1075.2.64  raeburn    82: use Crypt::DES;
                     83: use DynaLoader; # for Crypt::DES version
1.1075.2.128  raeburn    84: use File::Copy();
                     85: use File::Path();
1.1075.2.141.  .1(raebu   86:20): use String::CRC32();
                     87:20): use Short::URL();
1.117     www        88: 
1.517     raeburn    89: # ---------------------------------------------- Designs
                     90: use vars qw(%defaultdesign);
                     91: 
1.22      www        92: my $readit;
                     93: 
1.517     raeburn    94: 
1.157     matthew    95: ##
                     96: ## Global Variables
                     97: ##
1.46      matthew    98: 
1.643     foxr       99: 
                    100: # ----------------------------------------------- SSI with retries:
                    101: #
                    102: 
                    103: =pod
                    104: 
1.648     raeburn   105: =head1 Server Side include with retries:
1.643     foxr      106: 
                    107: =over 4
                    108: 
1.648     raeburn   109: =item * &ssi_with_retries(resource,retries form)
1.643     foxr      110: 
                    111: Performs an ssi with some number of retries.  Retries continue either
                    112: until the result is ok or until the retry count supplied by the
                    113: caller is exhausted.  
                    114: 
                    115: Inputs:
1.648     raeburn   116: 
                    117: =over 4
                    118: 
1.643     foxr      119: resource   - Identifies the resource to insert.
1.648     raeburn   120: 
1.643     foxr      121: retries    - Count of the number of retries allowed.
1.648     raeburn   122: 
1.643     foxr      123: form       - Hash that identifies the rendering options.
                    124: 
1.648     raeburn   125: =back
                    126: 
                    127: Returns:
                    128: 
                    129: =over 4
                    130: 
1.643     foxr      131: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   132: 
1.643     foxr      133: response   - The response from the last attempt (which may or may not have been successful.
                    134: 
1.648     raeburn   135: =back
                    136: 
                    137: =back
                    138: 
1.643     foxr      139: =cut
                    140: 
                    141: sub ssi_with_retries {
                    142:     my ($resource, $retries, %form) = @_;
                    143: 
                    144: 
                    145:     my $ok = 0;			# True if we got a good response.
                    146:     my $content;
                    147:     my $response;
                    148: 
                    149:     # Try to get the ssi done. within the retries count:
                    150: 
                    151:     do {
                    152: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    153: 	$ok      = $response->is_success;
1.650     www       154:         if (!$ok) {
                    155:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    156:         }
1.643     foxr      157: 	$retries--;
                    158:     } while (!$ok && ($retries > 0));
                    159: 
                    160:     if (!$ok) {
                    161: 	$content = '';		# On error return an empty content.
                    162:     }
                    163:     return ($content, $response);
                    164: 
                    165: }
                    166: 
                    167: 
                    168: 
1.20      www       169: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  170: my %language;
1.124     www       171: my %supported_language;
1.1048    foxr      172: my %latex_language;		# For choosing hyphenation in <transl..>
                    173: my %latex_language_bykey;	# for choosing hyphenation from metadata
1.12      harris41  174: my %cprtag;
1.192     taceyjo1  175: my %scprtag;
1.351     www       176: my %fe; my %fd; my %fm;
1.41      ng        177: my %category_extensions;
1.12      harris41  178: 
1.46      matthew   179: # ---------------------------------------------- Thesaurus variables
1.144     matthew   180: #
                    181: # %Keywords:
                    182: #      A hash used by &keyword to determine if a word is considered a keyword.
                    183: # $thesaurus_db_file 
                    184: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   185: 
                    186: my %Keywords;
                    187: my $thesaurus_db_file;
                    188: 
1.144     matthew   189: #
                    190: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    191: # thesaurus.tab, and filecategories.tab.
                    192: #
1.18      www       193: BEGIN {
1.46      matthew   194:     # Variable initialization
                    195:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    196:     #
1.22      www       197:     unless ($readit) {
1.12      harris41  198: # ------------------------------------------------------------------- languages
                    199:     {
1.158     raeburn   200:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    201:                                    '/language.tab';
1.1075.2.128  raeburn   202:         if ( open(my $fh,'<',$langtabfile) ) {
1.356     albertel  203:             while (my $line = <$fh>) {
                    204:                 next if ($line=~/^\#/);
                    205:                 chomp($line);
1.1048    foxr      206:                 my ($key,$two,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158     raeburn   207:                 $language{$key}=$val.' - '.$enc;
                    208:                 if ($sup) {
                    209:                     $supported_language{$key}=$sup;
                    210:                 }
1.1048    foxr      211: 		if ($latex) {
                    212: 		    $latex_language_bykey{$key} = $latex;
                    213: 		    $latex_language{$two} = $latex;
                    214: 		}
1.158     raeburn   215:             }
                    216:             close($fh);
                    217:         }
1.12      harris41  218:     }
                    219: # ------------------------------------------------------------------ copyrights
                    220:     {
1.158     raeburn   221:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    222:                                   '/copyright.tab';
1.1075.2.128  raeburn   223:         if ( open (my $fh,'<',$copyrightfile) ) {
1.356     albertel  224:             while (my $line = <$fh>) {
                    225:                 next if ($line=~/^\#/);
                    226:                 chomp($line);
                    227:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   228:                 $cprtag{$key}=$val;
                    229:             }
                    230:             close($fh);
                    231:         }
1.12      harris41  232:     }
1.351     www       233: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  234:     {
                    235:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    236:                                   '/source_copyright.tab';
1.1075.2.128  raeburn   237:         if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356     albertel  238:             while (my $line = <$fh>) {
                    239:                 next if ($line =~ /^\#/);
                    240:                 chomp($line);
                    241:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  242:                 $scprtag{$key}=$val;
                    243:             }
                    244:             close($fh);
                    245:         }
                    246:     }
1.63      www       247: 
1.517     raeburn   248: # -------------------------------------------------------------- default domain designs
1.63      www       249:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   250:     my $designfile = $designdir.'/default.tab';
1.1075.2.128  raeburn   251:     if ( open (my $fh,'<',$designfile) ) {
1.517     raeburn   252:         while (my $line = <$fh>) {
                    253:             next if ($line =~ /^\#/);
                    254:             chomp($line);
                    255:             my ($key,$val)=(split(/\=/,$line));
                    256:             if ($val) { $defaultdesign{$key}=$val; }
                    257:         }
                    258:         close($fh);
1.63      www       259:     }
                    260: 
1.15      harris41  261: # ------------------------------------------------------------- file categories
                    262:     {
1.158     raeburn   263:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    264:                                   '/filecategories.tab';
1.1075.2.128  raeburn   265:         if ( open (my $fh,'<',$categoryfile) ) {
1.356     albertel  266: 	    while (my $line = <$fh>) {
                    267: 		next if ($line =~ /^\#/);
                    268: 		chomp($line);
                    269:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.1075.2.119  raeburn   270:                 push(@{$category_extensions{lc($category)}},$extension);
1.158     raeburn   271:             }
                    272:             close($fh);
                    273:         }
                    274: 
1.15      harris41  275:     }
1.12      harris41  276: # ------------------------------------------------------------------ file types
                    277:     {
1.158     raeburn   278:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    279:                '/filetypes.tab';
1.1075.2.128  raeburn   280:         if ( open (my $fh,'<',$typesfile) ) {
1.356     albertel  281:             while (my $line = <$fh>) {
                    282: 		next if ($line =~ /^\#/);
                    283: 		chomp($line);
                    284:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   285:                 if ($descr ne '') {
                    286:                     $fe{$ending}=lc($emb);
                    287:                     $fd{$ending}=$descr;
1.351     www       288:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   289:                 }
                    290:             }
                    291:             close($fh);
                    292:         }
1.12      harris41  293:     }
1.22      www       294:     &Apache::lonnet::logthis(
1.705     tempelho  295:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       296:     $readit=1;
1.46      matthew   297:     }  # end of unless($readit) 
1.32      matthew   298:     
                    299: }
1.112     bowersj2  300: 
1.42      matthew   301: ###############################################################
                    302: ##           HTML and Javascript Helper Functions            ##
                    303: ###############################################################
                    304: 
                    305: =pod 
                    306: 
1.112     bowersj2  307: =head1 HTML and Javascript Functions
1.42      matthew   308: 
1.112     bowersj2  309: =over 4
                    310: 
1.648     raeburn   311: =item * &browser_and_searcher_javascript()
1.112     bowersj2  312: 
                    313: X<browsing, javascript>X<searching, javascript>Returns a string
                    314: containing javascript with two functions, C<openbrowser> and
                    315: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    316: tags.
1.42      matthew   317: 
1.648     raeburn   318: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   319: 
                    320: inputs: formname, elementname, only, omit
                    321: 
                    322: formname and elementname indicate the name of the html form and name of
                    323: the element that the results of the browsing selection are to be placed in. 
                    324: 
                    325: Specifying 'only' will restrict the browser to displaying only files
1.185     www       326: with the given extension.  Can be a comma separated list.
1.42      matthew   327: 
                    328: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       329: with the given extension.  Can be a comma separated list.
1.42      matthew   330: 
1.648     raeburn   331: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   332: 
                    333: Inputs: formname, elementname
                    334: 
                    335: formname and elementname specify the name of the html form and the name
                    336: of the element the selection from the search results will be placed in.
1.542     raeburn   337: 
1.42      matthew   338: =cut
                    339: 
                    340: sub browser_and_searcher_javascript {
1.199     albertel  341:     my ($mode)=@_;
                    342:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  343:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   344:     return <<END;
1.219     albertel  345: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   346:     var editbrowser = null;
1.135     albertel  347:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       348:         var url = '$resurl/?';
1.42      matthew   349:         if (editbrowser == null) {
                    350:             url += 'launch=1&';
                    351:         }
                    352:         url += 'catalogmode=interactive&';
1.199     albertel  353:         url += 'mode=$mode&';
1.611     albertel  354:         url += 'inhibitmenu=yes&';
1.42      matthew   355:         url += 'form=' + formname + '&';
                    356:         if (only != null) {
                    357:             url += 'only=' + only + '&';
1.217     albertel  358:         } else {
                    359:             url += 'only=&';
                    360: 	}
1.42      matthew   361:         if (omit != null) {
                    362:             url += 'omit=' + omit + '&';
1.217     albertel  363:         } else {
                    364:             url += 'omit=&';
                    365: 	}
1.135     albertel  366:         if (titleelement != null) {
                    367:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  368:         } else {
                    369: 	    url += 'titleelement=&';
                    370: 	}
1.42      matthew   371:         url += 'element=' + elementname + '';
                    372:         var title = 'Browser';
1.435     albertel  373:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   374:         options += ',width=700,height=600';
                    375:         editbrowser = open(url,title,options,'1');
                    376:         editbrowser.focus();
                    377:     }
                    378:     var editsearcher;
1.135     albertel  379:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   380:         var url = '/adm/searchcat?';
                    381:         if (editsearcher == null) {
                    382:             url += 'launch=1&';
                    383:         }
                    384:         url += 'catalogmode=interactive&';
1.199     albertel  385:         url += 'mode=$mode&';
1.42      matthew   386:         url += 'form=' + formname + '&';
1.135     albertel  387:         if (titleelement != null) {
                    388:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  389:         } else {
                    390: 	    url += 'titleelement=&';
                    391: 	}
1.42      matthew   392:         url += 'element=' + elementname + '';
                    393:         var title = 'Search';
1.435     albertel  394:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   395:         options += ',width=700,height=600';
                    396:         editsearcher = open(url,title,options,'1');
                    397:         editsearcher.focus();
                    398:     }
1.219     albertel  399: // END LON-CAPA Internal -->
1.42      matthew   400: END
1.170     www       401: }
                    402: 
                    403: sub lastresurl {
1.258     albertel  404:     if ($env{'environment.lastresurl'}) {
                    405: 	return $env{'environment.lastresurl'}
1.170     www       406:     } else {
                    407: 	return '/res';
                    408:     }
                    409: }
                    410: 
                    411: sub storeresurl {
                    412:     my $resurl=&Apache::lonnet::clutter(shift);
                    413:     unless ($resurl=~/^\/res/) { return 0; }
                    414:     $resurl=~s/\/$//;
                    415:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   416:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       417:     return 1;
1.42      matthew   418: }
                    419: 
1.74      www       420: sub studentbrowser_javascript {
1.111     www       421:    unless (
1.258     albertel  422:             (($env{'request.course.id'}) && 
1.302     albertel  423:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    424: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    425: 					  '/'.$env{'request.course.sec'})
                    426: 	      ))
1.258     albertel  427:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       428:           ) { return ''; }  
1.74      www       429:    return (<<'ENDSTDBRW');
1.776     bisitz    430: <script type="text/javascript" language="Javascript">
1.824     bisitz    431: // <![CDATA[
1.74      www       432:     var stdeditbrowser;
1.1075.2.141.  .3(raebu  433:20):     function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadv) {
1.74      www       434:         var url = '/adm/pickstudent?';
                    435:         var filter;
1.558     albertel  436: 	if (!ignorefilter) {
                    437: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    438: 	}
1.74      www       439:         if (filter != null) {
                    440:            if (filter != '') {
                    441:                url += 'filter='+filter+'&';
                    442: 	   }
                    443:         }
                    444:         url += 'form=' + formname + '&unameelement='+uname+
1.999     www       445:                                     '&udomelement='+udom+
                    446:                                     '&clicker='+clicker;
1.111     www       447: 	if (roleflag) { url+="&roles=1"; }
1.1075.2.141.  .3(raebu  448:20):         if (courseadv == 'condition') {
                    449:20):             if (document.getElementById('courseadv')) {
                    450:20):                 courseadv = document.getElementById('courseadv').value;
                    451:20):             }
                    452:20):         }
                    453:20):         if ((courseadv == 'only') || (courseadv == 'none')) { url+="&courseadv="+courseadv; }
1.102     www       454:         var title = 'Student_Browser';
1.74      www       455:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    456:         options += ',width=700,height=600';
                    457:         stdeditbrowser = open(url,title,options,'1');
                    458:         stdeditbrowser.focus();
                    459:     }
1.824     bisitz    460: // ]]>
1.74      www       461: </script>
                    462: ENDSTDBRW
                    463: }
1.42      matthew   464: 
1.1003    www       465: sub resourcebrowser_javascript {
                    466:    unless ($env{'request.course.id'}) { return ''; }
1.1004    www       467:    return (<<'ENDRESBRW');
1.1003    www       468: <script type="text/javascript" language="Javascript">
                    469: // <![CDATA[
                    470:     var reseditbrowser;
1.1004    www       471:     function openresbrowser(formname,reslink) {
1.1005    www       472:         var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003    www       473:         var title = 'Resource_Browser';
                    474:         var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005    www       475:         options += ',width=700,height=500';
1.1004    www       476:         reseditbrowser = open(url,title,options,'1');
                    477:         reseditbrowser.focus();
1.1003    www       478:     }
                    479: // ]]>
                    480: </script>
1.1004    www       481: ENDRESBRW
1.1003    www       482: }
                    483: 
1.74      www       484: sub selectstudent_link {
1.1075.2.141.  .3(raebu  485:20):    my ($form,$unameele,$udomele,$courseadv,$clickerid)=@_;
1.999     www       486:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    487:                       &Apache::lonhtmlcommon::entity_encode($unameele)."','".
                    488:                       &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258     albertel  489:    if ($env{'request.course.id'}) {  
1.302     albertel  490:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    491: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    492: 					'/'.$env{'request.course.sec'})) {
1.111     www       493: 	   return '';
                    494:        }
1.999     www       495:        $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.1075.2.141.  .3(raebu  496:20):        if ($courseadv eq 'only') {
                    497:20):            $callargs .= ",'',1,'$courseadv'";
                    498:20):        } elsif ($courseadv eq 'none') {
                    499:20):            $callargs .= ",'','','$courseadv'";
                    500:20):        } elsif ($courseadv eq 'condition') {
                    501:20):            $callargs .= ",'','','$courseadv'";
1.793     raeburn   502:        }
                    503:        return '<span class="LC_nobreak">'.
                    504:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    505:               &mt('Select User').'</a></span>';
1.74      www       506:    }
1.258     albertel  507:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012    www       508:        $callargs .= ",'',1"; 
1.793     raeburn   509:        return '<span class="LC_nobreak">'.
                    510:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    511:               &mt('Select User').'</a></span>';
1.111     www       512:    }
                    513:    return '';
1.91      www       514: }
                    515: 
1.1004    www       516: sub selectresource_link {
                    517:    my ($form,$reslink,$arg)=@_;
                    518:    
                    519:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    520:                       &Apache::lonhtmlcommon::entity_encode($reslink)."'";
                    521:    unless ($env{'request.course.id'}) { return $arg; }
                    522:    return '<span class="LC_nobreak">'.
                    523:               '<a href="javascript:openresbrowser('.$callargs.');">'.
                    524:               $arg.'</a></span>';
                    525: }
                    526: 
                    527: 
                    528: 
1.653     raeburn   529: sub authorbrowser_javascript {
                    530:     return <<"ENDAUTHORBRW";
1.776     bisitz    531: <script type="text/javascript" language="JavaScript">
1.824     bisitz    532: // <![CDATA[
1.653     raeburn   533: var stdeditbrowser;
                    534: 
                    535: function openauthorbrowser(formname,udom) {
                    536:     var url = '/adm/pickauthor?';
                    537:     url += 'form='+formname+'&roledom='+udom;
                    538:     var title = 'Author_Browser';
                    539:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    540:     options += ',width=700,height=600';
                    541:     stdeditbrowser = open(url,title,options,'1');
                    542:     stdeditbrowser.focus();
                    543: }
                    544: 
1.824     bisitz    545: // ]]>
1.653     raeburn   546: </script>
                    547: ENDAUTHORBRW
                    548: }
                    549: 
1.91      www       550: sub coursebrowser_javascript {
1.1075.2.31  raeburn   551:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1075.2.95  raeburn   552:         $credits_element,$instcode) = @_;
1.932     raeburn   553:     my $wintitle = 'Course_Browser';
1.931     raeburn   554:     if ($crstype eq 'Community') {
1.932     raeburn   555:         $wintitle = 'Community_Browser';
1.909     raeburn   556:     }
1.876     raeburn   557:     my $id_functions = &javascript_index_functions();
                    558:     my $output = '
1.776     bisitz    559: <script type="text/javascript" language="JavaScript">
1.824     bisitz    560: // <![CDATA[
1.468     raeburn   561:     var stdeditbrowser;'."\n";
1.876     raeburn   562: 
                    563:     $output .= <<"ENDSTDBRW";
1.909     raeburn   564:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       565:         var url = '/adm/pickcourse?';
1.895     raeburn   566:         var formid = getFormIdByName(formname);
1.876     raeburn   567:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  568:         if (domainfilter != null) {
                    569:            if (domainfilter != '') {
                    570:                url += 'domainfilter='+domainfilter+'&';
                    571: 	   }
                    572:         }
1.91      www       573:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  574: 	                            '&cdomelement='+udom+
                    575:                                     '&cnameelement='+desc;
1.468     raeburn   576:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   577:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   578:                 url += '&roleelement='+extra_element;
                    579:                 if (domainfilter == null || domainfilter == '') {
                    580:                     url += '&domainfilter='+extra_element;
                    581:                 }
1.234     raeburn   582:             }
1.468     raeburn   583:             else {
                    584:                 if (formname == 'portform') {
                    585:                     url += '&setroles='+extra_element;
1.800     raeburn   586:                 } else {
                    587:                     if (formname == 'rules') {
                    588:                         url += '&fixeddom='+extra_element; 
                    589:                     }
1.468     raeburn   590:                 }
                    591:             }     
1.230     raeburn   592:         }
1.909     raeburn   593:         if (type != null && type != '') {
                    594:             url += '&type='+type;
                    595:         }
                    596:         if (type_elem != null && type_elem != '') {
                    597:             url += '&typeelement='+type_elem;
                    598:         }
1.872     raeburn   599:         if (formname == 'ccrs') {
                    600:             var ownername = document.forms[formid].ccuname.value;
                    601:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1075.2.101  raeburn   602:             url += '&cloner='+ownername+':'+ownerdom;
                    603:             if (type == 'Course') {
                    604:                 url += '&crscode='+document.forms[formid].crscode.value;
                    605:             }
1.1075.2.95  raeburn   606:         }
                    607:         if (formname == 'requestcrs') {
                    608:             url += '&crsdom=$domainfilter&crscode=$instcode';
1.872     raeburn   609:         }
1.293     raeburn   610:         if (multflag !=null && multflag != '') {
                    611:             url += '&multiple='+multflag;
                    612:         }
1.909     raeburn   613:         var title = '$wintitle';
1.91      www       614:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    615:         options += ',width=700,height=600';
                    616:         stdeditbrowser = open(url,title,options,'1');
                    617:         stdeditbrowser.focus();
                    618:     }
1.876     raeburn   619: $id_functions
                    620: ENDSTDBRW
1.1075.2.31  raeburn   621:     if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
                    622:         $output .= &setsec_javascript($sec_element,$formname,$role_element,
                    623:                                       $credits_element);
1.876     raeburn   624:     }
                    625:     $output .= '
                    626: // ]]>
                    627: </script>';
                    628:     return $output;
                    629: }
                    630: 
                    631: sub javascript_index_functions {
                    632:     return <<"ENDJS";
                    633: 
                    634: function getFormIdByName(formname) {
                    635:     for (var i=0;i<document.forms.length;i++) {
                    636:         if (document.forms[i].name == formname) {
                    637:             return i;
                    638:         }
                    639:     }
                    640:     return -1;
                    641: }
                    642: 
                    643: function getIndexByName(formid,item) {
                    644:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    645:         if (document.forms[formid].elements[i].name == item) {
                    646:             return i;
                    647:         }
                    648:     }
                    649:     return -1;
                    650: }
1.468     raeburn   651: 
1.876     raeburn   652: function getDomainFromSelectbox(formname,udom) {
                    653:     var userdom;
                    654:     var formid = getFormIdByName(formname);
                    655:     if (formid > -1) {
                    656:         var domid = getIndexByName(formid,udom);
                    657:         if (domid > -1) {
                    658:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    659:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    660:             }
                    661:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    662:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   663:             }
                    664:         }
                    665:     }
1.876     raeburn   666:     return userdom;
                    667: }
                    668: 
                    669: ENDJS
1.468     raeburn   670: 
1.876     raeburn   671: }
                    672: 
1.1017    raeburn   673: sub javascript_array_indexof {
1.1018    raeburn   674:     return <<ENDJS;
1.1017    raeburn   675: <script type="text/javascript" language="JavaScript">
                    676: // <![CDATA[
                    677: 
                    678: if (!Array.prototype.indexOf) {
                    679:     Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
                    680:         "use strict";
                    681:         if (this === void 0 || this === null) {
                    682:             throw new TypeError();
                    683:         }
                    684:         var t = Object(this);
                    685:         var len = t.length >>> 0;
                    686:         if (len === 0) {
                    687:             return -1;
                    688:         }
                    689:         var n = 0;
                    690:         if (arguments.length > 0) {
                    691:             n = Number(arguments[1]);
                    692:             if (n !== n) { // shortcut for verifying if it's NaN
                    693:                 n = 0;
                    694:             } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
                    695:                 n = (n > 0 || -1) * Math.floor(Math.abs(n));
                    696:             }
                    697:         }
                    698:         if (n >= len) {
                    699:             return -1;
                    700:         }
                    701:         var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
                    702:         for (; k < len; k++) {
                    703:             if (k in t && t[k] === searchElement) {
                    704:                 return k;
                    705:             }
                    706:         }
                    707:         return -1;
                    708:     }
                    709: }
                    710: 
                    711: // ]]>
                    712: </script>
                    713: 
                    714: ENDJS
                    715: 
                    716: }
                    717: 
1.876     raeburn   718: sub userbrowser_javascript {
                    719:     my $id_functions = &javascript_index_functions();
                    720:     return <<"ENDUSERBRW";
                    721: 
1.888     raeburn   722: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   723:     var url = '/adm/pickuser?';
                    724:     var userdom = getDomainFromSelectbox(formname,udom);
                    725:     if (userdom != null) {
                    726:        if (userdom != '') {
                    727:            url += 'srchdom='+userdom+'&';
                    728:        }
                    729:     }
                    730:     url += 'form=' + formname + '&unameelement='+uname+
                    731:                                 '&udomelement='+udom+
                    732:                                 '&ulastelement='+ulast+
                    733:                                 '&ufirstelement='+ufirst+
                    734:                                 '&uemailelement='+uemail+
1.881     raeburn   735:                                 '&hideudomelement='+hideudom+
                    736:                                 '&coursedom='+crsdom;
1.888     raeburn   737:     if ((caller != null) && (caller != undefined)) {
                    738:         url += '&caller='+caller;
                    739:     }
1.876     raeburn   740:     var title = 'User_Browser';
                    741:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    742:     options += ',width=700,height=600';
                    743:     var stdeditbrowser = open(url,title,options,'1');
                    744:     stdeditbrowser.focus();
                    745: }
                    746: 
1.888     raeburn   747: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   748:     var formid = getFormIdByName(formname);
                    749:     if (formid > -1) {
1.888     raeburn   750:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   751:         var domid = getIndexByName(formid,udom);
                    752:         var hidedomid = getIndexByName(formid,origdom);
                    753:         if (hidedomid > -1) {
                    754:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   755:             var unameval = document.forms[formid].elements[unameid].value;
                    756:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    757:                 if (domid > -1) {
                    758:                     var slct = document.forms[formid].elements[domid];
                    759:                     if (slct.type == 'select-one') {
                    760:                         var i;
                    761:                         for (i=0;i<slct.length;i++) {
                    762:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    763:                         }
                    764:                     }
                    765:                     if (slct.type == 'hidden') {
                    766:                         slct.value = fixeddom;
1.876     raeburn   767:                     }
                    768:                 }
1.468     raeburn   769:             }
                    770:         }
                    771:     }
1.876     raeburn   772:     return;
                    773: }
                    774: 
                    775: $id_functions
                    776: ENDUSERBRW
1.468     raeburn   777: }
                    778: 
                    779: sub setsec_javascript {
1.1075.2.31  raeburn   780:     my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905     raeburn   781:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    782:         $communityrolestr);
                    783:     if ($role_element ne '') {
                    784:         my @allroles = ('st','ta','ep','in','ad');
                    785:         foreach my $crstype ('Course','Community') {
                    786:             if ($crstype eq 'Community') {
                    787:                 foreach my $role (@allroles) {
                    788:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    789:                 }
                    790:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    791:             } else {
                    792:                 foreach my $role (@allroles) {
                    793:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    794:                 }
                    795:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    796:             }
                    797:         }
                    798:         $rolestr = '"'.join('","',@allroles).'"';
                    799:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    800:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    801:     }
1.468     raeburn   802:     my $setsections = qq|
                    803: function setSect(sectionlist) {
1.629     raeburn   804:     var sectionsArray = new Array();
                    805:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    806:         sectionsArray = sectionlist.split(",");
                    807:     }
1.468     raeburn   808:     var numSections = sectionsArray.length;
                    809:     document.$formname.$sec_element.length = 0;
                    810:     if (numSections == 0) {
                    811:         document.$formname.$sec_element.multiple=false;
                    812:         document.$formname.$sec_element.size=1;
                    813:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    814:     } else {
                    815:         if (numSections == 1) {
                    816:             document.$formname.$sec_element.multiple=false;
                    817:             document.$formname.$sec_element.size=1;
                    818:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    819:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    820:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    821:         } else {
                    822:             for (var i=0; i<numSections; i++) {
                    823:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    824:             }
                    825:             document.$formname.$sec_element.multiple=true
                    826:             if (numSections < 3) {
                    827:                 document.$formname.$sec_element.size=numSections;
                    828:             } else {
                    829:                 document.$formname.$sec_element.size=3;
                    830:             }
                    831:             document.$formname.$sec_element.options[0].selected = false
                    832:         }
                    833:     }
1.91      www       834: }
1.905     raeburn   835: 
                    836: function setRole(crstype) {
1.468     raeburn   837: |;
1.905     raeburn   838:     if ($role_element eq '') {
                    839:         $setsections .= '    return;
                    840: }
                    841: ';
                    842:     } else {
                    843:         $setsections .= qq|
                    844:     var elementLength = document.$formname.$role_element.length;
                    845:     var allroles = Array($rolestr);
                    846:     var courserolenames = Array($courserolestr);
                    847:     var communityrolenames = Array($communityrolestr);
                    848:     if (elementLength != undefined) {
                    849:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    850:             if (crstype == 'Course') {
                    851:                 return;
                    852:             } else {
                    853:                 allroles[5] = 'co';
                    854:                 for (var i=0; i<6; i++) {
                    855:                     document.$formname.$role_element.options[i].value = allroles[i];
                    856:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    857:                 }
                    858:             }
                    859:         } else {
                    860:             if (crstype == 'Community') {
                    861:                 return;
                    862:             } else {
                    863:                 allroles[5] = 'cc';
                    864:                 for (var i=0; i<6; i++) {
                    865:                     document.$formname.$role_element.options[i].value = allroles[i];
                    866:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    867:                 }
                    868:             }
                    869:         }
                    870:     }
                    871:     return;
                    872: }
                    873: |;
                    874:     }
1.1075.2.31  raeburn   875:     if ($credits_element) {
                    876:         $setsections .= qq|
                    877: function setCredits(defaultcredits) {
                    878:     document.$formname.$credits_element.value = defaultcredits;
                    879:     return;
                    880: }
                    881: |;
                    882:     }
1.468     raeburn   883:     return $setsections;
                    884: }
                    885: 
1.91      www       886: sub selectcourse_link {
1.909     raeburn   887:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    888:        $typeelement) = @_;
                    889:    my $type = $selecttype;
1.871     raeburn   890:    my $linktext = &mt('Select Course');
                    891:    if ($selecttype eq 'Community') {
1.909     raeburn   892:        $linktext = &mt('Select Community');
1.906     raeburn   893:    } elsif ($selecttype eq 'Course/Community') {
                    894:        $linktext = &mt('Select Course/Community');
1.909     raeburn   895:        $type = '';
1.1019    raeburn   896:    } elsif ($selecttype eq 'Select') {
                    897:        $linktext = &mt('Select');
                    898:        $type = '';
1.871     raeburn   899:    }
1.787     bisitz    900:    return '<span class="LC_nobreak">'
                    901:          ."<a href='"
                    902:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    903:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   904:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   905:          ."'>".$linktext.'</a>'
1.787     bisitz    906:          .'</span>';
1.74      www       907: }
1.42      matthew   908: 
1.653     raeburn   909: sub selectauthor_link {
                    910:    my ($form,$udom)=@_;
                    911:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    912:           &mt('Select Author').'</a>';
                    913: }
                    914: 
1.876     raeburn   915: sub selectuser_link {
1.881     raeburn   916:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   917:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   918:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   919:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   920:            ');">'.$linktext.'</a>';
1.876     raeburn   921: }
                    922: 
1.273     raeburn   923: sub check_uncheck_jscript {
                    924:     my $jscript = <<"ENDSCRT";
                    925: function checkAll(field) {
                    926:     if (field.length > 0) {
                    927:         for (i = 0; i < field.length; i++) {
1.1075.2.14  raeburn   928:             if (!field[i].disabled) {
                    929:                 field[i].checked = true;
                    930:             }
1.273     raeburn   931:         }
                    932:     } else {
1.1075.2.14  raeburn   933:         if (!field.disabled) {
                    934:             field.checked = true;
                    935:         }
1.273     raeburn   936:     }
                    937: }
                    938:  
                    939: function uncheckAll(field) {
                    940:     if (field.length > 0) {
                    941:         for (i = 0; i < field.length; i++) {
                    942:             field[i].checked = false ;
1.543     albertel  943:         }
                    944:     } else {
1.273     raeburn   945:         field.checked = false ;
                    946:     }
                    947: }
                    948: ENDSCRT
                    949:     return $jscript;
                    950: }
                    951: 
1.656     www       952: sub select_timezone {
1.1075.2.115  raeburn   953:    my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
                    954:    my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.659     raeburn   955:    if ($includeempty) {
                    956:        $output .= '<option value=""';
                    957:        if (($selected eq '') || ($selected eq 'local')) {
                    958:            $output .= ' selected="selected" ';
                    959:        }
                    960:        $output .= '> </option>';
                    961:    }
1.657     raeburn   962:    my @timezones = DateTime::TimeZone->all_names;
                    963:    foreach my $tzone (@timezones) {
                    964:        $output.= '<option value="'.$tzone.'"';
                    965:        if ($tzone eq $selected) {
                    966:            $output.=' selected="selected"';
                    967:        }
                    968:        $output.=">$tzone</option>\n";
1.656     www       969:    }
                    970:    $output.="</select>";
                    971:    return $output;
                    972: }
1.273     raeburn   973: 
1.687     raeburn   974: sub select_datelocale {
1.1075.2.115  raeburn   975:     my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
                    976:     my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687     raeburn   977:     if ($includeempty) {
                    978:         $output .= '<option value=""';
                    979:         if ($selected eq '') {
                    980:             $output .= ' selected="selected" ';
                    981:         }
                    982:         $output .= '> </option>';
                    983:     }
1.1075.2.102  raeburn   984:     my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   985:     my (@possibles,%locale_names);
1.1075.2.102  raeburn   986:     my @locales = DateTime::Locale->ids();
                    987:     foreach my $id (@locales) {
                    988:         if ($id ne '') {
                    989:             my ($en_terr,$native_terr);
                    990:             my $loc = DateTime::Locale->load($id);
                    991:             if (ref($loc)) {
                    992:                 $en_terr = $loc->name();
                    993:                 $native_terr = $loc->native_name();
1.687     raeburn   994:                 if (grep(/^en$/,@languages) || !@languages) {
                    995:                     if ($en_terr ne '') {
                    996:                         $locale_names{$id} = '('.$en_terr.')';
                    997:                     } elsif ($native_terr ne '') {
                    998:                         $locale_names{$id} = $native_terr;
                    999:                     }
                   1000:                 } else {
                   1001:                     if ($native_terr ne '') {
                   1002:                         $locale_names{$id} = $native_terr.' ';
                   1003:                     } elsif ($en_terr ne '') {
                   1004:                         $locale_names{$id} = '('.$en_terr.')';
                   1005:                     }
                   1006:                 }
1.1075.2.94  raeburn  1007:                 $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1075.2.102  raeburn  1008:                 push(@possibles,$id);
1.687     raeburn  1009:             }
                   1010:         }
                   1011:     }
                   1012:     foreach my $item (sort(@possibles)) {
                   1013:         $output.= '<option value="'.$item.'"';
                   1014:         if ($item eq $selected) {
                   1015:             $output.=' selected="selected"';
                   1016:         }
                   1017:         $output.=">$item";
                   1018:         if ($locale_names{$item} ne '') {
1.1075.2.94  raeburn  1019:             $output.='  '.$locale_names{$item};
1.687     raeburn  1020:         }
                   1021:         $output.="</option>\n";
                   1022:     }
                   1023:     $output.="</select>";
                   1024:     return $output;
                   1025: }
                   1026: 
1.792     raeburn  1027: sub select_language {
1.1075.2.115  raeburn  1028:     my ($name,$selected,$includeempty,$noedit) = @_;
1.792     raeburn  1029:     my %langchoices;
                   1030:     if ($includeempty) {
1.1075.2.32  raeburn  1031:         %langchoices = ('' => 'No language preference');
1.792     raeburn  1032:     }
                   1033:     foreach my $id (&languageids()) {
                   1034:         my $code = &supportedlanguagecode($id);
                   1035:         if ($code) {
                   1036:             $langchoices{$code} = &plainlanguagedescription($id);
                   1037:         }
                   1038:     }
1.1075.2.32  raeburn  1039:     %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1075.2.115  raeburn  1040:     return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792     raeburn  1041: }
                   1042: 
1.42      matthew  1043: =pod
1.36      matthew  1044: 
1.648     raeburn  1045: =item * &linked_select_forms(...)
1.36      matthew  1046: 
                   1047: linked_select_forms returns a string containing a <script></script> block
                   1048: and html for two <select> menus.  The select menus will be linked in that
                   1049: changing the value of the first menu will result in new values being placed
                   1050: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn  1051: order unless a defined order is provided.
1.36      matthew  1052: 
                   1053: linked_select_forms takes the following ordered inputs:
                   1054: 
                   1055: =over 4
                   1056: 
1.112     bowersj2 1057: =item * $formname, the name of the <form> tag
1.36      matthew  1058: 
1.112     bowersj2 1059: =item * $middletext, the text which appears between the <select> tags
1.36      matthew  1060: 
1.112     bowersj2 1061: =item * $firstdefault, the default value for the first menu
1.36      matthew  1062: 
1.112     bowersj2 1063: =item * $firstselectname, the name of the first <select> tag
1.36      matthew  1064: 
1.112     bowersj2 1065: =item * $secondselectname, the name of the second <select> tag
1.36      matthew  1066: 
1.112     bowersj2 1067: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew  1068: 
1.609     raeburn  1069: =item * $menuorder, the order of values in the first menu
                   1070: 
1.1075.2.31  raeburn  1071: =item * $onchangefirst, additional javascript call to execute for an onchange
                   1072:         event for the first <select> tag
                   1073: 
                   1074: =item * $onchangesecond, additional javascript call to execute for an onchange
                   1075:         event for the second <select> tag
                   1076: 
1.41      ng       1077: =back 
                   1078: 
1.36      matthew  1079: Below is an example of such a hash.  Only the 'text', 'default', and 
                   1080: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                   1081: values for the first select menu.  The text that coincides with the 
1.41      ng       1082: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew  1083: and text for the second menu are given in the hash pointed to by 
                   1084: $menu{$choice1}->{'select2'}.  
                   1085: 
1.112     bowersj2 1086:  my %menu = ( A1 => { text =>"Choice A1" ,
                   1087:                        default => "B3",
                   1088:                        select2 => { 
                   1089:                            B1 => "Choice B1",
                   1090:                            B2 => "Choice B2",
                   1091:                            B3 => "Choice B3",
                   1092:                            B4 => "Choice B4"
1.609     raeburn  1093:                            },
                   1094:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2 1095:                    },
                   1096:                A2 => { text =>"Choice A2" ,
                   1097:                        default => "C2",
                   1098:                        select2 => { 
                   1099:                            C1 => "Choice C1",
                   1100:                            C2 => "Choice C2",
                   1101:                            C3 => "Choice C3"
1.609     raeburn  1102:                            },
                   1103:                        order => ['C2','C1','C3'],
1.112     bowersj2 1104:                    },
                   1105:                A3 => { text =>"Choice A3" ,
                   1106:                        default => "D6",
                   1107:                        select2 => { 
                   1108:                            D1 => "Choice D1",
                   1109:                            D2 => "Choice D2",
                   1110:                            D3 => "Choice D3",
                   1111:                            D4 => "Choice D4",
                   1112:                            D5 => "Choice D5",
                   1113:                            D6 => "Choice D6",
                   1114:                            D7 => "Choice D7"
1.609     raeburn  1115:                            },
                   1116:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2 1117:                    }
                   1118:                );
1.36      matthew  1119: 
                   1120: =cut
                   1121: 
                   1122: sub linked_select_forms {
                   1123:     my ($formname,
                   1124:         $middletext,
                   1125:         $firstdefault,
                   1126:         $firstselectname,
                   1127:         $secondselectname, 
1.609     raeburn  1128:         $hashref,
                   1129:         $menuorder,
1.1075.2.31  raeburn  1130:         $onchangefirst,
                   1131:         $onchangesecond
1.36      matthew  1132:         ) = @_;
                   1133:     my $second = "document.$formname.$secondselectname";
                   1134:     my $first = "document.$formname.$firstselectname";
                   1135:     # output the javascript to do the changing
                   1136:     my $result = '';
1.776     bisitz   1137:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz   1138:     $result.="// <![CDATA[\n";
1.36      matthew  1139:     $result.="var select2data = new Object();\n";
                   1140:     $" = '","';
                   1141:     my $debug = '';
                   1142:     foreach my $s1 (sort(keys(%$hashref))) {
                   1143:         $result.="select2data.d_$s1 = new Object();\n";        
                   1144:         $result.="select2data.d_$s1.def = new String('".
                   1145:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn  1146:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew  1147:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1148:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1149:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1150:         }
1.36      matthew  1151:         $result.="\"@s2values\");\n";
                   1152:         $result.="select2data.d_$s1.texts = new Array(";        
                   1153:         my @s2texts;
                   1154:         foreach my $value (@s2values) {
1.1075.2.119  raeburn  1155:             push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36      matthew  1156:         }
                   1157:         $result.="\"@s2texts\");\n";
                   1158:     }
                   1159:     $"=' ';
                   1160:     $result.= <<"END";
                   1161: 
                   1162: function select1_changed() {
                   1163:     // Determine new choice
                   1164:     var newvalue = "d_" + $first.value;
                   1165:     // update select2
                   1166:     var values     = select2data[newvalue].values;
                   1167:     var texts      = select2data[newvalue].texts;
                   1168:     var select2def = select2data[newvalue].def;
                   1169:     var i;
                   1170:     // out with the old
                   1171:     for (i = 0; i < $second.options.length; i++) {
                   1172:         $second.options[i] = null;
                   1173:     }
                   1174:     // in with the nuclear
                   1175:     for (i=0;i<values.length; i++) {
                   1176:         $second.options[i] = new Option(values[i]);
1.143     matthew  1177:         $second.options[i].value = values[i];
1.36      matthew  1178:         $second.options[i].text = texts[i];
                   1179:         if (values[i] == select2def) {
                   1180:             $second.options[i].selected = true;
                   1181:         }
                   1182:     }
                   1183: }
1.824     bisitz   1184: // ]]>
1.36      matthew  1185: </script>
                   1186: END
                   1187:     # output the initial values for the selection lists
1.1075.2.31  raeburn  1188:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed();$onchangefirst\">\n";
1.609     raeburn  1189:     my @order = sort(keys(%{$hashref}));
                   1190:     if (ref($menuorder) eq 'ARRAY') {
                   1191:         @order = @{$menuorder};
                   1192:     }
                   1193:     foreach my $value (@order) {
1.36      matthew  1194:         $result.="    <option value=\"$value\" ";
1.253     albertel 1195:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1196:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1197:     }
                   1198:     $result .= "</select>\n";
                   1199:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1200:     $result .= $middletext;
1.1075.2.31  raeburn  1201:     $result .= "<select size=\"1\" name=\"$secondselectname\"";
                   1202:     if ($onchangesecond) {
                   1203:         $result .= ' onchange="'.$onchangesecond.'"';
                   1204:     }
                   1205:     $result .= ">\n";
1.36      matthew  1206:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1207:     
                   1208:     my @secondorder = sort(keys(%select2));
                   1209:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1210:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1211:     }
                   1212:     foreach my $value (@secondorder) {
1.36      matthew  1213:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1214:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1215:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1216:     }
                   1217:     $result .= "</select>\n";
                   1218:     #    return $debug;
                   1219:     return $result;
                   1220: }   #  end of sub linked_select_forms {
                   1221: 
1.45      matthew  1222: =pod
1.44      bowersj2 1223: 
1.973     raeburn  1224: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44      bowersj2 1225: 
1.112     bowersj2 1226: Returns a string corresponding to an HTML link to the given help
                   1227: $topic, where $topic corresponds to the name of a .tex file in
                   1228: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1229: spaces. 
                   1230: 
                   1231: $text will optionally be linked to the same topic, allowing you to
                   1232: link text in addition to the graphic. If you do not want to link
                   1233: text, but wish to specify one of the later parameters, pass an
                   1234: empty string. 
                   1235: 
                   1236: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1237: the link will not open a new window. If false, the link will open
                   1238: a new window using Javascript. (Default is false.) 
                   1239: 
                   1240: $width and $height are optional numerical parameters that will
                   1241: override the width and height of the popped up window, which may
1.973     raeburn  1242: be useful for certain help topics with big pictures included.
                   1243: 
                   1244: $imgid is the id of the img tag used for the help icon. This may be
                   1245: used in a javascript call to switch the image src.  See 
                   1246: lonhtmlcommon::htmlareaselectactive() for an example.
1.44      bowersj2 1247: 
                   1248: =cut
                   1249: 
                   1250: sub help_open_topic {
1.973     raeburn  1251:     my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48      bowersj2 1252:     $text = "" if (not defined $text);
1.44      bowersj2 1253:     $stayOnPage = 0 if (not defined $stayOnPage);
1.1033    www      1254:     $width = 500 if (not defined $width);
1.44      bowersj2 1255:     $height = 400 if (not defined $height);
                   1256:     my $filename = $topic;
                   1257:     $filename =~ s/ /_/g;
                   1258: 
1.48      bowersj2 1259:     my $template = "";
                   1260:     my $link;
1.572     banghart 1261:     
1.159     www      1262:     $topic=~s/\W/\_/g;
1.44      bowersj2 1263: 
1.572     banghart 1264:     if (!$stayOnPage) {
1.1075.2.50  raeburn  1265:         if ($env{'browser.mobile'}) {
                   1266: 	    $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
                   1267:         } else {
                   1268:             $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1269:         }
1.1037    www      1270:     } elsif ($stayOnPage eq 'popup') {
                   1271:         $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572     banghart 1272:     } else {
1.48      bowersj2 1273: 	$link = "/adm/help/${filename}.hlp";
                   1274:     }
                   1275: 
                   1276:     # Add the text
1.755     neumanie 1277:     if ($text ne "") {	
1.763     bisitz   1278: 	$template.='<span class="LC_help_open_topic">'
                   1279:                   .'<a target="_top" href="'.$link.'">'
                   1280:                   .$text.'</a>';
1.48      bowersj2 1281:     }
                   1282: 
1.763     bisitz   1283:     # (Always) Add the graphic
1.179     matthew  1284:     my $title = &mt('Online Help');
1.667     raeburn  1285:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973     raeburn  1286:     if ($imgid ne '') {
                   1287:         $imgid = ' id="'.$imgid.'"';
                   1288:     }
1.763     bisitz   1289:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1290:               .'<img src="'.$helpicon.'" border="0"'
                   1291:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973     raeburn  1292:               .' title="'.$title.'" style="vertical-align:middle;"'.$imgid 
1.763     bisitz   1293:               .' /></a>';
                   1294:     if ($text ne "") {	
                   1295:         $template.='</span>';
                   1296:     }
1.44      bowersj2 1297:     return $template;
                   1298: 
1.106     bowersj2 1299: }
                   1300: 
                   1301: # This is a quicky function for Latex cheatsheet editing, since it 
                   1302: # appears in at least four places
                   1303: sub helpLatexCheatsheet {
1.1037    www      1304:     my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732     raeburn  1305:     my $out;
1.106     bowersj2 1306:     my $addOther = '';
1.732     raeburn  1307:     if ($topic) {
1.1037    www      1308: 	$addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763     bisitz   1309:     }
                   1310:     $out = '<span>' # Start cheatsheet
                   1311: 	  .$addOther
                   1312:           .'<span>'
1.1037    www      1313: 	  .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1314: 	  .'</span> <span>'
1.1037    www      1315: 	  .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1316: 	  .'</span>';
1.732     raeburn  1317:     unless ($not_author) {
1.763     bisitz   1318:         $out .= ' <span>'
1.1037    www      1319: 	       .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.1075.2.71  raeburn  1320: 	       .'</span> <span>'
1.1075.2.78  raeburn  1321:                .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.1075.2.71  raeburn  1322:                .'</span>';
1.732     raeburn  1323:     }
1.763     bisitz   1324:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1325:     return $out;
1.172     www      1326: }
                   1327: 
1.430     albertel 1328: sub general_help {
                   1329:     my $helptopic='Student_Intro';
                   1330:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1331: 	$helptopic='Authoring_Intro';
1.907     raeburn  1332:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1333: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1334:     } elsif ($env{'request.role'}=~/^dc/) {
                   1335:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1336:     }
                   1337:     return $helptopic;
                   1338: }
                   1339: 
                   1340: sub update_help_link {
                   1341:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1342:     my $origurl = $ENV{'REQUEST_URI'};
                   1343:     $origurl=~s|^/~|/priv/|;
                   1344:     my $timestamp = time;
                   1345:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1346:         $$datum = &escape($$datum);
                   1347:     }
                   1348: 
                   1349:     my $banner_link = "/adm/helpmenu?page=banner&amp;topic=$topic&amp;component_help=$component_help&amp;faq=$faq&amp;bug=$bug&amp;origurl=$origurl&amp;stamp=$timestamp&amp;stayonpage=$stayOnPage";
                   1350:     my $output .= <<"ENDOUTPUT";
                   1351: <script type="text/javascript">
1.824     bisitz   1352: // <![CDATA[
1.430     albertel 1353: banner_link = '$banner_link';
1.824     bisitz   1354: // ]]>
1.430     albertel 1355: </script>
                   1356: ENDOUTPUT
                   1357:     return $output;
                   1358: }
                   1359: 
                   1360: # now just updates the help link and generates a blue icon
1.193     raeburn  1361: sub help_open_menu {
1.430     albertel 1362:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1363: 	= @_;    
1.949     droeschl 1364:     $stayOnPage = 1;
1.430     albertel 1365:     my $output;
                   1366:     if ($component_help) {
                   1367: 	if (!$text) {
                   1368: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1369: 				       $width,$height);
                   1370: 	} else {
                   1371: 	    my $help_text;
                   1372: 	    $help_text=&unescape($topic);
                   1373: 	    $output='<table><tr><td>'.
                   1374: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1375: 				 $width,$height).'</td></tr></table>';
                   1376: 	}
                   1377:     }
                   1378:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1379:     return $output.$banner_link;
                   1380: }
                   1381: 
                   1382: sub top_nav_help {
                   1383:     my ($text) = @_;
1.436     albertel 1384:     $text = &mt($text);
1.1075.2.60  raeburn  1385:     my $stay_on_page;
                   1386:     unless ($env{'environment.remote'} eq 'on') {
                   1387:         $stay_on_page = 1;
                   1388:     }
1.1075.2.61  raeburn  1389:     my ($link,$banner_link);
                   1390:     unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
                   1391:         $link = ($stay_on_page) ? "javascript:helpMenu('display')"
                   1392: 	                         : "javascript:helpMenu('open')";
                   1393:         $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
                   1394:     }
1.201     raeburn  1395:     my $title = &mt('Get help');
1.1075.2.61  raeburn  1396:     if ($link) {
                   1397:         return <<"END";
1.436     albertel 1398: $banner_link
1.1075.2.56  raeburn  1399: <a href="$link" title="$title">$text</a>
1.436     albertel 1400: END
1.1075.2.61  raeburn  1401:     } else {
                   1402:         return '&nbsp;'.$text.'&nbsp;';
                   1403:     }
1.436     albertel 1404: }
                   1405: 
                   1406: sub help_menu_js {
1.1075.2.52  raeburn  1407:     my ($httphost) = @_;
1.949     droeschl 1408:     my $stayOnPage = 1;
1.436     albertel 1409:     my $width = 620;
                   1410:     my $height = 600;
1.430     albertel 1411:     my $helptopic=&general_help();
1.1075.2.52  raeburn  1412:     my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1413:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1414:     my $start_page =
                   1415:         &Apache::loncommon::start_page('Help Menu', undef,
                   1416: 				       {'frameset'    => 1,
                   1417: 					'js_ready'    => 1,
1.1075.2.136  raeburn  1418:                                         'use_absolute' => $httphost,
1.331     albertel 1419: 					'add_entries' => {
                   1420: 					    'border' => '0',
1.579     raeburn  1421: 					    'rows'   => "110,*",},});
1.331     albertel 1422:     my $end_page =
                   1423:         &Apache::loncommon::end_page({'frameset' => 1,
                   1424: 				      'js_ready' => 1,});
                   1425: 
1.436     albertel 1426:     my $template .= <<"ENDTEMPLATE";
                   1427: <script type="text/javascript">
1.877     bisitz   1428: // <![CDATA[
1.253     albertel 1429: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1430: var banner_link = '';
1.243     raeburn  1431: function helpMenu(target) {
                   1432:     var caller = this;
                   1433:     if (target == 'open') {
                   1434:         var newWindow = null;
                   1435:         try {
1.262     albertel 1436:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1437:         }
                   1438:         catch(error) {
                   1439:             writeHelp(caller);
                   1440:             return;
                   1441:         }
                   1442:         if (newWindow) {
                   1443:             caller = newWindow;
                   1444:         }
1.193     raeburn  1445:     }
1.243     raeburn  1446:     writeHelp(caller);
                   1447:     return;
                   1448: }
                   1449: function writeHelp(caller) {
1.1075.2.61  raeburn  1450:     caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
                   1451:     caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
                   1452:     caller.document.close();
                   1453:     caller.focus();
1.193     raeburn  1454: }
1.877     bisitz   1455: // END LON-CAPA Internal -->
1.253     albertel 1456: // ]]>
1.436     albertel 1457: </script>
1.193     raeburn  1458: ENDTEMPLATE
                   1459:     return $template;
                   1460: }
                   1461: 
1.172     www      1462: sub help_open_bug {
                   1463:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1464:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1465:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1466:     $text = "" if (not defined $text);
                   1467: 	$stayOnPage=1;
1.184     albertel 1468:     $width = 600 if (not defined $width);
                   1469:     $height = 600 if (not defined $height);
1.172     www      1470: 
                   1471:     $topic=~s/\W+/\+/g;
                   1472:     my $link='';
                   1473:     my $template='';
1.379     albertel 1474:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1475: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1476:     if (!$stayOnPage)
                   1477:     {
                   1478: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1479:     }
                   1480:     else
                   1481:     {
                   1482: 	$link = $url;
                   1483:     }
                   1484:     # Add the text
                   1485:     if ($text ne "")
                   1486:     {
                   1487: 	$template .= 
                   1488:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1489:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1490:     }
                   1491: 
                   1492:     # Add the graphic
1.179     matthew  1493:     my $title = &mt('Report a Bug');
1.215     albertel 1494:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1495:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1496:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1497: ENDTEMPLATE
                   1498:     if ($text ne '') { $template.='</td></tr></table>' };
                   1499:     return $template;
                   1500: 
                   1501: }
                   1502: 
                   1503: sub help_open_faq {
                   1504:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1505:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1506:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1507:     $text = "" if (not defined $text);
                   1508: 	$stayOnPage=1;
                   1509:     $width = 350 if (not defined $width);
                   1510:     $height = 400 if (not defined $height);
                   1511: 
                   1512:     $topic=~s/\W+/\+/g;
                   1513:     my $link='';
                   1514:     my $template='';
                   1515:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1516:     if (!$stayOnPage)
                   1517:     {
                   1518: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1519:     }
                   1520:     else
                   1521:     {
                   1522: 	$link = $url;
                   1523:     }
                   1524: 
                   1525:     # Add the text
                   1526:     if ($text ne "")
                   1527:     {
                   1528: 	$template .= 
1.173     www      1529:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1530:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1531:     }
                   1532: 
                   1533:     # Add the graphic
1.179     matthew  1534:     my $title = &mt('View the FAQ');
1.215     albertel 1535:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1536:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1537:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1538: ENDTEMPLATE
                   1539:     if ($text ne '') { $template.='</td></tr></table>' };
                   1540:     return $template;
                   1541: 
1.44      bowersj2 1542: }
1.37      matthew  1543: 
1.180     matthew  1544: ###############################################################
                   1545: ###############################################################
                   1546: 
1.45      matthew  1547: =pod
                   1548: 
1.648     raeburn  1549: =item * &change_content_javascript():
1.256     matthew  1550: 
                   1551: This and the next function allow you to create small sections of an
                   1552: otherwise static HTML page that you can update on the fly with
                   1553: Javascript, even in Netscape 4.
                   1554: 
                   1555: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1556: must be written to the HTML page once. It will prove the Javascript
                   1557: function "change(name, content)". Calling the change function with the
                   1558: name of the section 
                   1559: you want to update, matching the name passed to C<changable_area>, and
                   1560: the new content you want to put in there, will put the content into
                   1561: that area.
                   1562: 
                   1563: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1564: to contain room for the original contents. You need to "make space"
                   1565: for whatever changes you wish to make, and be B<sure> to check your
                   1566: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1567: it's adequate for updating a one-line status display, but little more.
                   1568: This script will set the space to 100% width, so you only need to
                   1569: worry about height in Netscape 4.
                   1570: 
                   1571: Modern browsers are much less limiting, and if you can commit to the
                   1572: user not using Netscape 4, this feature may be used freely with
                   1573: pretty much any HTML.
                   1574: 
                   1575: =cut
                   1576: 
                   1577: sub change_content_javascript {
                   1578:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1579:     if ($env{'browser.type'} eq 'netscape' &&
                   1580: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1581: 	return (<<NETSCAPE4);
                   1582: 	function change(name, content) {
                   1583: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1584: 	    doc.open();
                   1585: 	    doc.write(content);
                   1586: 	    doc.close();
                   1587: 	}
                   1588: NETSCAPE4
                   1589:     } else {
                   1590: 	# Otherwise, we need to use semi-standards-compliant code
                   1591: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1592: 	# is really scary, and every useful browser supports it
                   1593: 	return (<<DOMBASED);
                   1594: 	function change(name, content) {
                   1595: 	    element = document.getElementById(name);
                   1596: 	    element.innerHTML = content;
                   1597: 	}
                   1598: DOMBASED
                   1599:     }
                   1600: }
                   1601: 
                   1602: =pod
                   1603: 
1.648     raeburn  1604: =item * &changable_area($name,$origContent):
1.256     matthew  1605: 
                   1606: This provides a "changable area" that can be modified on the fly via
                   1607: the Javascript code provided in C<change_content_javascript>. $name is
                   1608: the name you will use to reference the area later; do not repeat the
                   1609: same name on a given HTML page more then once. $origContent is what
                   1610: the area will originally contain, which can be left blank.
                   1611: 
                   1612: =cut
                   1613: 
                   1614: sub changable_area {
                   1615:     my ($name, $origContent) = @_;
                   1616: 
1.258     albertel 1617:     if ($env{'browser.type'} eq 'netscape' &&
                   1618: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1619: 	# If this is netscape 4, we need to use the Layer tag
                   1620: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1621:     } else {
                   1622: 	return "<span id='$name'>$origContent</span>";
                   1623:     }
                   1624: }
                   1625: 
                   1626: =pod
                   1627: 
1.648     raeburn  1628: =item * &viewport_geometry_js 
1.590     raeburn  1629: 
                   1630: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1631: 
                   1632: =cut
                   1633: 
                   1634: 
                   1635: sub viewport_geometry_js { 
                   1636:     return <<"GEOMETRY";
                   1637: var Geometry = {};
                   1638: function init_geometry() {
                   1639:     if (Geometry.init) { return };
                   1640:     Geometry.init=1;
                   1641:     if (window.innerHeight) {
                   1642:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1643:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1644:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1645:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1646:     }
                   1647:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1648:         Geometry.getViewportHeight =
                   1649:             function() { return document.documentElement.clientHeight; };
                   1650:         Geometry.getViewportWidth =
                   1651:             function() { return document.documentElement.clientWidth; };
                   1652: 
                   1653:         Geometry.getHorizontalScroll =
                   1654:             function() { return document.documentElement.scrollLeft; };
                   1655:         Geometry.getVerticalScroll =
                   1656:             function() { return document.documentElement.scrollTop; };
                   1657:     }
                   1658:     else if (document.body.clientHeight) {
                   1659:         Geometry.getViewportHeight =
                   1660:             function() { return document.body.clientHeight; };
                   1661:         Geometry.getViewportWidth =
                   1662:             function() { return document.body.clientWidth; };
                   1663:         Geometry.getHorizontalScroll =
                   1664:             function() { return document.body.scrollLeft; };
                   1665:         Geometry.getVerticalScroll =
                   1666:             function() { return document.body.scrollTop; };
                   1667:     }
                   1668: }
                   1669: 
                   1670: GEOMETRY
                   1671: }
                   1672: 
                   1673: =pod
                   1674: 
1.648     raeburn  1675: =item * &viewport_size_js()
1.590     raeburn  1676: 
                   1677: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window. 
                   1678: 
                   1679: =cut
                   1680: 
                   1681: sub viewport_size_js {
                   1682:     my $geometry = &viewport_geometry_js();
                   1683:     return <<"DIMS";
                   1684: 
                   1685: $geometry
                   1686: 
                   1687: function getViewportDims(width,height) {
                   1688:     init_geometry();
                   1689:     width.value = Geometry.getViewportWidth();
                   1690:     height.value = Geometry.getViewportHeight();
                   1691:     return;
                   1692: }
                   1693: 
                   1694: DIMS
                   1695: }
                   1696: 
                   1697: =pod
                   1698: 
1.648     raeburn  1699: =item * &resize_textarea_js()
1.565     albertel 1700: 
                   1701: emits the needed javascript to resize a textarea to be as big as possible
                   1702: 
                   1703: creates a function resize_textrea that takes two IDs first should be
                   1704: the id of the element to resize, second should be the id of a div that
                   1705: surrounds everything that comes after the textarea, this routine needs
                   1706: to be attached to the <body> for the onload and onresize events.
                   1707: 
1.648     raeburn  1708: =back
1.565     albertel 1709: 
                   1710: =cut
                   1711: 
                   1712: sub resize_textarea_js {
1.590     raeburn  1713:     my $geometry = &viewport_geometry_js();
1.565     albertel 1714:     return <<"RESIZE";
                   1715:     <script type="text/javascript">
1.824     bisitz   1716: // <![CDATA[
1.590     raeburn  1717: $geometry
1.565     albertel 1718: 
1.588     albertel 1719: function getX(element) {
                   1720:     var x = 0;
                   1721:     while (element) {
                   1722: 	x += element.offsetLeft;
                   1723: 	element = element.offsetParent;
                   1724:     }
                   1725:     return x;
                   1726: }
                   1727: function getY(element) {
                   1728:     var y = 0;
                   1729:     while (element) {
                   1730: 	y += element.offsetTop;
                   1731: 	element = element.offsetParent;
                   1732:     }
                   1733:     return y;
                   1734: }
                   1735: 
                   1736: 
1.565     albertel 1737: function resize_textarea(textarea_id,bottom_id) {
                   1738:     init_geometry();
                   1739:     var textarea        = document.getElementById(textarea_id);
                   1740:     //alert(textarea);
                   1741: 
1.588     albertel 1742:     var textarea_top    = getY(textarea);
1.565     albertel 1743:     var textarea_height = textarea.offsetHeight;
                   1744:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1745:     var bottom_top      = getY(bottom);
1.565     albertel 1746:     var bottom_height   = bottom.offsetHeight;
                   1747:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1748:     var fudge           = 23;
1.565     albertel 1749:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1750:     if (new_height < 300) {
                   1751: 	new_height = 300;
                   1752:     }
                   1753:     textarea.style.height=new_height+'px';
                   1754: }
1.824     bisitz   1755: // ]]>
1.565     albertel 1756: </script>
                   1757: RESIZE
                   1758: 
                   1759: }
                   1760: 
1.1075.2.112  raeburn  1761: sub colorfuleditor_js {
                   1762:     return <<"COLORFULEDIT"
                   1763: <script type="text/javascript">
                   1764: // <![CDATA[>
                   1765:     function fold_box(curDepth, lastresource){
                   1766: 
                   1767:     // we need a list because there can be several blocks you need to fold in one tag
                   1768:         var block = document.getElementsByName('foldblock_'+curDepth);
                   1769:     // but there is only one folding button per tag
                   1770:         var foldbutton = document.getElementById('folding_btn_'+curDepth);
                   1771: 
                   1772:         if(block.item(0).style.display == 'none'){
                   1773: 
                   1774:             foldbutton.value = '@{[&mt("Hide")]}';
                   1775:             for (i = 0; i < block.length; i++){
                   1776:                 block.item(i).style.display = '';
                   1777:             }
                   1778:         }else{
                   1779: 
                   1780:             foldbutton.value = '@{[&mt("Show")]}';
                   1781:             for (i = 0; i < block.length; i++){
                   1782:                 // block.item(i).style.visibility = 'collapse';
                   1783:                 block.item(i).style.display = 'none';
                   1784:             }
                   1785:         };
                   1786:         saveState(lastresource);
                   1787:     }
                   1788: 
                   1789:     function saveState (lastresource) {
                   1790: 
                   1791:         var tag_list = getTagList();
                   1792:         if(tag_list != null){
                   1793:             var timestamp = new Date().getTime();
                   1794:             var key = lastresource;
                   1795: 
                   1796:             // the value pattern is: 'time;key1,value1;key2,value2; ... '
                   1797:             // starting with timestamp
                   1798:             var value = timestamp+';';
                   1799: 
                   1800:             // building the list of key-value pairs
                   1801:             for(var i = 0; i < tag_list.length; i++){
                   1802:                 value += tag_list[i]+',';
                   1803:                 value += document.getElementsByName(tag_list[i])[0].style.display+';';
                   1804:             }
                   1805: 
                   1806:             // only iterate whole storage if nothing to override
                   1807:             if(localStorage.getItem(key) == null){
                   1808: 
                   1809:                 // prevent storage from growing large
                   1810:                 if(localStorage.length > 50){
                   1811:                     var regex_getTimestamp = /^(?:\d)+;/;
                   1812:                     var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
                   1813:                     var oldest_key;
                   1814: 
                   1815:                     for(var i = 1; i < localStorage.length; i++){
                   1816:                         if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
                   1817:                             oldest_key = localStorage.key(i);
                   1818:                             oldest_timestamp = regex_getTimestamp.exec(oldest_key);
                   1819:                         }
                   1820:                     }
                   1821:                     localStorage.removeItem(oldest_key);
                   1822:                 }
                   1823:             }
                   1824:             localStorage.setItem(key,value);
                   1825:         }
                   1826:     }
                   1827: 
                   1828:     // restore folding status of blocks (on page load)
                   1829:     function restoreState (lastresource) {
                   1830:         if(localStorage.getItem(lastresource) != null){
                   1831:             var key = lastresource;
                   1832:             var value = localStorage.getItem(key);
                   1833:             var regex_delTimestamp = /^\d+;/;
                   1834: 
                   1835:             value.replace(regex_delTimestamp, '');
                   1836: 
                   1837:             var valueArr = value.split(';');
                   1838:             var pairs;
                   1839:             var elements;
                   1840:             for (var i = 0; i < valueArr.length; i++){
                   1841:                 pairs = valueArr[i].split(',');
                   1842:                 elements = document.getElementsByName(pairs[0]);
                   1843: 
                   1844:                 for (var j = 0; j < elements.length; j++){
                   1845:                     elements[j].style.display = pairs[1];
                   1846:                     if (pairs[1] == "none"){
                   1847:                         var regex_id = /([_\\d]+)\$/;
                   1848:                         regex_id.exec(pairs[0]);
                   1849:                         document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
                   1850:                     }
                   1851:                 }
                   1852:             }
                   1853:         }
                   1854:     }
                   1855: 
                   1856:     function getTagList () {
                   1857: 
                   1858:         var stringToSearch = document.lonhomework.innerHTML;
                   1859: 
                   1860:         var ret = new Array();
                   1861:         var regex_findBlock = /(foldblock_.*?)"/g;
                   1862:         var tag_list = stringToSearch.match(regex_findBlock);
                   1863: 
                   1864:         if(tag_list != null){
                   1865:             for(var i = 0; i < tag_list.length; i++){
                   1866:                 ret.push(tag_list[i].replace(/"/, ''));
                   1867:             }
                   1868:         }
                   1869:         return ret;
                   1870:     }
                   1871: 
                   1872:     function saveScrollPosition (resource) {
                   1873:         var tag_list = getTagList();
                   1874: 
                   1875:         // we dont always want to jump to the first block
                   1876:         // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
                   1877:         if(\$(window).scrollTop() > 170){
                   1878:             if(tag_list != null){
                   1879:                 var result;
                   1880:                 for(var i = 0; i < tag_list.length; i++){
                   1881:                     if(isElementInViewport(tag_list[i])){
                   1882:                         result += tag_list[i]+';';
                   1883:                     }
                   1884:                 }
                   1885:                 sessionStorage.setItem('anchor_'+resource, result);
                   1886:             }
                   1887:         } else {
                   1888:             // we dont need to save zero, just delete the item to leave everything tidy
                   1889:             sessionStorage.removeItem('anchor_'+resource);
                   1890:         }
                   1891:     }
                   1892: 
                   1893:     function restoreScrollPosition(resource){
                   1894: 
                   1895:         var elem = sessionStorage.getItem('anchor_'+resource);
                   1896:         if(elem != null){
                   1897:             var tag_list = elem.split(';');
                   1898:             var elem_list;
                   1899: 
                   1900:             for(var i = 0; i < tag_list.length; i++){
                   1901:                 elem_list = document.getElementsByName(tag_list[i]);
                   1902: 
                   1903:                 if(elem_list.length > 0){
                   1904:                     elem = elem_list[0];
                   1905:                     break;
                   1906:                 }
                   1907:             }
                   1908:             elem.scrollIntoView();
                   1909:         }
                   1910:     }
                   1911: 
                   1912:     function isElementInViewport(el) {
                   1913: 
                   1914:         // change to last element instead of first
                   1915:         var elem = document.getElementsByName(el);
                   1916:         var rect = elem[0].getBoundingClientRect();
                   1917: 
                   1918:         return (
                   1919:             rect.top >= 0 &&
                   1920:             rect.left >= 0 &&
                   1921:             rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
                   1922:             rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
                   1923:         );
                   1924:     }
                   1925: 
                   1926:     function autosize(depth){
                   1927:         var cmInst = window['cm'+depth];
                   1928:         var fitsizeButton = document.getElementById('fitsize'+depth);
                   1929: 
                   1930:         // is fixed size, switching to dynamic
                   1931:         if (sessionStorage.getItem("autosized_"+depth) == null) {
                   1932:             cmInst.setSize("","auto");
                   1933:             fitsizeButton.value = "@{[&mt('Fixed size')]}";
                   1934:             sessionStorage.setItem("autosized_"+depth, "yes");
                   1935: 
                   1936:         // is dynamic size, switching to fixed
                   1937:         } else {
                   1938:             cmInst.setSize("","300px");
                   1939:             fitsizeButton.value = "@{[&mt('Dynamic size')]}";
                   1940:             sessionStorage.removeItem("autosized_"+depth);
                   1941:         }
                   1942:     }
                   1943: 
                   1944: 
                   1945: 
                   1946: // ]]>
                   1947: </script>
                   1948: COLORFULEDIT
                   1949: }
                   1950: 
                   1951: sub xmleditor_js {
                   1952:     return <<XMLEDIT
                   1953: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
                   1954: <script type="text/javascript">
                   1955: // <![CDATA[>
                   1956: 
                   1957:     function saveScrollPosition (resource) {
                   1958: 
                   1959:         var scrollPos = \$(window).scrollTop();
                   1960:         sessionStorage.setItem(resource,scrollPos);
                   1961:     }
                   1962: 
                   1963:     function restoreScrollPosition(resource){
                   1964: 
                   1965:         var scrollPos = sessionStorage.getItem(resource);
                   1966:         \$(window).scrollTop(scrollPos);
                   1967:     }
                   1968: 
                   1969:     // unless internet explorer
                   1970:     if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
                   1971: 
                   1972:         \$(document).ready(function() {
                   1973:              \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
                   1974:         });
                   1975:     }
                   1976: 
                   1977:     // inserts text at cursor position into codemirror (xml editor only)
                   1978:     function insertText(text){
                   1979:         cm.focus();
                   1980:         var curPos = cm.getCursor();
                   1981:         cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
                   1982:     }
                   1983: // ]]>
                   1984: </script>
                   1985: XMLEDIT
                   1986: }
                   1987: 
                   1988: sub insert_folding_button {
                   1989:     my $curDepth = $Apache::lonxml::curdepth;
                   1990:     my $lastresource = $env{'request.ambiguous'};
                   1991: 
                   1992:     return "<input type=\"button\" id=\"folding_btn_$curDepth\"
                   1993:             value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
                   1994: }
                   1995: 
                   1996: 
1.565     albertel 1997: =pod
                   1998: 
1.256     matthew  1999: =head1 Excel and CSV file utility routines
                   2000: 
                   2001: =cut
                   2002: 
                   2003: ###############################################################
                   2004: ###############################################################
                   2005: 
                   2006: =pod
                   2007: 
1.1075.2.56  raeburn  2008: =over 4
                   2009: 
1.648     raeburn  2010: =item * &csv_translate($text) 
1.37      matthew  2011: 
1.185     www      2012: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  2013: format.
                   2014: 
                   2015: =cut
                   2016: 
1.180     matthew  2017: ###############################################################
                   2018: ###############################################################
1.37      matthew  2019: sub csv_translate {
                   2020:     my $text = shift;
                   2021:     $text =~ s/\"/\"\"/g;
1.209     albertel 2022:     $text =~ s/\n/ /g;
1.37      matthew  2023:     return $text;
                   2024: }
1.180     matthew  2025: 
                   2026: ###############################################################
                   2027: ###############################################################
                   2028: 
                   2029: =pod
                   2030: 
1.648     raeburn  2031: =item * &define_excel_formats()
1.180     matthew  2032: 
                   2033: Define some commonly used Excel cell formats.
                   2034: 
                   2035: Currently supported formats:
                   2036: 
                   2037: =over 4
                   2038: 
                   2039: =item header
                   2040: 
                   2041: =item bold
                   2042: 
                   2043: =item h1
                   2044: 
                   2045: =item h2
                   2046: 
                   2047: =item h3
                   2048: 
1.256     matthew  2049: =item h4
                   2050: 
                   2051: =item i
                   2052: 
1.180     matthew  2053: =item date
                   2054: 
                   2055: =back
                   2056: 
                   2057: Inputs: $workbook
                   2058: 
                   2059: Returns: $format, a hash reference.
                   2060: 
1.1057    foxr     2061: 
1.180     matthew  2062: =cut
                   2063: 
                   2064: ###############################################################
                   2065: ###############################################################
                   2066: sub define_excel_formats {
                   2067:     my ($workbook) = @_;
                   2068:     my $format;
                   2069:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   2070:                                                 bottom    => 1,
                   2071:                                                 align     => 'center');
                   2072:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   2073:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   2074:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   2075:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  2076:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  2077:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  2078:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  2079:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  2080:     return $format;
                   2081: }
                   2082: 
                   2083: ###############################################################
                   2084: ###############################################################
1.113     bowersj2 2085: 
                   2086: =pod
                   2087: 
1.648     raeburn  2088: =item * &create_workbook()
1.255     matthew  2089: 
                   2090: Create an Excel worksheet.  If it fails, output message on the
                   2091: request object and return undefs.
                   2092: 
                   2093: Inputs: Apache request object
                   2094: 
                   2095: Returns (undef) on failure, 
                   2096:     Excel worksheet object, scalar with filename, and formats 
                   2097:     from &Apache::loncommon::define_excel_formats on success
                   2098: 
                   2099: =cut
                   2100: 
                   2101: ###############################################################
                   2102: ###############################################################
                   2103: sub create_workbook {
                   2104:     my ($r) = @_;
                   2105:         #
                   2106:     # Create the excel spreadsheet
                   2107:     my $filename = '/prtspool/'.
1.258     albertel 2108:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  2109:         time.'_'.rand(1000000000).'.xls';
                   2110:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   2111:     if (! defined($workbook)) {
                   2112:         $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928     bisitz   2113:         $r->print(
                   2114:             '<p class="LC_error">'
                   2115:            .&mt('Problems occurred in creating the new Excel file.')
                   2116:            .' '.&mt('This error has been logged.')
                   2117:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2118:            .'</p>'
                   2119:         );
1.255     matthew  2120:         return (undef);
                   2121:     }
                   2122:     #
1.1014    foxr     2123:     $workbook->set_tempdir(LONCAPA::tempdir());
1.255     matthew  2124:     #
                   2125:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   2126:     return ($workbook,$filename,$format);
                   2127: }
                   2128: 
                   2129: ###############################################################
                   2130: ###############################################################
                   2131: 
                   2132: =pod
                   2133: 
1.648     raeburn  2134: =item * &create_text_file()
1.113     bowersj2 2135: 
1.542     raeburn  2136: Create a file to write to and eventually make available to the user.
1.256     matthew  2137: If file creation fails, outputs an error message on the request object and 
                   2138: return undefs.
1.113     bowersj2 2139: 
1.256     matthew  2140: Inputs: Apache request object, and file suffix
1.113     bowersj2 2141: 
1.256     matthew  2142: Returns (undef) on failure, 
                   2143:     Filehandle and filename on success.
1.113     bowersj2 2144: 
                   2145: =cut
                   2146: 
1.256     matthew  2147: ###############################################################
                   2148: ###############################################################
                   2149: sub create_text_file {
                   2150:     my ($r,$suffix) = @_;
                   2151:     if (! defined($suffix)) { $suffix = 'txt'; };
                   2152:     my $fh;
                   2153:     my $filename = '/prtspool/'.
1.258     albertel 2154:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  2155:         time.'_'.rand(1000000000).'.'.$suffix;
                   2156:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   2157:     if (! defined($fh)) {
                   2158:         $r->log_error("Couldn't open $filename for output $!");
1.928     bisitz   2159:         $r->print(
                   2160:             '<p class="LC_error">'
                   2161:            .&mt('Problems occurred in creating the output file.')
                   2162:            .' '.&mt('This error has been logged.')
                   2163:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2164:            .'</p>'
                   2165:         );
1.113     bowersj2 2166:     }
1.256     matthew  2167:     return ($fh,$filename)
1.113     bowersj2 2168: }
                   2169: 
                   2170: 
1.256     matthew  2171: =pod 
1.113     bowersj2 2172: 
                   2173: =back
                   2174: 
                   2175: =cut
1.37      matthew  2176: 
                   2177: ###############################################################
1.33      matthew  2178: ##        Home server <option> list generating code          ##
                   2179: ###############################################################
1.35      matthew  2180: 
1.169     www      2181: # ------------------------------------------
                   2182: 
                   2183: sub domain_select {
                   2184:     my ($name,$value,$multiple)=@_;
                   2185:     my %domains=map { 
1.514     albertel 2186: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 2187:     } &Apache::lonnet::all_domains();
1.169     www      2188:     if ($multiple) {
                   2189: 	$domains{''}=&mt('Any domain');
1.550     albertel 2190: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 2191: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      2192:     } else {
1.550     albertel 2193: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970     raeburn  2194: 	return &select_form($name,$value,\%domains);
1.169     www      2195:     }
                   2196: }
                   2197: 
1.282     albertel 2198: #-------------------------------------------
                   2199: 
                   2200: =pod
                   2201: 
1.519     raeburn  2202: =head1 Routines for form select boxes
                   2203: 
                   2204: =over 4
                   2205: 
1.648     raeburn  2206: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 2207: 
                   2208: Returns a string containing a <select> element int multiple mode
                   2209: 
                   2210: 
                   2211: Args:
                   2212:   $name - name of the <select> element
1.506     raeburn  2213:   $value - scalar or array ref of values that should already be selected
1.282     albertel 2214:   $size - number of rows long the select element is
1.283     albertel 2215:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 2216:           (shown text should already have been &mt())
1.506     raeburn  2217:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 2218: 
1.282     albertel 2219: =cut
                   2220: 
                   2221: #-------------------------------------------
1.169     www      2222: sub multiple_select_form {
1.284     albertel 2223:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      2224:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   2225:     my $output='';
1.191     matthew  2226:     if (! defined($size)) {
                   2227:         $size = 4;
1.283     albertel 2228:         if (scalar(keys(%$hash))<4) {
                   2229:             $size = scalar(keys(%$hash));
1.191     matthew  2230:         }
                   2231:     }
1.734     bisitz   2232:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 2233:     my @order;
1.506     raeburn  2234:     if (ref($order) eq 'ARRAY')  {
                   2235:         @order = @{$order};
                   2236:     } else {
                   2237:         @order = sort(keys(%$hash));
1.501     banghart 2238:     }
                   2239:     if (exists($$hash{'select_form_order'})) {
                   2240:         @order = @{$$hash{'select_form_order'}};
                   2241:     }
                   2242:         
1.284     albertel 2243:     foreach my $key (@order) {
1.356     albertel 2244:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 2245:         $output.='selected="selected" ' if ($selected{$key});
                   2246:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      2247:     }
                   2248:     $output.="</select>\n";
                   2249:     return $output;
                   2250: }
                   2251: 
1.88      www      2252: #-------------------------------------------
                   2253: 
                   2254: =pod
                   2255: 
1.1075.2.115  raeburn  2256: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88      www      2257: 
                   2258: Returns a string containing a <select name='$name' size='1'> form to 
1.970     raeburn  2259: allow a user to select options from a ref to a hash containing:
                   2260: option_name => displayed text. An optional $onchange can include
1.1075.2.115  raeburn  2261: a javascript onchange item, e.g., onchange="this.form.submit();".
                   2262: An optional arg -- $readonly -- if true will cause the select form
                   2263: to be disabled, e.g., for the case where an instructor has a section-
                   2264: specific role, and is viewing/modifying parameters.  
1.970     raeburn  2265: 
1.88      www      2266: See lonrights.pm for an example invocation and use.
                   2267: 
                   2268: =cut
                   2269: 
                   2270: #-------------------------------------------
                   2271: sub select_form {
1.1075.2.115  raeburn  2272:     my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970     raeburn  2273:     return unless (ref($hashref) eq 'HASH');
                   2274:     if ($onchange) {
                   2275:         $onchange = ' onchange="'.$onchange.'"';
                   2276:     }
1.1075.2.129  raeburn  2277:     my $disabled;
                   2278:     if ($readonly) {
                   2279:         $disabled = ' disabled="disabled"';
                   2280:     }
                   2281:     my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128     albertel 2282:     my @keys;
1.970     raeburn  2283:     if (exists($hashref->{'select_form_order'})) {
                   2284: 	@keys=@{$hashref->{'select_form_order'}};
1.128     albertel 2285:     } else {
1.970     raeburn  2286: 	@keys=sort(keys(%{$hashref}));
1.128     albertel 2287:     }
1.356     albertel 2288:     foreach my $key (@keys) {
                   2289:         $selectform.=
                   2290: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   2291:             ($key eq $def ? 'selected="selected" ' : '').
1.970     raeburn  2292:                 ">".$hashref->{$key}."</option>\n";
1.88      www      2293:     }
                   2294:     $selectform.="</select>";
                   2295:     return $selectform;
                   2296: }
                   2297: 
1.475     www      2298: # For display filters
                   2299: 
                   2300: sub display_filter {
1.1074    raeburn  2301:     my ($context) = @_;
1.475     www      2302:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      2303:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074    raeburn  2304:     my $phraseinput = 'hidden';
                   2305:     my $includeinput = 'hidden';
                   2306:     my ($checked,$includetypestext);
                   2307:     if ($env{'form.displayfilter'} eq 'containing') {
                   2308:         $phraseinput = 'text'; 
                   2309:         if ($context eq 'parmslog') {
                   2310:             $includeinput = 'checkbox';
                   2311:             if ($env{'form.includetypes'}) {
                   2312:                 $checked = ' checked="checked"';
                   2313:             }
                   2314:             $includetypestext = &mt('Include parameter types');
                   2315:         }
                   2316:     } else {
                   2317:         $includetypestext = '&nbsp;';
                   2318:     }
                   2319:     my ($additional,$secondid,$thirdid);
                   2320:     if ($context eq 'parmslog') {
                   2321:         $additional = 
                   2322:             '<label><input type="'.$includeinput.'" name="includetypes"'. 
                   2323:             $checked.' name="includetypes" value="1" id="includetypes" />'.
                   2324:             '&nbsp;<span id="includetypestext">'.$includetypestext.'</span>'.
                   2325:             '</label>';
                   2326:         $secondid = 'includetypes';
                   2327:         $thirdid = 'includetypestext';
                   2328:     }
                   2329:     my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
                   2330:                                                     '$secondid','$thirdid')";
                   2331:     return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475     www      2332: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   2333: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   2334: 	   '</label></span> <span class="LC_nobreak">'.
1.1074    raeburn  2335:            &mt('Filter: [_1]',
1.477     www      2336: 	   &select_form($env{'form.displayfilter'},
                   2337: 			'displayfilter',
1.970     raeburn  2338: 			{'currentfolder' => 'Current folder/page',
1.477     www      2339: 			 'containing' => 'Containing phrase',
1.1074    raeburn  2340: 			 'none' => 'None'},$onchange)).'&nbsp;'.
                   2341: 			 '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
                   2342:                          &HTML::Entities::encode($env{'form.containingphrase'}).
                   2343:                          '" />'.$additional;
                   2344: }
                   2345: 
                   2346: sub display_filter_js {
                   2347:     my $includetext = &mt('Include parameter types');
                   2348:     return <<"ENDJS";
                   2349:   
                   2350: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
                   2351:     var firstType = 'hidden';
                   2352:     if (setter.options[setter.selectedIndex].value == 'containing') {
                   2353:         firstType = 'text';
                   2354:     }
                   2355:     firstObject = document.getElementById(firstid);
                   2356:     if (typeof(firstObject) == 'object') {
                   2357:         if (firstObject.type != firstType) {
                   2358:             changeInputType(firstObject,firstType);
                   2359:         }
                   2360:     }
                   2361:     if (context == 'parmslog') {
                   2362:         var secondType = 'hidden';
                   2363:         if (firstType == 'text') {
                   2364:             secondType = 'checkbox';
                   2365:         }
                   2366:         secondObject = document.getElementById(secondid);  
                   2367:         if (typeof(secondObject) == 'object') {
                   2368:             if (secondObject.type != secondType) {
                   2369:                 changeInputType(secondObject,secondType);
                   2370:             }
                   2371:         }
                   2372:         var textItem = document.getElementById(thirdid);
                   2373:         var currtext = textItem.innerHTML;
                   2374:         var newtext;
                   2375:         if (firstType == 'text') {
                   2376:             newtext = '$includetext';
                   2377:         } else {
                   2378:             newtext = '&nbsp;';
                   2379:         }
                   2380:         if (currtext != newtext) {
                   2381:             textItem.innerHTML = newtext;
                   2382:         }
                   2383:     }
                   2384:     return;
                   2385: }
                   2386: 
                   2387: function changeInputType(oldObject,newType) {
                   2388:     var newObject = document.createElement('input');
                   2389:     newObject.type = newType;
                   2390:     if (oldObject.size) {
                   2391:         newObject.size = oldObject.size;
                   2392:     }
                   2393:     if (oldObject.value) {
                   2394:         newObject.value = oldObject.value;
                   2395:     }
                   2396:     if (oldObject.name) {
                   2397:         newObject.name = oldObject.name;
                   2398:     }
                   2399:     if (oldObject.id) {
                   2400:         newObject.id = oldObject.id;
                   2401:     }
                   2402:     oldObject.parentNode.replaceChild(newObject,oldObject);
                   2403:     return;
                   2404: }
                   2405: 
                   2406: ENDJS
1.475     www      2407: }
                   2408: 
1.167     www      2409: sub gradeleveldescription {
                   2410:     my $gradelevel=shift;
                   2411:     my %gradelevels=(0 => 'Not specified',
                   2412: 		     1 => 'Grade 1',
                   2413: 		     2 => 'Grade 2',
                   2414: 		     3 => 'Grade 3',
                   2415: 		     4 => 'Grade 4',
                   2416: 		     5 => 'Grade 5',
                   2417: 		     6 => 'Grade 6',
                   2418: 		     7 => 'Grade 7',
                   2419: 		     8 => 'Grade 8',
                   2420: 		     9 => 'Grade 9',
                   2421: 		     10 => 'Grade 10',
                   2422: 		     11 => 'Grade 11',
                   2423: 		     12 => 'Grade 12',
                   2424: 		     13 => 'Grade 13',
                   2425: 		     14 => '100 Level',
                   2426: 		     15 => '200 Level',
                   2427: 		     16 => '300 Level',
                   2428: 		     17 => '400 Level',
                   2429: 		     18 => 'Graduate Level');
                   2430:     return &mt($gradelevels{$gradelevel});
                   2431: }
                   2432: 
1.163     www      2433: sub select_level_form {
                   2434:     my ($deflevel,$name)=@_;
                   2435:     unless ($deflevel) { $deflevel=0; }
1.167     www      2436:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   2437:     for (my $i=0; $i<=18; $i++) {
                   2438:         $selectform.="<option value=\"$i\" ".
1.253     albertel 2439:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      2440:                 ">".&gradeleveldescription($i)."</option>\n";
                   2441:     }
                   2442:     $selectform.="</select>";
                   2443:     return $selectform;
1.163     www      2444: }
1.167     www      2445: 
1.35      matthew  2446: #-------------------------------------------
                   2447: 
1.45      matthew  2448: =pod
                   2449: 
1.1075.2.115  raeburn  2450: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35      matthew  2451: 
                   2452: Returns a string containing a <select name='$name' size='1'> form to 
                   2453: allow a user to select the domain to preform an operation in.  
                   2454: See loncreateuser.pm for an example invocation and use.
                   2455: 
1.90      www      2456: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   2457: selected");
                   2458: 
1.743     raeburn  2459: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   2460: 
1.910     raeburn  2461: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
                   2462: 
1.1075.2.36  raeburn  2463: The optional $incdoms is a reference to an array of domains which will be the only available options.
                   2464: 
1.1075.2.115  raeburn  2465: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
                   2466: 
                   2467: The optional $disabled argument, if true, adds the disabled attribute to the select tag. 
1.563     raeburn  2468: 
1.35      matthew  2469: =cut
                   2470: 
                   2471: #-------------------------------------------
1.34      matthew  2472: sub select_dom_form {
1.1075.2.115  raeburn  2473:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872     raeburn  2474:     if ($onchange) {
1.874     raeburn  2475:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  2476:     }
1.1075.2.115  raeburn  2477:     if ($disabled) {
                   2478:         $disabled = ' disabled="disabled"';
                   2479:     }
1.1075.2.36  raeburn  2480:     my (@domains,%exclude);
1.910     raeburn  2481:     if (ref($incdoms) eq 'ARRAY') {
                   2482:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   2483:     } else {
                   2484:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   2485:     }
1.90      www      2486:     if ($includeempty) { @domains=('',@domains); }
1.1075.2.36  raeburn  2487:     if (ref($excdoms) eq 'ARRAY') {
                   2488:         map { $exclude{$_} = 1; } @{$excdoms};
                   2489:     }
1.1075.2.115  raeburn  2490:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356     albertel 2491:     foreach my $dom (@domains) {
1.1075.2.36  raeburn  2492:         next if ($exclude{$dom});
1.356     albertel 2493:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  2494:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   2495:         if ($showdomdesc) {
                   2496:             if ($dom ne '') {
                   2497:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   2498:                 if ($domdesc ne '') {
                   2499:                     $selectdomain .= ' ('.$domdesc.')';
                   2500:                 }
                   2501:             } 
                   2502:         }
                   2503:         $selectdomain .= "</option>\n";
1.34      matthew  2504:     }
                   2505:     $selectdomain.="</select>";
                   2506:     return $selectdomain;
                   2507: }
                   2508: 
1.35      matthew  2509: #-------------------------------------------
                   2510: 
1.45      matthew  2511: =pod
                   2512: 
1.648     raeburn  2513: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2514: 
1.586     raeburn  2515: input: 4 arguments (two required, two optional) - 
                   2516:     $domain - domain of new user
                   2517:     $name - name of form element
                   2518:     $default - Value of 'default' causes a default item to be first 
                   2519:                             option, and selected by default. 
                   2520:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2521:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2522: output: returns 2 items: 
1.586     raeburn  2523: (a) form element which contains either:
                   2524:    (i) <select name="$name">
                   2525:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2526:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2527:        </select>
                   2528:        form item if there are multiple library servers in $domain, or
                   2529:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2530:        if there is only one library server in $domain.
                   2531: 
                   2532: (b) number of library servers found.
                   2533: 
                   2534: See loncreateuser.pm for example of use.
1.35      matthew  2535: 
                   2536: =cut
                   2537: 
                   2538: #-------------------------------------------
1.586     raeburn  2539: sub home_server_form_item {
                   2540:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2541:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2542:     my $result;
                   2543:     my $numlib = keys(%servers);
                   2544:     if ($numlib > 1) {
                   2545:         $result .= '<select name="'.$name.'" />'."\n";
                   2546:         if ($default) {
1.804     bisitz   2547:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2548:                        '</option>'."\n";
                   2549:         }
                   2550:         foreach my $hostid (sort(keys(%servers))) {
                   2551:             $result.= '<option value="'.$hostid.'">'.
                   2552: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2553:         }
                   2554:         $result .= '</select>'."\n";
                   2555:     } elsif ($numlib == 1) {
                   2556:         my $hostid;
                   2557:         foreach my $item (keys(%servers)) {
                   2558:             $hostid = $item;
                   2559:         }
                   2560:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2561:                    $hostid.'" />';
                   2562:                    if (!$hide) {
                   2563:                        $result .= $hostid.' '.$servers{$hostid};
                   2564:                    }
                   2565:                    $result .= "\n";
                   2566:     } elsif ($default) {
                   2567:         $result .= '<input type="hidden" name="'.$name.
                   2568:                    '" value="default" />';
                   2569:                    if (!$hide) {
                   2570:                        $result .= &mt('default');
                   2571:                    }
                   2572:                    $result .= "\n";
1.33      matthew  2573:     }
1.586     raeburn  2574:     return ($result,$numlib);
1.33      matthew  2575: }
1.112     bowersj2 2576: 
                   2577: =pod
                   2578: 
1.534     albertel 2579: =back 
                   2580: 
1.112     bowersj2 2581: =cut
1.87      matthew  2582: 
                   2583: ###############################################################
1.112     bowersj2 2584: ##                  Decoding User Agent                      ##
1.87      matthew  2585: ###############################################################
                   2586: 
                   2587: =pod
                   2588: 
1.112     bowersj2 2589: =head1 Decoding the User Agent
                   2590: 
                   2591: =over 4
                   2592: 
                   2593: =item * &decode_user_agent()
1.87      matthew  2594: 
                   2595: Inputs: $r
                   2596: 
                   2597: Outputs:
                   2598: 
                   2599: =over 4
                   2600: 
1.112     bowersj2 2601: =item * $httpbrowser
1.87      matthew  2602: 
1.112     bowersj2 2603: =item * $clientbrowser
1.87      matthew  2604: 
1.112     bowersj2 2605: =item * $clientversion
1.87      matthew  2606: 
1.112     bowersj2 2607: =item * $clientmathml
1.87      matthew  2608: 
1.112     bowersj2 2609: =item * $clientunicode
1.87      matthew  2610: 
1.112     bowersj2 2611: =item * $clientos
1.87      matthew  2612: 
1.1075.2.42  raeburn  2613: =item * $clientmobile
                   2614: 
                   2615: =item * $clientinfo
                   2616: 
1.1075.2.77  raeburn  2617: =item * $clientosversion
                   2618: 
1.87      matthew  2619: =back
                   2620: 
1.157     matthew  2621: =back 
                   2622: 
1.87      matthew  2623: =cut
                   2624: 
                   2625: ###############################################################
                   2626: ###############################################################
                   2627: sub decode_user_agent {
1.247     albertel 2628:     my ($r)=@_;
1.87      matthew  2629:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2630:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2631:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2632:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2633:     my $clientbrowser='unknown';
                   2634:     my $clientversion='0';
                   2635:     my $clientmathml='';
                   2636:     my $clientunicode='0';
1.1075.2.42  raeburn  2637:     my $clientmobile=0;
1.1075.2.77  raeburn  2638:     my $clientosversion='';
1.87      matthew  2639:     for (my $i=0;$i<=$#browsertype;$i++) {
1.1075.2.76  raeburn  2640:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87      matthew  2641: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2642: 	    $clientbrowser=$bname;
                   2643:             $httpbrowser=~/$vreg/i;
                   2644: 	    $clientversion=$1;
                   2645:             $clientmathml=($clientversion>=$minv);
                   2646:             $clientunicode=($clientversion>=$univ);
                   2647: 	}
                   2648:     }
                   2649:     my $clientos='unknown';
1.1075.2.42  raeburn  2650:     my $clientinfo;
1.87      matthew  2651:     if (($httpbrowser=~/linux/i) ||
                   2652:         ($httpbrowser=~/unix/i) ||
                   2653:         ($httpbrowser=~/ux/i) ||
                   2654:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2655:     if (($httpbrowser=~/vax/i) ||
                   2656:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2657:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2658:     if (($httpbrowser=~/mac/i) ||
                   2659:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1075.2.77  raeburn  2660:     if ($httpbrowser=~/win/i) {
                   2661:         $clientos='win';
                   2662:         if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
                   2663:             $clientosversion = $1;
                   2664:         }
                   2665:     }
1.87      matthew  2666:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1075.2.42  raeburn  2667:     if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
                   2668:         $clientmobile=lc($1);
                   2669:     }
                   2670:     if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
                   2671:         $clientinfo = 'firefox-'.$1;
                   2672:     } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
                   2673:         $clientinfo = 'chromeframe-'.$1;
                   2674:     }
1.87      matthew  2675:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1075.2.77  raeburn  2676:             $clientunicode,$clientos,$clientmobile,$clientinfo,
                   2677:             $clientosversion);
1.87      matthew  2678: }
                   2679: 
1.32      matthew  2680: ###############################################################
                   2681: ##    Authentication changing form generation subroutines    ##
                   2682: ###############################################################
                   2683: ##
                   2684: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2685: ## hash, and have reasonable default values.
                   2686: ##
                   2687: ##    formname = the name given in the <form> tag.
1.35      matthew  2688: #-------------------------------------------
                   2689: 
1.45      matthew  2690: =pod
                   2691: 
1.112     bowersj2 2692: =head1 Authentication Routines
                   2693: 
                   2694: =over 4
                   2695: 
1.648     raeburn  2696: =item * &authform_xxxxxx()
1.35      matthew  2697: 
                   2698: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2699: handle some of the conveniences required for authentication forms.  
                   2700: This is not an optimal method, but it works.  
                   2701: 
                   2702: =over 4
                   2703: 
1.112     bowersj2 2704: =item * authform_header
1.35      matthew  2705: 
1.112     bowersj2 2706: =item * authform_authorwarning
1.35      matthew  2707: 
1.112     bowersj2 2708: =item * authform_nochange
1.35      matthew  2709: 
1.112     bowersj2 2710: =item * authform_kerberos
1.35      matthew  2711: 
1.112     bowersj2 2712: =item * authform_internal
1.35      matthew  2713: 
1.112     bowersj2 2714: =item * authform_filesystem
1.35      matthew  2715: 
                   2716: =back
                   2717: 
1.648     raeburn  2718: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2719: 
1.35      matthew  2720: =cut
                   2721: 
                   2722: #-------------------------------------------
1.32      matthew  2723: sub authform_header{  
                   2724:     my %in = (
                   2725:         formname => 'cu',
1.80      albertel 2726:         kerb_def_dom => '',
1.32      matthew  2727:         @_,
                   2728:     );
                   2729:     $in{'formname'} = 'document.' . $in{'formname'};
                   2730:     my $result='';
1.80      albertel 2731: 
                   2732: #---------------------------------------------- Code for upper case translation
                   2733:     my $Javascript_toUpperCase;
                   2734:     unless ($in{kerb_def_dom}) {
                   2735:         $Javascript_toUpperCase =<<"END";
                   2736:         switch (choice) {
                   2737:            case 'krb': currentform.elements[choicearg].value =
                   2738:                currentform.elements[choicearg].value.toUpperCase();
                   2739:                break;
                   2740:            default:
                   2741:         }
                   2742: END
                   2743:     } else {
                   2744:         $Javascript_toUpperCase = "";
                   2745:     }
                   2746: 
1.165     raeburn  2747:     my $radioval = "'nochange'";
1.591     raeburn  2748:     if (defined($in{'curr_authtype'})) {
                   2749:         if ($in{'curr_authtype'} ne '') {
                   2750:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2751:         }
1.174     matthew  2752:     }
1.165     raeburn  2753:     my $argfield = 'null';
1.591     raeburn  2754:     if (defined($in{'mode'})) {
1.165     raeburn  2755:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2756:             if (defined($in{'curr_autharg'})) {
                   2757:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2758:                     $argfield = "'$in{'curr_autharg'}'";
                   2759:                 }
                   2760:             }
                   2761:         }
                   2762:     }
                   2763: 
1.32      matthew  2764:     $result.=<<"END";
                   2765: var current = new Object();
1.165     raeburn  2766: current.radiovalue = $radioval;
                   2767: current.argfield = $argfield;
1.32      matthew  2768: 
                   2769: function changed_radio(choice,currentform) {
                   2770:     var choicearg = choice + 'arg';
                   2771:     // If a radio button in changed, we need to change the argfield
                   2772:     if (current.radiovalue != choice) {
                   2773:         current.radiovalue = choice;
                   2774:         if (current.argfield != null) {
                   2775:             currentform.elements[current.argfield].value = '';
                   2776:         }
                   2777:         if (choice == 'nochange') {
                   2778:             current.argfield = null;
                   2779:         } else {
                   2780:             current.argfield = choicearg;
                   2781:             switch(choice) {
                   2782:                 case 'krb': 
                   2783:                     currentform.elements[current.argfield].value = 
                   2784:                         "$in{'kerb_def_dom'}";
                   2785:                 break;
                   2786:               default:
                   2787:                 break;
                   2788:             }
                   2789:         }
                   2790:     }
                   2791:     return;
                   2792: }
1.22      www      2793: 
1.32      matthew  2794: function changed_text(choice,currentform) {
                   2795:     var choicearg = choice + 'arg';
                   2796:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2797:         $Javascript_toUpperCase
1.32      matthew  2798:         // clear old field
                   2799:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2800:             currentform.elements[current.argfield].value = '';
                   2801:         }
                   2802:         current.argfield = choicearg;
                   2803:     }
                   2804:     set_auth_radio_buttons(choice,currentform);
                   2805:     return;
1.20      www      2806: }
1.32      matthew  2807: 
                   2808: function set_auth_radio_buttons(newvalue,currentform) {
1.986     raeburn  2809:     var numauthchoices = currentform.login.length;
                   2810:     if (typeof numauthchoices  == "undefined") {
                   2811:         return;
                   2812:     } 
1.32      matthew  2813:     var i=0;
1.986     raeburn  2814:     while (i < numauthchoices) {
1.32      matthew  2815:         if (currentform.login[i].value == newvalue) { break; }
                   2816:         i++;
                   2817:     }
1.986     raeburn  2818:     if (i == numauthchoices) {
1.32      matthew  2819:         return;
                   2820:     }
                   2821:     current.radiovalue = newvalue;
                   2822:     currentform.login[i].checked = true;
                   2823:     return;
                   2824: }
                   2825: END
                   2826:     return $result;
                   2827: }
                   2828: 
1.1075.2.20  raeburn  2829: sub authform_authorwarning {
1.32      matthew  2830:     my $result='';
1.144     matthew  2831:     $result='<i>'.
                   2832:         &mt('As a general rule, only authors or co-authors should be '.
                   2833:             'filesystem authenticated '.
                   2834:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2835:     return $result;
                   2836: }
                   2837: 
1.1075.2.20  raeburn  2838: sub authform_nochange {
1.32      matthew  2839:     my %in = (
                   2840:               formname => 'document.cu',
                   2841:               kerb_def_dom => 'MSU.EDU',
                   2842:               @_,
                   2843:           );
1.1075.2.20  raeburn  2844:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'}); 
1.586     raeburn  2845:     my $result;
1.1075.2.20  raeburn  2846:     if (!$authnum) {
                   2847:         $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586     raeburn  2848:     } else {
                   2849:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2850:                   '<input type="radio" name="login" value="nochange" '.
                   2851:                   'checked="checked" onclick="'.
1.281     albertel 2852:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2853: 	    '</label>';
1.586     raeburn  2854:     }
1.32      matthew  2855:     return $result;
                   2856: }
                   2857: 
1.591     raeburn  2858: sub authform_kerberos {
1.32      matthew  2859:     my %in = (
                   2860:               formname => 'document.cu',
                   2861:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2862:               kerb_def_auth => 'krb4',
1.32      matthew  2863:               @_,
                   2864:               );
1.586     raeburn  2865:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1075.2.117  raeburn  2866:         $autharg,$jscall,$disabled);
1.1075.2.20  raeburn  2867:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80      albertel 2868:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2869:        $check5 = ' checked="checked"';
1.80      albertel 2870:     } else {
1.772     bisitz   2871:        $check4 = ' checked="checked"';
1.80      albertel 2872:     }
1.1075.2.117  raeburn  2873:     if ($in{'readonly'}) {
                   2874:         $disabled = ' disabled="disabled"';
                   2875:     }
1.165     raeburn  2876:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2877:     if (defined($in{'curr_authtype'})) {
                   2878:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2879:             $krbcheck = ' checked="checked"';
1.623     raeburn  2880:             if (defined($in{'mode'})) {
                   2881:                 if ($in{'mode'} eq 'modifyuser') {
                   2882:                     $krbcheck = '';
                   2883:                 }
                   2884:             }
1.591     raeburn  2885:             if (defined($in{'curr_kerb_ver'})) {
                   2886:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2887:                     $check5 = ' checked="checked"';
1.591     raeburn  2888:                     $check4 = '';
                   2889:                 } else {
1.772     bisitz   2890:                     $check4 = ' checked="checked"';
1.591     raeburn  2891:                     $check5 = '';
                   2892:                 }
1.586     raeburn  2893:             }
1.591     raeburn  2894:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2895:                 $krbarg = $in{'curr_autharg'};
                   2896:             }
1.586     raeburn  2897:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2898:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2899:                     $result = 
                   2900:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2901:         $in{'curr_autharg'},$krbver);
                   2902:                 } else {
                   2903:                     $result =
                   2904:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2905:                 }
                   2906:                 return $result; 
                   2907:             }
                   2908:         }
                   2909:     } else {
                   2910:         if ($authnum == 1) {
1.784     bisitz   2911:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2912:         }
                   2913:     }
1.586     raeburn  2914:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2915:         return;
1.587     raeburn  2916:     } elsif ($authtype eq '') {
1.591     raeburn  2917:         if (defined($in{'mode'})) {
1.587     raeburn  2918:             if ($in{'mode'} eq 'modifycourse') {
                   2919:                 if ($authnum == 1) {
1.1075.2.117  raeburn  2920:                     $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587     raeburn  2921:                 }
                   2922:             }
                   2923:         }
1.586     raeburn  2924:     }
                   2925:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2926:     if ($authtype eq '') {
                   2927:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2928:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1075.2.117  raeburn  2929:                     $krbcheck.$disabled.' />';
1.586     raeburn  2930:     }
                   2931:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1075.2.20  raeburn  2932:         ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586     raeburn  2933:          $in{'curr_authtype'} eq 'krb5') ||
1.1075.2.20  raeburn  2934:         (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586     raeburn  2935:          $in{'curr_authtype'} eq 'krb4')) {
                   2936:         $result .= &mt
1.144     matthew  2937:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2938:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2939:          '<label>'.$authtype,
1.281     albertel 2940:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2941:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2942:              'onchange="'.$jscall.'"'.$disabled.' />',
                   2943:          '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
                   2944:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281     albertel 2945: 	 '</label>');
1.586     raeburn  2946:     } elsif ($can_assign{'krb4'}) {
                   2947:         $result .= &mt
                   2948:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2949:          '[_3] Version 4 [_4]',
                   2950:          '<label>'.$authtype,
                   2951:          '</label><input type="text" size="10" name="krbarg" '.
                   2952:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2953:              'onchange="'.$jscall.'"'.$disabled.' />',
1.586     raeburn  2954:          '<label><input type="hidden" name="krbver" value="4" />',
                   2955:          '</label>');
                   2956:     } elsif ($can_assign{'krb5'}) {
                   2957:         $result .= &mt
                   2958:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2959:          '[_3] Version 5 [_4]',
                   2960:          '<label>'.$authtype,
                   2961:          '</label><input type="text" size="10" name="krbarg" '.
                   2962:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2963:              'onchange="'.$jscall.'"'.$disabled.' />',
1.586     raeburn  2964:          '<label><input type="hidden" name="krbver" value="5" />',
                   2965:          '</label>');
                   2966:     }
1.32      matthew  2967:     return $result;
                   2968: }
                   2969: 
1.1075.2.20  raeburn  2970: sub authform_internal {
1.586     raeburn  2971:     my %in = (
1.32      matthew  2972:                 formname => 'document.cu',
                   2973:                 kerb_def_dom => 'MSU.EDU',
                   2974:                 @_,
                   2975:                 );
1.1075.2.117  raeburn  2976:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  2977:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  2978:     if ($in{'readonly'}) {
                   2979:         $disabled = ' disabled="disabled"';
                   2980:     }
1.591     raeburn  2981:     if (defined($in{'curr_authtype'})) {
                   2982:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2983:             if ($can_assign{'int'}) {
1.772     bisitz   2984:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2985:                 if (defined($in{'mode'})) {
                   2986:                     if ($in{'mode'} eq 'modifyuser') {
                   2987:                         $intcheck = '';
                   2988:                     }
                   2989:                 }
1.591     raeburn  2990:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2991:                     $intarg = $in{'curr_autharg'};
                   2992:                 }
                   2993:             } else {
                   2994:                 $result = &mt('Currently internally authenticated.');
                   2995:                 return $result;
1.165     raeburn  2996:             }
                   2997:         }
1.586     raeburn  2998:     } else {
                   2999:         if ($authnum == 1) {
1.784     bisitz   3000:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  3001:         }
                   3002:     }
                   3003:     if (!$can_assign{'int'}) {
                   3004:         return;
1.587     raeburn  3005:     } elsif ($authtype eq '') {
1.591     raeburn  3006:         if (defined($in{'mode'})) {
1.587     raeburn  3007:             if ($in{'mode'} eq 'modifycourse') {
                   3008:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3009:                     $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587     raeburn  3010:                 }
                   3011:             }
                   3012:         }
1.165     raeburn  3013:     }
1.586     raeburn  3014:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   3015:     if ($authtype eq '') {
                   3016:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1075.2.117  raeburn  3017:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3018:     }
1.605     bisitz   3019:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1075.2.117  raeburn  3020:                $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3021:     $result = &mt
1.144     matthew  3022:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  3023:          '<label>'.$authtype,'</label>'.$autharg);
1.1075.2.118  raeburn  3024:     $result.='<label><input type="checkbox" name="visible" onclick="if (this.checked) { this.form.intarg.type='."'text'".' } else { this.form.intarg.type='."'password'".' }"'.$disabled.' />'.&mt('Visible input').'</label>';
1.32      matthew  3025:     return $result;
                   3026: }
                   3027: 
1.1075.2.20  raeburn  3028: sub authform_local {
1.32      matthew  3029:     my %in = (
                   3030:               formname => 'document.cu',
                   3031:               kerb_def_dom => 'MSU.EDU',
                   3032:               @_,
                   3033:               );
1.1075.2.117  raeburn  3034:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  3035:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  3036:     if ($in{'readonly'}) {
                   3037:         $disabled = ' disabled="disabled"';
                   3038:     }
1.591     raeburn  3039:     if (defined($in{'curr_authtype'})) {
                   3040:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  3041:             if ($can_assign{'loc'}) {
1.772     bisitz   3042:                 $loccheck = 'checked="checked" ';
1.623     raeburn  3043:                 if (defined($in{'mode'})) {
                   3044:                     if ($in{'mode'} eq 'modifyuser') {
                   3045:                         $loccheck = '';
                   3046:                     }
                   3047:                 }
1.591     raeburn  3048:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  3049:                     $locarg = $in{'curr_autharg'};
                   3050:                 }
                   3051:             } else {
                   3052:                 $result = &mt('Currently using local (institutional) authentication.');
                   3053:                 return $result;
1.165     raeburn  3054:             }
                   3055:         }
1.586     raeburn  3056:     } else {
                   3057:         if ($authnum == 1) {
1.784     bisitz   3058:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  3059:         }
                   3060:     }
                   3061:     if (!$can_assign{'loc'}) {
                   3062:         return;
1.587     raeburn  3063:     } elsif ($authtype eq '') {
1.591     raeburn  3064:         if (defined($in{'mode'})) {
1.587     raeburn  3065:             if ($in{'mode'} eq 'modifycourse') {
                   3066:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3067:                     $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587     raeburn  3068:                 }
                   3069:             }
                   3070:         }
1.165     raeburn  3071:     }
1.586     raeburn  3072:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   3073:     if ($authtype eq '') {
                   3074:         $authtype = '<input type="radio" name="login" value="loc" '.
                   3075:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1075.2.117  raeburn  3076:                     $jscall.'"'.$disabled.' />';
1.586     raeburn  3077:     }
                   3078:     $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1075.2.117  raeburn  3079:                $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3080:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   3081:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  3082:     return $result;
                   3083: }
                   3084: 
1.1075.2.20  raeburn  3085: sub authform_filesystem {
1.32      matthew  3086:     my %in = (
                   3087:               formname => 'document.cu',
                   3088:               kerb_def_dom => 'MSU.EDU',
                   3089:               @_,
                   3090:               );
1.1075.2.117  raeburn  3091:     my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  3092:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  3093:     if ($in{'readonly'}) {
                   3094:         $disabled = ' disabled="disabled"';
                   3095:     }
1.591     raeburn  3096:     if (defined($in{'curr_authtype'})) {
                   3097:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  3098:             if ($can_assign{'fsys'}) {
1.772     bisitz   3099:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  3100:                 if (defined($in{'mode'})) {
                   3101:                     if ($in{'mode'} eq 'modifyuser') {
                   3102:                         $fsyscheck = '';
                   3103:                     }
                   3104:                 }
1.586     raeburn  3105:             } else {
                   3106:                 $result = &mt('Currently Filesystem Authenticated.');
                   3107:                 return $result;
                   3108:             }           
                   3109:         }
                   3110:     } else {
                   3111:         if ($authnum == 1) {
1.784     bisitz   3112:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  3113:         }
                   3114:     }
                   3115:     if (!$can_assign{'fsys'}) {
                   3116:         return;
1.587     raeburn  3117:     } elsif ($authtype eq '') {
1.591     raeburn  3118:         if (defined($in{'mode'})) {
1.587     raeburn  3119:             if ($in{'mode'} eq 'modifycourse') {
                   3120:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3121:                     $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587     raeburn  3122:                 }
                   3123:             }
                   3124:         }
1.586     raeburn  3125:     }
                   3126:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   3127:     if ($authtype eq '') {
                   3128:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   3129:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1075.2.117  raeburn  3130:                     $jscall.'"'.$disabled.' />';
1.586     raeburn  3131:     }
                   3132:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
1.1075.2.117  raeburn  3133:                ' onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3134:     $result = &mt
1.144     matthew  3135:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 3136:          '<label><input type="radio" name="login" value="fsys" '.
1.1075.2.117  raeburn  3137:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />',
1.605     bisitz   3138:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.1075.2.117  raeburn  3139:                   'onchange="'.$jscall.'"'.$disabled.' />');
1.32      matthew  3140:     return $result;
                   3141: }
                   3142: 
1.586     raeburn  3143: sub get_assignable_auth {
                   3144:     my ($dom) = @_;
                   3145:     if ($dom eq '') {
                   3146:         $dom = $env{'request.role.domain'};
                   3147:     }
                   3148:     my %can_assign = (
                   3149:                           krb4 => 1,
                   3150:                           krb5 => 1,
                   3151:                           int  => 1,
                   3152:                           loc  => 1,
                   3153:                      );
                   3154:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   3155:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   3156:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   3157:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   3158:             my $context;
                   3159:             if ($env{'request.role'} =~ /^au/) {
                   3160:                 $context = 'author';
1.1075.2.117  raeburn  3161:             } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586     raeburn  3162:                 $context = 'domain';
                   3163:             } elsif ($env{'request.course.id'}) {
                   3164:                 $context = 'course';
                   3165:             }
                   3166:             if ($context) {
                   3167:                 if (ref($authhash->{$context}) eq 'HASH') {
                   3168:                    %can_assign = %{$authhash->{$context}}; 
                   3169:                 }
                   3170:             }
                   3171:         }
                   3172:     }
                   3173:     my $authnum = 0;
                   3174:     foreach my $key (keys(%can_assign)) {
                   3175:         if ($can_assign{$key}) {
                   3176:             $authnum ++;
                   3177:         }
                   3178:     }
                   3179:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   3180:         $authnum --;
                   3181:     }
                   3182:     return ($authnum,%can_assign);
                   3183: }
                   3184: 
1.1075.2.137  raeburn  3185: sub check_passwd_rules {
                   3186:     my ($domain,$plainpass) = @_;
                   3187:     my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
                   3188:     my ($min,$max,@chars,@brokerule,$warning);
1.1075.2.138  raeburn  3189:     $min = $Apache::lonnet::passwdmin;
1.1075.2.137  raeburn  3190:     if (ref($passwdconf{'chars'}) eq 'ARRAY') {
                   3191:         if ($passwdconf{'min'} =~ /^\d+$/) {
1.1075.2.138  raeburn  3192:             if ($passwdconf{'min'} > $min) {
                   3193:                 $min = $passwdconf{'min'};
                   3194:             }
1.1075.2.137  raeburn  3195:         }
                   3196:         if ($passwdconf{'max'} =~ /^\d+$/) {
                   3197:             $max = $passwdconf{'max'};
                   3198:         }
                   3199:         @chars = @{$passwdconf{'chars'}};
                   3200:     }
                   3201:     if (($min) && (length($plainpass) < $min)) {
                   3202:         push(@brokerule,'min');
                   3203:     }
                   3204:     if (($max) && (length($plainpass) > $max)) {
                   3205:         push(@brokerule,'max');
                   3206:     }
                   3207:     if (@chars) {
                   3208:         my %rules;
                   3209:         map { $rules{$_} = 1; } @chars;
                   3210:         if ($rules{'uc'}) {
                   3211:             unless ($plainpass =~ /[A-Z]/) {
                   3212:                 push(@brokerule,'uc');
                   3213:             }
                   3214:         }
                   3215:         if ($rules{'lc'}) {
                   3216:             unless ($plainpass =~ /[a-z]/) {
                   3217:                 push(@brokerule,'lc');
                   3218:             }
                   3219:         }
                   3220:         if ($rules{'num'}) {
                   3221:             unless ($plainpass =~ /\d/) {
                   3222:                 push(@brokerule,'num');
                   3223:             }
                   3224:         }
                   3225:         if ($rules{'spec'}) {
                   3226:             unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
                   3227:                 push(@brokerule,'spec');
                   3228:             }
                   3229:         }
                   3230:     }
                   3231:     if (@brokerule) {
                   3232:         my %rulenames = &Apache::lonlocal::texthash(
                   3233:             uc   => 'At least one upper case letter',
                   3234:             lc   => 'At least one lower case letter',
                   3235:             num  => 'At least one number',
                   3236:             spec => 'At least one non-alphanumeric',
                   3237:         );
                   3238:         $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
                   3239:         $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
                   3240:         $rulenames{'num'} .= ': 0123456789';
                   3241:         $rulenames{'spec'} .= ': !&quot;\#$%&amp;\'()*+,-./:;&lt;=&gt;?@[\]^_\`{|}~';
                   3242:         $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
                   3243:         $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
                   3244:         $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1075.2.141.  .3(raebu 3245:20):         foreach my $rule ('min','max','uc','lc','num','spec') {
1.1075.2.137  raeburn  3246:             if (grep(/^$rule$/,@brokerule)) {
                   3247:                 $warning .= '<li>'.$rulenames{$rule}.'</li>';
                   3248:             }
                   3249:         }
                   3250:         $warning .= '</ul>';
                   3251:     }
                   3252:     if (wantarray) {
                   3253:         return @brokerule;
                   3254:     }
                   3255:     return $warning;
                   3256: }
                   3257: 
1.80      albertel 3258: ###############################################################
                   3259: ##    Get Kerberos Defaults for Domain                 ##
                   3260: ###############################################################
                   3261: ##
                   3262: ## Returns default kerberos version and an associated argument
                   3263: ## as listed in file domain.tab. If not listed, provides
                   3264: ## appropriate default domain and kerberos version.
                   3265: ##
                   3266: #-------------------------------------------
                   3267: 
                   3268: =pod
                   3269: 
1.648     raeburn  3270: =item * &get_kerberos_defaults()
1.80      albertel 3271: 
                   3272: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  3273: version and domain. If not found, it defaults to version 4 and the 
                   3274: domain of the server.
1.80      albertel 3275: 
1.648     raeburn  3276: =over 4
                   3277: 
1.80      albertel 3278: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   3279: 
1.648     raeburn  3280: =back
                   3281: 
                   3282: =back
                   3283: 
1.80      albertel 3284: =cut
                   3285: 
                   3286: #-------------------------------------------
                   3287: sub get_kerberos_defaults {
                   3288:     my $domain=shift;
1.641     raeburn  3289:     my ($krbdef,$krbdefdom);
                   3290:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   3291:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   3292:         $krbdef = $domdefaults{'auth_def'};
                   3293:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   3294:     } else {
1.80      albertel 3295:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   3296:         my $krbdefdom=$1;
                   3297:         $krbdefdom=~tr/a-z/A-Z/;
                   3298:         $krbdef = "krb4";
                   3299:     }
                   3300:     return ($krbdef,$krbdefdom);
                   3301: }
1.112     bowersj2 3302: 
1.32      matthew  3303: 
1.46      matthew  3304: ###############################################################
                   3305: ##                Thesaurus Functions                        ##
                   3306: ###############################################################
1.20      www      3307: 
1.46      matthew  3308: =pod
1.20      www      3309: 
1.112     bowersj2 3310: =head1 Thesaurus Functions
                   3311: 
                   3312: =over 4
                   3313: 
1.648     raeburn  3314: =item * &initialize_keywords()
1.46      matthew  3315: 
                   3316: Initializes the package variable %Keywords if it is empty.  Uses the
                   3317: package variable $thesaurus_db_file.
                   3318: 
                   3319: =cut
                   3320: 
                   3321: ###################################################
                   3322: 
                   3323: sub initialize_keywords {
                   3324:     return 1 if (scalar keys(%Keywords));
                   3325:     # If we are here, %Keywords is empty, so fill it up
                   3326:     #   Make sure the file we need exists...
                   3327:     if (! -e $thesaurus_db_file) {
                   3328:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   3329:                                  " failed because it does not exist");
                   3330:         return 0;
                   3331:     }
                   3332:     #   Set up the hash as a database
                   3333:     my %thesaurus_db;
                   3334:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3335:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3336:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   3337:                                  $thesaurus_db_file);
                   3338:         return 0;
                   3339:     } 
                   3340:     #  Get the average number of appearances of a word.
                   3341:     my $avecount = $thesaurus_db{'average.count'};
                   3342:     #  Put keywords (those that appear > average) into %Keywords
                   3343:     while (my ($word,$data)=each (%thesaurus_db)) {
                   3344:         my ($count,undef) = split /:/,$data;
                   3345:         $Keywords{$word}++ if ($count > $avecount);
                   3346:     }
                   3347:     untie %thesaurus_db;
                   3348:     # Remove special values from %Keywords.
1.356     albertel 3349:     foreach my $value ('total.count','average.count') {
                   3350:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  3351:   }
1.46      matthew  3352:     return 1;
                   3353: }
                   3354: 
                   3355: ###################################################
                   3356: 
                   3357: =pod
                   3358: 
1.648     raeburn  3359: =item * &keyword($word)
1.46      matthew  3360: 
                   3361: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   3362: than the average number of times in the thesaurus database.  Calls 
                   3363: &initialize_keywords
                   3364: 
                   3365: =cut
                   3366: 
                   3367: ###################################################
1.20      www      3368: 
                   3369: sub keyword {
1.46      matthew  3370:     return if (!&initialize_keywords());
                   3371:     my $word=lc(shift());
                   3372:     $word=~s/\W//g;
                   3373:     return exists($Keywords{$word});
1.20      www      3374: }
1.46      matthew  3375: 
                   3376: ###############################################################
                   3377: 
                   3378: =pod 
1.20      www      3379: 
1.648     raeburn  3380: =item * &get_related_words()
1.46      matthew  3381: 
1.160     matthew  3382: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  3383: an array of words.  If the keyword is not in the thesaurus, an empty array
                   3384: will be returned.  The order of the words returned is determined by the
                   3385: database which holds them.
                   3386: 
                   3387: Uses global $thesaurus_db_file.
                   3388: 
1.1057    foxr     3389: 
1.46      matthew  3390: =cut
                   3391: 
                   3392: ###############################################################
                   3393: sub get_related_words {
                   3394:     my $keyword = shift;
                   3395:     my %thesaurus_db;
                   3396:     if (! -e $thesaurus_db_file) {
                   3397:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   3398:                                  "failed because the file does not exist");
                   3399:         return ();
                   3400:     }
                   3401:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3402:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3403:         return ();
                   3404:     } 
                   3405:     my @Words=();
1.429     www      3406:     my $count=0;
1.46      matthew  3407:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 3408: 	# The first element is the number of times
                   3409: 	# the word appears.  We do not need it now.
1.429     www      3410: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   3411: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   3412: 	my $threshold=$mostfrequentcount/10;
                   3413:         foreach my $possibleword (@RelatedWords) {
                   3414:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   3415:             if ($wordcount>$threshold) {
                   3416: 		push(@Words,$word);
                   3417:                 $count++;
                   3418:                 if ($count>10) { last; }
                   3419: 	    }
1.20      www      3420:         }
                   3421:     }
1.46      matthew  3422:     untie %thesaurus_db;
                   3423:     return @Words;
1.14      harris41 3424: }
1.46      matthew  3425: 
1.112     bowersj2 3426: =pod
                   3427: 
                   3428: =back
                   3429: 
                   3430: =cut
1.61      www      3431: 
                   3432: # -------------------------------------------------------------- Plaintext name
1.81      albertel 3433: =pod
                   3434: 
1.112     bowersj2 3435: =head1 User Name Functions
                   3436: 
                   3437: =over 4
                   3438: 
1.648     raeburn  3439: =item * &plainname($uname,$udom,$first)
1.81      albertel 3440: 
1.112     bowersj2 3441: Takes a users logon name and returns it as a string in
1.226     albertel 3442: "first middle last generation" form 
                   3443: if $first is set to 'lastname' then it returns it as
                   3444: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 3445: 
                   3446: =cut
1.61      www      3447: 
1.295     www      3448: 
1.81      albertel 3449: ###############################################################
1.61      www      3450: sub plainname {
1.226     albertel 3451:     my ($uname,$udom,$first)=@_;
1.537     albertel 3452:     return if (!defined($uname) || !defined($udom));
1.295     www      3453:     my %names=&getnames($uname,$udom);
1.226     albertel 3454:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   3455: 					  $names{'middlename'},
                   3456: 					  $names{'lastname'},
                   3457: 					  $names{'generation'},$first);
                   3458:     $name=~s/^\s+//;
1.62      www      3459:     $name=~s/\s+$//;
                   3460:     $name=~s/\s+/ /g;
1.353     albertel 3461:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      3462:     return $name;
1.61      www      3463: }
1.66      www      3464: 
                   3465: # -------------------------------------------------------------------- Nickname
1.81      albertel 3466: =pod
                   3467: 
1.648     raeburn  3468: =item * &nickname($uname,$udom)
1.81      albertel 3469: 
                   3470: Gets a users name and returns it as a string as
                   3471: 
                   3472: "&quot;nickname&quot;"
1.66      www      3473: 
1.81      albertel 3474: if the user has a nickname or
                   3475: 
                   3476: "first middle last generation"
                   3477: 
                   3478: if the user does not
                   3479: 
                   3480: =cut
1.66      www      3481: 
                   3482: sub nickname {
                   3483:     my ($uname,$udom)=@_;
1.537     albertel 3484:     return if (!defined($uname) || !defined($udom));
1.295     www      3485:     my %names=&getnames($uname,$udom);
1.68      albertel 3486:     my $name=$names{'nickname'};
1.66      www      3487:     if ($name) {
                   3488:        $name='&quot;'.$name.'&quot;'; 
                   3489:     } else {
                   3490:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   3491: 	     $names{'lastname'}.' '.$names{'generation'};
                   3492:        $name=~s/\s+$//;
                   3493:        $name=~s/\s+/ /g;
                   3494:     }
                   3495:     return $name;
                   3496: }
                   3497: 
1.295     www      3498: sub getnames {
                   3499:     my ($uname,$udom)=@_;
1.537     albertel 3500:     return if (!defined($uname) || !defined($udom));
1.433     albertel 3501:     if ($udom eq 'public' && $uname eq 'public') {
                   3502: 	return ('lastname' => &mt('Public'));
                   3503:     }
1.295     www      3504:     my $id=$uname.':'.$udom;
                   3505:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   3506:     if ($cached) {
                   3507: 	return %{$names};
                   3508:     } else {
                   3509: 	my %loadnames=&Apache::lonnet::get('environment',
                   3510:                     ['firstname','middlename','lastname','generation','nickname'],
                   3511: 					 $udom,$uname);
                   3512: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   3513: 	return %loadnames;
                   3514:     }
                   3515: }
1.61      www      3516: 
1.542     raeburn  3517: # -------------------------------------------------------------------- getemails
1.648     raeburn  3518: 
1.542     raeburn  3519: =pod
                   3520: 
1.648     raeburn  3521: =item * &getemails($uname,$udom)
1.542     raeburn  3522: 
                   3523: Gets a user's email information and returns it as a hash with keys:
                   3524: notification, critnotification, permanentemail
                   3525: 
                   3526: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  3527: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  3528:  
1.648     raeburn  3529: 
1.542     raeburn  3530: =cut
                   3531: 
1.648     raeburn  3532: 
1.466     albertel 3533: sub getemails {
                   3534:     my ($uname,$udom)=@_;
                   3535:     if ($udom eq 'public' && $uname eq 'public') {
                   3536: 	return;
                   3537:     }
1.467     www      3538:     if (!$udom) { $udom=$env{'user.domain'}; }
                   3539:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 3540:     my $id=$uname.':'.$udom;
                   3541:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   3542:     if ($cached) {
                   3543: 	return %{$names};
                   3544:     } else {
                   3545: 	my %loadnames=&Apache::lonnet::get('environment',
                   3546:                     			   ['notification','critnotification',
                   3547: 					    'permanentemail'],
                   3548: 					   $udom,$uname);
                   3549: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   3550: 	return %loadnames;
                   3551:     }
                   3552: }
                   3553: 
1.551     albertel 3554: sub flush_email_cache {
                   3555:     my ($uname,$udom)=@_;
                   3556:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3557:     if (!$uname) { $uname=$env{'user.name'};   }
                   3558:     return if ($udom eq 'public' && $uname eq 'public');
                   3559:     my $id=$uname.':'.$udom;
                   3560:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   3561: }
                   3562: 
1.728     raeburn  3563: # -------------------------------------------------------------------- getlangs
                   3564: 
                   3565: =pod
                   3566: 
                   3567: =item * &getlangs($uname,$udom)
                   3568: 
                   3569: Gets a user's language preference and returns it as a hash with key:
                   3570: language.
                   3571: 
                   3572: =cut
                   3573: 
                   3574: 
                   3575: sub getlangs {
                   3576:     my ($uname,$udom) = @_;
                   3577:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3578:     if (!$uname) { $uname=$env{'user.name'};   }
                   3579:     my $id=$uname.':'.$udom;
                   3580:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   3581:     if ($cached) {
                   3582:         return %{$langs};
                   3583:     } else {
                   3584:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   3585:                                            $udom,$uname);
                   3586:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   3587:         return %loadlangs;
                   3588:     }
                   3589: }
                   3590: 
                   3591: sub flush_langs_cache {
                   3592:     my ($uname,$udom)=@_;
                   3593:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3594:     if (!$uname) { $uname=$env{'user.name'};   }
                   3595:     return if ($udom eq 'public' && $uname eq 'public');
                   3596:     my $id=$uname.':'.$udom;
                   3597:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   3598: }
                   3599: 
1.61      www      3600: # ------------------------------------------------------------------ Screenname
1.81      albertel 3601: 
                   3602: =pod
                   3603: 
1.648     raeburn  3604: =item * &screenname($uname,$udom)
1.81      albertel 3605: 
                   3606: Gets a users screenname and returns it as a string
                   3607: 
                   3608: =cut
1.61      www      3609: 
                   3610: sub screenname {
                   3611:     my ($uname,$udom)=@_;
1.258     albertel 3612:     if ($uname eq $env{'user.name'} &&
                   3613: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 3614:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 3615:     return $names{'screenname'};
1.62      www      3616: }
                   3617: 
1.212     albertel 3618: 
1.802     bisitz   3619: # ------------------------------------------------------------- Confirm Wrapper
                   3620: =pod
                   3621: 
1.1075.2.42  raeburn  3622: =item * &confirmwrapper($message)
1.802     bisitz   3623: 
                   3624: Wrap messages about completion of operation in box
                   3625: 
                   3626: =cut
                   3627: 
                   3628: sub confirmwrapper {
                   3629:     my ($message)=@_;
                   3630:     if ($message) {
                   3631:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3632:                .$message."\n"
                   3633:                .'</div>'."\n";
                   3634:     } else {
                   3635:         return $message;
                   3636:     }
                   3637: }
                   3638: 
1.62      www      3639: # ------------------------------------------------------------- Message Wrapper
                   3640: 
                   3641: sub messagewrapper {
1.369     www      3642:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3643:     return 
1.441     albertel 3644:         '<a href="/adm/email?compose=individual&amp;'.
                   3645:         'recname='.$username.'&amp;recdom='.$domain.
                   3646: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3647:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3648: }
1.802     bisitz   3649: 
1.74      www      3650: # --------------------------------------------------------------- Notes Wrapper
                   3651: 
                   3652: sub noteswrapper {
                   3653:     my ($link,$un,$do)=@_;
                   3654:     return 
1.896     amueller 3655: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3656: }
1.802     bisitz   3657: 
1.62      www      3658: # ------------------------------------------------------------- Aboutme Wrapper
                   3659: 
                   3660: sub aboutmewrapper {
1.1070    raeburn  3661:     my ($link,$username,$domain,$target,$class)=@_;
1.447     raeburn  3662:     if (!defined($username)  && !defined($domain)) {
                   3663:         return;
                   3664:     }
1.1075.2.15  raeburn  3665:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070    raeburn  3666: 	($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3667: }
                   3668: 
                   3669: # ------------------------------------------------------------ Syllabus Wrapper
                   3670: 
                   3671: sub syllabuswrapper {
1.707     bisitz   3672:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3673:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3674: }
1.14      harris41 3675: 
1.802     bisitz   3676: # -----------------------------------------------------------------------------
                   3677: 
1.208     matthew  3678: sub track_student_link {
1.887     raeburn  3679:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3680:     my $link ="/adm/trackstudent?";
1.208     matthew  3681:     my $title = 'View recent activity';
                   3682:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3683:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3684:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3685:         $title .= ' of this student';
1.268     albertel 3686:     } 
1.208     matthew  3687:     if (defined($target) && $target !~ /^\s*$/) {
                   3688:         $target = qq{target="$target"};
                   3689:     } else {
                   3690:         $target = '';
                   3691:     }
1.268     albertel 3692:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3693:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3694:     $title = &mt($title);
                   3695:     $linktext = &mt($linktext);
1.448     albertel 3696:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3697: 	&help_open_topic('View_recent_activity');
1.208     matthew  3698: }
                   3699: 
1.781     raeburn  3700: sub slot_reservations_link {
                   3701:     my ($linktext,$sname,$sdom,$target) = @_;
                   3702:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3703:     my $title = 'View slot reservation history';
                   3704:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3705:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3706:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3707:         $title .= ' of this student';
                   3708:     }
                   3709:     if (defined($target) && $target !~ /^\s*$/) {
                   3710:         $target = qq{target="$target"};
                   3711:     } else {
                   3712:         $target = '';
                   3713:     }
                   3714:     $title = &mt($title);
                   3715:     $linktext = &mt($linktext);
                   3716:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3717: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3718: 
                   3719: }
                   3720: 
1.508     www      3721: # ===================================================== Display a student photo
                   3722: 
                   3723: 
1.509     albertel 3724: sub student_image_tag {
1.508     www      3725:     my ($domain,$user)=@_;
                   3726:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3727:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3728: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3729:     } else {
                   3730: 	return '';
                   3731:     }
                   3732: }
                   3733: 
1.112     bowersj2 3734: =pod
                   3735: 
                   3736: =back
                   3737: 
                   3738: =head1 Access .tab File Data
                   3739: 
                   3740: =over 4
                   3741: 
1.648     raeburn  3742: =item * &languageids() 
1.112     bowersj2 3743: 
                   3744: returns list of all language ids
                   3745: 
                   3746: =cut
                   3747: 
1.14      harris41 3748: sub languageids {
1.16      harris41 3749:     return sort(keys(%language));
1.14      harris41 3750: }
                   3751: 
1.112     bowersj2 3752: =pod
                   3753: 
1.648     raeburn  3754: =item * &languagedescription() 
1.112     bowersj2 3755: 
                   3756: returns description of a specified language id
                   3757: 
                   3758: =cut
                   3759: 
1.14      harris41 3760: sub languagedescription {
1.125     www      3761:     my $code=shift;
                   3762:     return  ($supported_language{$code}?'* ':'').
                   3763:             $language{$code}.
1.126     www      3764: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3765: }
                   3766: 
1.1048    foxr     3767: =pod
                   3768: 
                   3769: =item * &plainlanguagedescription
                   3770: 
                   3771: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
                   3772: and the language character encoding (e.g. ISO) separated by a ' - ' string.
                   3773: 
                   3774: =cut
                   3775: 
1.145     www      3776: sub plainlanguagedescription {
                   3777:     my $code=shift;
                   3778:     return $language{$code};
                   3779: }
                   3780: 
1.1048    foxr     3781: =pod
                   3782: 
                   3783: =item * &supportedlanguagecode
                   3784: 
                   3785: Returns the supported language code (e.g. sptutf maps to pt) given a language
                   3786: code.
                   3787: 
                   3788: =cut
                   3789: 
1.145     www      3790: sub supportedlanguagecode {
                   3791:     my $code=shift;
                   3792:     return $supported_language{$code};
1.97      www      3793: }
                   3794: 
1.112     bowersj2 3795: =pod
                   3796: 
1.1048    foxr     3797: =item * &latexlanguage()
                   3798: 
                   3799: Given a language key code returns the correspondnig language to use
                   3800: to select the correct hyphenation on LaTeX printouts.  This is undef if there
                   3801: is no supported hyphenation for the language code.
                   3802: 
                   3803: =cut
                   3804: 
                   3805: sub latexlanguage {
                   3806:     my $code = shift;
                   3807:     return $latex_language{$code};
                   3808: }
                   3809: 
                   3810: =pod
                   3811: 
                   3812: =item * &latexhyphenation()
                   3813: 
                   3814: Same as above but what's supplied is the language as it might be stored
                   3815: in the metadata.
                   3816: 
                   3817: =cut
                   3818: 
                   3819: sub latexhyphenation {
                   3820:     my $key = shift;
                   3821:     return $latex_language_bykey{$key};
                   3822: }
                   3823: 
                   3824: =pod
                   3825: 
1.648     raeburn  3826: =item * &copyrightids() 
1.112     bowersj2 3827: 
                   3828: returns list of all copyrights
                   3829: 
                   3830: =cut
                   3831: 
                   3832: sub copyrightids {
                   3833:     return sort(keys(%cprtag));
                   3834: }
                   3835: 
                   3836: =pod
                   3837: 
1.648     raeburn  3838: =item * &copyrightdescription() 
1.112     bowersj2 3839: 
                   3840: returns description of a specified copyright id
                   3841: 
                   3842: =cut
                   3843: 
                   3844: sub copyrightdescription {
1.166     www      3845:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3846: }
1.197     matthew  3847: 
                   3848: =pod
                   3849: 
1.648     raeburn  3850: =item * &source_copyrightids() 
1.192     taceyjo1 3851: 
                   3852: returns list of all source copyrights
                   3853: 
                   3854: =cut
                   3855: 
                   3856: sub source_copyrightids {
                   3857:     return sort(keys(%scprtag));
                   3858: }
                   3859: 
                   3860: =pod
                   3861: 
1.648     raeburn  3862: =item * &source_copyrightdescription() 
1.192     taceyjo1 3863: 
                   3864: returns description of a specified source copyright id
                   3865: 
                   3866: =cut
                   3867: 
                   3868: sub source_copyrightdescription {
                   3869:     return &mt($scprtag{shift(@_)});
                   3870: }
1.112     bowersj2 3871: 
                   3872: =pod
                   3873: 
1.648     raeburn  3874: =item * &filecategories() 
1.112     bowersj2 3875: 
                   3876: returns list of all file categories
                   3877: 
                   3878: =cut
                   3879: 
                   3880: sub filecategories {
                   3881:     return sort(keys(%category_extensions));
                   3882: }
                   3883: 
                   3884: =pod
                   3885: 
1.648     raeburn  3886: =item * &filecategorytypes() 
1.112     bowersj2 3887: 
                   3888: returns list of file types belonging to a given file
                   3889: category
                   3890: 
                   3891: =cut
                   3892: 
                   3893: sub filecategorytypes {
1.356     albertel 3894:     my ($cat) = @_;
                   3895:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3896: }
                   3897: 
                   3898: =pod
                   3899: 
1.648     raeburn  3900: =item * &fileembstyle() 
1.112     bowersj2 3901: 
                   3902: returns embedding style for a specified file type
                   3903: 
                   3904: =cut
                   3905: 
                   3906: sub fileembstyle {
                   3907:     return $fe{lc(shift(@_))};
1.169     www      3908: }
                   3909: 
1.351     www      3910: sub filemimetype {
                   3911:     return $fm{lc(shift(@_))};
                   3912: }
                   3913: 
1.169     www      3914: 
                   3915: sub filecategoryselect {
                   3916:     my ($name,$value)=@_;
1.189     matthew  3917:     return &select_form($value,$name,
1.970     raeburn  3918:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112     bowersj2 3919: }
                   3920: 
                   3921: =pod
                   3922: 
1.648     raeburn  3923: =item * &filedescription() 
1.112     bowersj2 3924: 
                   3925: returns description for a specified file type
                   3926: 
                   3927: =cut
                   3928: 
                   3929: sub filedescription {
1.188     matthew  3930:     my $file_description = $fd{lc(shift())};
                   3931:     $file_description =~ s:([\[\]]):~$1:g;
                   3932:     return &mt($file_description);
1.112     bowersj2 3933: }
                   3934: 
                   3935: =pod
                   3936: 
1.648     raeburn  3937: =item * &filedescriptionex() 
1.112     bowersj2 3938: 
                   3939: returns description for a specified file type with
                   3940: extra formatting
                   3941: 
                   3942: =cut
                   3943: 
                   3944: sub filedescriptionex {
                   3945:     my $ex=shift;
1.188     matthew  3946:     my $file_description = $fd{lc($ex)};
                   3947:     $file_description =~ s:([\[\]]):~$1:g;
                   3948:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3949: }
                   3950: 
                   3951: # End of .tab access
                   3952: =pod
                   3953: 
                   3954: =back
                   3955: 
                   3956: =cut
                   3957: 
                   3958: # ------------------------------------------------------------------ File Types
                   3959: sub fileextensions {
                   3960:     return sort(keys(%fe));
                   3961: }
                   3962: 
1.97      www      3963: # ----------------------------------------------------------- Display Languages
                   3964: # returns a hash with all desired display languages
                   3965: #
                   3966: 
                   3967: sub display_languages {
                   3968:     my %languages=();
1.695     raeburn  3969:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3970: 	$languages{$lang}=1;
1.97      www      3971:     }
                   3972:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3973:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3974: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3975: 	    $languages{$lang}=1;
1.97      www      3976:         }
                   3977:     }
                   3978:     return %languages;
1.14      harris41 3979: }
                   3980: 
1.582     albertel 3981: sub languages {
                   3982:     my ($possible_langs) = @_;
1.695     raeburn  3983:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3984:     if (!ref($possible_langs)) {
                   3985: 	if( wantarray ) {
                   3986: 	    return @preferred_langs;
                   3987: 	} else {
                   3988: 	    return $preferred_langs[0];
                   3989: 	}
                   3990:     }
                   3991:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3992:     my @preferred_possibilities;
                   3993:     foreach my $preferred_lang (@preferred_langs) {
                   3994: 	if (exists($possibilities{$preferred_lang})) {
                   3995: 	    push(@preferred_possibilities, $preferred_lang);
                   3996: 	}
                   3997:     }
                   3998:     if( wantarray ) {
                   3999: 	return @preferred_possibilities;
                   4000:     }
                   4001:     return $preferred_possibilities[0];
                   4002: }
                   4003: 
1.742     raeburn  4004: sub user_lang {
                   4005:     my ($touname,$toudom,$fromcid) = @_;
                   4006:     my @userlangs;
                   4007:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   4008:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   4009:                     $env{'course.'.$fromcid.'.languages'}));
                   4010:     } else {
                   4011:         my %langhash = &getlangs($touname,$toudom);
                   4012:         if ($langhash{'languages'} ne '') {
                   4013:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   4014:         } else {
                   4015:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   4016:             if ($domdefs{'lang_def'} ne '') {
                   4017:                 @userlangs = ($domdefs{'lang_def'});
                   4018:             }
                   4019:         }
                   4020:     }
                   4021:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   4022:     my $user_lh = Apache::localize->get_handle(@languages);
                   4023:     return $user_lh;
                   4024: }
                   4025: 
                   4026: 
1.112     bowersj2 4027: ###############################################################
                   4028: ##               Student Answer Attempts                     ##
                   4029: ###############################################################
                   4030: 
                   4031: =pod
                   4032: 
                   4033: =head1 Alternate Problem Views
                   4034: 
                   4035: =over 4
                   4036: 
1.648     raeburn  4037: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1075.2.86  raeburn  4038:     $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112     bowersj2 4039: 
                   4040: Return string with previous attempt on problem. Arguments:
                   4041: 
                   4042: =over 4
                   4043: 
                   4044: =item * $symb: Problem, including path
                   4045: 
                   4046: =item * $username: username of the desired student
                   4047: 
                   4048: =item * $domain: domain of the desired student
1.14      harris41 4049: 
1.112     bowersj2 4050: =item * $course: Course ID
1.14      harris41 4051: 
1.112     bowersj2 4052: =item * $getattempt: Leave blank for all attempts, otherwise put
                   4053:     something
1.14      harris41 4054: 
1.112     bowersj2 4055: =item * $regexp: if string matches this regexp, the string will be
                   4056:     sent to $gradesub
1.14      harris41 4057: 
1.112     bowersj2 4058: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 4059: 
1.1075.2.86  raeburn  4060: =item * $usec: section of the desired student
                   4061: 
                   4062: =item * $identifier: counter for student (multiple students one problem) or
                   4063:     problem (one student; whole sequence).
                   4064: 
1.112     bowersj2 4065: =back
1.14      harris41 4066: 
1.112     bowersj2 4067: The output string is a table containing all desired attempts, if any.
1.16      harris41 4068: 
1.112     bowersj2 4069: =cut
1.1       albertel 4070: 
                   4071: sub get_previous_attempt {
1.1075.2.86  raeburn  4072:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1       albertel 4073:   my $prevattempts='';
1.43      ng       4074:   no strict 'refs';
1.1       albertel 4075:   if ($symb) {
1.3       albertel 4076:     my (%returnhash)=
                   4077:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 4078:     if ($returnhash{'version'}) {
                   4079:       my %lasthash=();
                   4080:       my $version;
                   4081:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.91  raeburn  4082:         foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
                   4083:             if ($key =~ /\.rawrndseed$/) {
                   4084:                 my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
                   4085:                 $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
                   4086:             } else {
                   4087:                 $lasthash{$key}=$returnhash{$version.':'.$key};
                   4088:             }
1.19      harris41 4089:         }
1.1       albertel 4090:       }
1.596     albertel 4091:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   4092:       $prevattempts.='<th>'.&mt('History').'</th>';
1.1075.2.86  raeburn  4093:       my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945     raeburn  4094:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 4095:       foreach my $key (sort(keys(%lasthash))) {
                   4096: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       4097: 	if ($#parts > 0) {
1.31      albertel 4098: 	  my $data=$parts[-1];
1.989     raeburn  4099:           next if ($data eq 'foilorder');
1.31      albertel 4100: 	  pop(@parts);
1.1010    www      4101:           $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.945     raeburn  4102:           if ($data eq 'type') {
                   4103:               unless ($showsurv) {
                   4104:                   my $id = join(',',@parts);
                   4105:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978     raeburn  4106:                   if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                   4107:                       $lasthidden{$ign.'.'.$id} = 1;
                   4108:                   }
1.945     raeburn  4109:               }
1.1075.2.86  raeburn  4110:               if ($identifier ne '') {
                   4111:                   my $id = join(',',@parts);
                   4112:                   if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
                   4113:                                                $domain,$username,$usec,undef,$course) =~ /^no/) {
                   4114:                       $hidestatus{$ign.'.'.$id} = 1;
                   4115:                   }
                   4116:               }
                   4117:           } elsif ($data eq 'regrader') {
                   4118:               if (($identifier ne '') && (@parts)) {
                   4119:                   my $id = join(',',@parts);
                   4120:                   $regraded{$ign.'.'.$id} = 1;
                   4121:               }
1.1010    www      4122:           } 
1.31      albertel 4123: 	} else {
1.41      ng       4124: 	  if ($#parts == 0) {
                   4125: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   4126: 	  } else {
                   4127: 	    $prevattempts.='<th>'.$ign.'</th>';
                   4128: 	  }
1.31      albertel 4129: 	}
1.16      harris41 4130:       }
1.596     albertel 4131:       $prevattempts.=&end_data_table_header_row();
1.40      ng       4132:       if ($getattempt eq '') {
1.1075.2.86  raeburn  4133:         my (%solved,%resets,%probstatus);
                   4134:         if (($identifier ne '') && (keys(%regraded) > 0)) {
                   4135:             for ($version=1;$version<=$returnhash{'version'};$version++) {
                   4136:                 foreach my $id (keys(%regraded)) {
                   4137:                     if (($returnhash{$version.':'.$id.'.regrader'}) &&
                   4138:                         ($returnhash{$version.':'.$id.'.tries'} eq '') &&
                   4139:                         ($returnhash{$version.':'.$id.'.award'} eq '')) {
                   4140:                         push(@{$resets{$id}},$version);
                   4141:                     }
                   4142:                 }
                   4143:             }
                   4144:         }
1.40      ng       4145: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.86  raeburn  4146:             my (@hidden,@unsolved);
1.945     raeburn  4147:             if (%typeparts) {
                   4148:                 foreach my $id (keys(%typeparts)) {
1.1075.2.86  raeburn  4149:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
                   4150:                         ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945     raeburn  4151:                         push(@hidden,$id);
1.1075.2.86  raeburn  4152:                     } elsif ($identifier ne '') {
                   4153:                         unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
                   4154:                                 ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
                   4155:                                 ($hidestatus{$id})) {
                   4156:                             next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
                   4157:                             if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
                   4158:                                 push(@{$solved{$id}},$version);
                   4159:                             } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
                   4160:                                      (ref($solved{$id}) eq 'ARRAY')) {
                   4161:                                 my $skip;
                   4162:                                 if (ref($resets{$id}) eq 'ARRAY') {
                   4163:                                     foreach my $reset (@{$resets{$id}}) {
                   4164:                                         if ($reset > $solved{$id}[-1]) {
                   4165:                                             $skip=1;
                   4166:                                             last;
                   4167:                                         }
                   4168:                                     }
                   4169:                                 }
                   4170:                                 unless ($skip) {
                   4171:                                     my ($ign,$partslist) = split(/\./,$id,2);
                   4172:                                     push(@unsolved,$partslist);
                   4173:                                 }
                   4174:                             }
                   4175:                         }
1.945     raeburn  4176:                     }
                   4177:                 }
                   4178:             }
                   4179:             $prevattempts.=&start_data_table_row().
1.1075.2.86  raeburn  4180:                            '<td>'.&mt('Transaction [_1]',$version);
                   4181:             if (@unsolved) {
                   4182:                 $prevattempts .= '<span class="LC_nobreak"><label>'.
                   4183:                                  '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
                   4184:                                  &mt('Hide').'</label></span>';
                   4185:             }
                   4186:             $prevattempts .= '</td>';
1.945     raeburn  4187:             if (@hidden) {
                   4188:                 foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4189:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  4190:                     my $hide;
                   4191:                     foreach my $id (@hidden) {
                   4192:                         if ($key =~ /^\Q$id\E/) {
                   4193:                             $hide = 1;
                   4194:                             last;
                   4195:                         }
                   4196:                     }
                   4197:                     if ($hide) {
                   4198:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   4199:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   4200:                             my $value = &format_previous_attempt_value($key,
                   4201:                                              $returnhash{$version.':'.$key});
                   4202:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4203:                         } else {
                   4204:                             $prevattempts.='<td>&nbsp;</td>';
                   4205:                         }
                   4206:                     } else {
                   4207:                         if ($key =~ /\./) {
1.1075.2.91  raeburn  4208:                             my $value = $returnhash{$version.':'.$key};
                   4209:                             if ($key =~ /\.rndseed$/) {
                   4210:                                 my ($id) = ($key =~ /^(.+)\.rndseed$/);
                   4211:                                 if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   4212:                                     $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   4213:                                 }
                   4214:                             }
                   4215:                             $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   4216:                                            '&nbsp;</td>';
1.945     raeburn  4217:                         } else {
                   4218:                             $prevattempts.='<td>&nbsp;</td>';
                   4219:                         }
                   4220:                     }
                   4221:                 }
                   4222:             } else {
                   4223: 	        foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4224:                     next if ($key =~ /\.foilorder$/);
1.1075.2.91  raeburn  4225:                     my $value = $returnhash{$version.':'.$key};
                   4226:                     if ($key =~ /\.rndseed$/) {
                   4227:                         my ($id) = ($key =~ /^(.+)\.rndseed$/);
                   4228:                         if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   4229:                             $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   4230:                         }
                   4231:                     }
                   4232:                     $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   4233:                                    '&nbsp;</td>';
1.945     raeburn  4234: 	        }
                   4235:             }
                   4236: 	    $prevattempts.=&end_data_table_row();
1.40      ng       4237: 	 }
1.1       albertel 4238:       }
1.945     raeburn  4239:       my @currhidden = keys(%lasthidden);
1.596     albertel 4240:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 4241:       foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4242:           next if ($key =~ /\.foilorder$/);
1.945     raeburn  4243:           if (%typeparts) {
                   4244:               my $hidden;
                   4245:               foreach my $id (@currhidden) {
                   4246:                   if ($key =~ /^\Q$id\E/) {
                   4247:                       $hidden = 1;
                   4248:                       last;
                   4249:                   }
                   4250:               }
                   4251:               if ($hidden) {
                   4252:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   4253:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   4254:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4255:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4256:                           $value = &$gradesub($value);
                   4257:                       }
                   4258:                       $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4259:                   } else {
                   4260:                       $prevattempts.='<td>&nbsp;</td>';
                   4261:                   }
                   4262:               } else {
                   4263:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4264:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4265:                       $value = &$gradesub($value);
                   4266:                   }
                   4267:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4268:               }
                   4269:           } else {
                   4270: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4271: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4272:                   $value = &$gradesub($value);
                   4273:               }
                   4274: 	      $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4275:           }
1.16      harris41 4276:       }
1.596     albertel 4277:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 4278:     } else {
1.596     albertel 4279:       $prevattempts=
                   4280: 	  &start_data_table().&start_data_table_row().
                   4281: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   4282: 	  &end_data_table_row().&end_data_table();
1.1       albertel 4283:     }
                   4284:   } else {
1.596     albertel 4285:     $prevattempts=
                   4286: 	  &start_data_table().&start_data_table_row().
                   4287: 	  '<td>'.&mt('No data.').'</td>'.
                   4288: 	  &end_data_table_row().&end_data_table();
1.1       albertel 4289:   }
1.10      albertel 4290: }
                   4291: 
1.581     albertel 4292: sub format_previous_attempt_value {
                   4293:     my ($key,$value) = @_;
1.1011    www      4294:     if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581     albertel 4295: 	$value = &Apache::lonlocal::locallocaltime($value);
                   4296:     } elsif (ref($value) eq 'ARRAY') {
                   4297: 	$value = '('.join(', ', @{ $value }).')';
1.988     raeburn  4298:     } elsif ($key =~ /answerstring$/) {
                   4299:         my %answers = &Apache::lonnet::str2hash($value);
                   4300:         my @anskeys = sort(keys(%answers));
                   4301:         if (@anskeys == 1) {
                   4302:             my $answer = $answers{$anskeys[0]};
1.1001    raeburn  4303:             if ($answer =~ m{\0}) {
                   4304:                 $answer =~ s{\0}{,}g;
1.988     raeburn  4305:             }
                   4306:             my $tag_internal_answer_name = 'INTERNAL';
                   4307:             if ($anskeys[0] eq $tag_internal_answer_name) {
                   4308:                 $value = $answer; 
                   4309:             } else {
                   4310:                 $value = $anskeys[0].'='.$answer;
                   4311:             }
                   4312:         } else {
                   4313:             foreach my $ans (@anskeys) {
                   4314:                 my $answer = $answers{$ans};
1.1001    raeburn  4315:                 if ($answer =~ m{\0}) {
                   4316:                     $answer =~ s{\0}{,}g;
1.988     raeburn  4317:                 }
                   4318:                 $value .=  $ans.'='.$answer.'<br />';;
                   4319:             } 
                   4320:         }
1.581     albertel 4321:     } else {
                   4322: 	$value = &unescape($value);
                   4323:     }
                   4324:     return $value;
                   4325: }
                   4326: 
                   4327: 
1.107     albertel 4328: sub relative_to_absolute {
                   4329:     my ($url,$output)=@_;
                   4330:     my $parser=HTML::TokeParser->new(\$output);
                   4331:     my $token;
                   4332:     my $thisdir=$url;
                   4333:     my @rlinks=();
                   4334:     while ($token=$parser->get_token) {
                   4335: 	if ($token->[0] eq 'S') {
                   4336: 	    if ($token->[1] eq 'a') {
                   4337: 		if ($token->[2]->{'href'}) {
                   4338: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   4339: 		}
                   4340: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   4341: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   4342: 	    } elsif ($token->[1] eq 'base') {
                   4343: 		$thisdir=$token->[2]->{'href'};
                   4344: 	    }
                   4345: 	}
                   4346:     }
                   4347:     $thisdir=~s-/[^/]*$--;
1.356     albertel 4348:     foreach my $link (@rlinks) {
1.726     raeburn  4349: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 4350: 		($link=~/^\//) ||
                   4351: 		($link=~/^javascript:/i) ||
                   4352: 		($link=~/^mailto:/i) ||
                   4353: 		($link=~/^\#/)) {
                   4354: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   4355: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 4356: 	}
                   4357:     }
                   4358: # -------------------------------------------------- Deal with Applet codebases
                   4359:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   4360:     return $output;
                   4361: }
                   4362: 
1.112     bowersj2 4363: =pod
                   4364: 
1.648     raeburn  4365: =item * &get_student_view()
1.112     bowersj2 4366: 
                   4367: show a snapshot of what student was looking at
                   4368: 
                   4369: =cut
                   4370: 
1.10      albertel 4371: sub get_student_view {
1.186     albertel 4372:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      4373:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4374:   my (%form);
1.10      albertel 4375:   my @elements=('symb','courseid','domain','username');
                   4376:   foreach my $element (@elements) {
1.186     albertel 4377:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4378:   }
1.186     albertel 4379:   if (defined($moreenv)) {
                   4380:       %form=(%form,%{$moreenv});
                   4381:   }
1.236     albertel 4382:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 4383:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      4384:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 4385:   $userview=~s/\<body[^\>]*\>//gi;
                   4386:   $userview=~s/\<\/body\>//gi;
                   4387:   $userview=~s/\<html\>//gi;
                   4388:   $userview=~s/\<\/html\>//gi;
                   4389:   $userview=~s/\<head\>//gi;
                   4390:   $userview=~s/\<\/head\>//gi;
                   4391:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 4392:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      4393:   if (wantarray) {
                   4394:      return ($userview,$response);
                   4395:   } else {
                   4396:      return $userview;
                   4397:   }
                   4398: }
                   4399: 
                   4400: sub get_student_view_with_retries {
                   4401:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   4402: 
                   4403:     my $ok = 0;                 # True if we got a good response.
                   4404:     my $content;
                   4405:     my $response;
                   4406: 
                   4407:     # Try to get the student_view done. within the retries count:
                   4408:     
                   4409:     do {
                   4410:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   4411:          $ok      = $response->is_success;
                   4412:          if (!$ok) {
                   4413:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   4414:          }
                   4415:          $retries--;
                   4416:     } while (!$ok && ($retries > 0));
                   4417:     
                   4418:     if (!$ok) {
                   4419:        $content = '';          # On error return an empty content.
                   4420:     }
1.651     www      4421:     if (wantarray) {
                   4422:        return ($content, $response);
                   4423:     } else {
                   4424:        return $content;
                   4425:     }
1.11      albertel 4426: }
                   4427: 
1.112     bowersj2 4428: =pod
                   4429: 
1.648     raeburn  4430: =item * &get_student_answers() 
1.112     bowersj2 4431: 
                   4432: show a snapshot of how student was answering problem
                   4433: 
                   4434: =cut
                   4435: 
1.11      albertel 4436: sub get_student_answers {
1.100     sakharuk 4437:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      4438:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4439:   my (%moreenv);
1.11      albertel 4440:   my @elements=('symb','courseid','domain','username');
                   4441:   foreach my $element (@elements) {
1.186     albertel 4442:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4443:   }
1.186     albertel 4444:   $moreenv{'grade_target'}='answer';
                   4445:   %moreenv=(%form,%moreenv);
1.497     raeburn  4446:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   4447:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 4448:   return $userview;
1.1       albertel 4449: }
1.116     albertel 4450: 
                   4451: =pod
                   4452: 
                   4453: =item * &submlink()
                   4454: 
1.242     albertel 4455: Inputs: $text $uname $udom $symb $target
1.116     albertel 4456: 
                   4457: Returns: A link to grades.pm such as to see the SUBM view of a student
                   4458: 
                   4459: =cut
                   4460: 
                   4461: ###############################################
                   4462: sub submlink {
1.242     albertel 4463:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 4464:     if (!($uname && $udom)) {
                   4465: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4466: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 4467: 	if (!$symb) { $symb=$cursymb; }
                   4468:     }
1.254     matthew  4469:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4470:     $symb=&escape($symb);
1.960     bisitz   4471:     if ($target) { $target=" target=\"$target\""; }
                   4472:     return
                   4473:         '<a href="/adm/grades?command=submission'.
                   4474:         '&amp;symb='.$symb.
                   4475:         '&amp;student='.$uname.
                   4476:         '&amp;userdom='.$udom.'"'.
                   4477:         $target.'>'.$text.'</a>';
1.242     albertel 4478: }
                   4479: ##############################################
                   4480: 
                   4481: =pod
                   4482: 
                   4483: =item * &pgrdlink()
                   4484: 
                   4485: Inputs: $text $uname $udom $symb $target
                   4486: 
                   4487: Returns: A link to grades.pm such as to see the PGRD view of a student
                   4488: 
                   4489: =cut
                   4490: 
                   4491: ###############################################
                   4492: sub pgrdlink {
                   4493:     my $link=&submlink(@_);
                   4494:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   4495:     return $link;
                   4496: }
                   4497: ##############################################
                   4498: 
                   4499: =pod
                   4500: 
                   4501: =item * &pprmlink()
                   4502: 
                   4503: Inputs: $text $uname $udom $symb $target
                   4504: 
                   4505: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 4506: student and a specific resource
1.242     albertel 4507: 
                   4508: =cut
                   4509: 
                   4510: ###############################################
                   4511: sub pprmlink {
                   4512:     my ($text,$uname,$udom,$symb,$target)=@_;
                   4513:     if (!($uname && $udom)) {
                   4514: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4515: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 4516: 	if (!$symb) { $symb=$cursymb; }
                   4517:     }
1.254     matthew  4518:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4519:     $symb=&escape($symb);
1.242     albertel 4520:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 4521:     return '<a href="/adm/parmset?command=set&amp;'.
                   4522: 	'symb='.$symb.'&amp;uname='.$uname.
                   4523: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 4524: }
                   4525: ##############################################
1.37      matthew  4526: 
1.112     bowersj2 4527: =pod
                   4528: 
                   4529: =back
                   4530: 
                   4531: =cut
                   4532: 
1.37      matthew  4533: ###############################################
1.51      www      4534: 
                   4535: 
                   4536: sub timehash {
1.687     raeburn  4537:     my ($thistime) = @_;
                   4538:     my $timezone = &Apache::lonlocal::gettimezone();
                   4539:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   4540:                      ->set_time_zone($timezone);
                   4541:     my $wday = $dt->day_of_week();
                   4542:     if ($wday == 7) { $wday = 0; }
                   4543:     return ( 'second' => $dt->second(),
                   4544:              'minute' => $dt->minute(),
                   4545:              'hour'   => $dt->hour(),
                   4546:              'day'     => $dt->day_of_month(),
                   4547:              'month'   => $dt->month(),
                   4548:              'year'    => $dt->year(),
                   4549:              'weekday' => $wday,
                   4550:              'dayyear' => $dt->day_of_year(),
                   4551:              'dlsav'   => $dt->is_dst() );
1.51      www      4552: }
                   4553: 
1.370     www      4554: sub utc_string {
                   4555:     my ($date)=@_;
1.371     www      4556:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      4557: }
                   4558: 
1.51      www      4559: sub maketime {
                   4560:     my %th=@_;
1.687     raeburn  4561:     my ($epoch_time,$timezone,$dt);
                   4562:     $timezone = &Apache::lonlocal::gettimezone();
                   4563:     eval {
                   4564:         $dt = DateTime->new( year   => $th{'year'},
                   4565:                              month  => $th{'month'},
                   4566:                              day    => $th{'day'},
                   4567:                              hour   => $th{'hour'},
                   4568:                              minute => $th{'minute'},
                   4569:                              second => $th{'second'},
                   4570:                              time_zone => $timezone,
                   4571:                          );
                   4572:     };
                   4573:     if (!$@) {
                   4574:         $epoch_time = $dt->epoch;
                   4575:         if ($epoch_time) {
                   4576:             return $epoch_time;
                   4577:         }
                   4578:     }
1.51      www      4579:     return POSIX::mktime(
                   4580:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      4581:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      4582: }
                   4583: 
                   4584: #########################################
1.51      www      4585: 
                   4586: sub findallcourses {
1.482     raeburn  4587:     my ($roles,$uname,$udom) = @_;
1.355     albertel 4588:     my %roles;
                   4589:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 4590:     my %courses;
1.51      www      4591:     my $now=time;
1.482     raeburn  4592:     if (!defined($uname)) {
                   4593:         $uname = $env{'user.name'};
                   4594:     }
                   4595:     if (!defined($udom)) {
                   4596:         $udom = $env{'user.domain'};
                   4597:     }
                   4598:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073    raeburn  4599:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482     raeburn  4600:         if (!%roles) {
                   4601:             %roles = (
                   4602:                        cc => 1,
1.907     raeburn  4603:                        co => 1,
1.482     raeburn  4604:                        in => 1,
                   4605:                        ep => 1,
                   4606:                        ta => 1,
                   4607:                        cr => 1,
                   4608:                        st => 1,
                   4609:              );
                   4610:         }
                   4611:         foreach my $entry (keys(%roleshash)) {
                   4612:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   4613:             if ($trole =~ /^cr/) { 
                   4614:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   4615:             } else {
                   4616:                 next if (!exists($roles{$trole}));
                   4617:             }
                   4618:             if ($tend) {
                   4619:                 next if ($tend < $now);
                   4620:             }
                   4621:             if ($tstart) {
                   4622:                 next if ($tstart > $now);
                   4623:             }
1.1058    raeburn  4624:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482     raeburn  4625:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058    raeburn  4626:             my $value = $trole.'/'.$cdom.'/';
1.482     raeburn  4627:             if ($secpart eq '') {
                   4628:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   4629:                 $sec = 'none';
1.1058    raeburn  4630:                 $value .= $cnum.'/';
1.482     raeburn  4631:             } else {
                   4632:                 $cnum = $cnumpart;
                   4633:                 ($sec,$role) = split(/_/,$secpart);
1.1058    raeburn  4634:                 $value .= $cnum.'/'.$sec;
                   4635:             }
                   4636:             if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4637:                 unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4638:                     push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4639:                 }
                   4640:             } else {
                   4641:                 @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490     raeburn  4642:             }
1.482     raeburn  4643:         }
                   4644:     } else {
                   4645:         foreach my $key (keys(%env)) {
1.483     albertel 4646: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   4647:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  4648: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   4649: 	        next if ($role eq 'ca' || $role eq 'aa');
                   4650: 	        next if (%roles && !exists($roles{$role}));
                   4651: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   4652:                 my $active=1;
                   4653:                 if ($starttime) {
                   4654: 		    if ($now<$starttime) { $active=0; }
                   4655:                 }
                   4656:                 if ($endtime) {
                   4657:                     if ($now>$endtime) { $active=0; }
                   4658:                 }
                   4659:                 if ($active) {
1.1058    raeburn  4660:                     my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482     raeburn  4661:                     if ($sec eq '') {
                   4662:                         $sec = 'none';
1.1058    raeburn  4663:                     } else {
                   4664:                         $value .= $sec;
                   4665:                     }
                   4666:                     if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4667:                         unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4668:                             push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4669:                         }
                   4670:                     } else {
                   4671:                         @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482     raeburn  4672:                     }
1.474     raeburn  4673:                 }
                   4674:             }
1.51      www      4675:         }
                   4676:     }
1.474     raeburn  4677:     return %courses;
1.51      www      4678: }
1.37      matthew  4679: 
1.54      www      4680: ###############################################
1.474     raeburn  4681: 
                   4682: sub blockcheck {
1.1075.2.141.  .7(raebu 4683:20):     my ($setters,$activity,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.490     raeburn  4684: 
1.1075.2.73  raeburn  4685:     if (defined($udom) && defined($uname)) {
                   4686:         # If uname and udom are for a course, check for blocks in the course.
                   4687:         if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
                   4688:             my ($startblock,$endblock,$triggerblock) =
1.1075.2.141.  .7(raebu 4689:20):                 &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1075.2.73  raeburn  4690:             return ($startblock,$endblock,$triggerblock);
                   4691:         }
                   4692:     } else {
1.490     raeburn  4693:         $udom = $env{'user.domain'};
                   4694:         $uname = $env{'user.name'};
                   4695:     }
                   4696: 
1.502     raeburn  4697:     my $startblock = 0;
                   4698:     my $endblock = 0;
1.1062    raeburn  4699:     my $triggerblock = '';
1.482     raeburn  4700:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  4701: 
1.490     raeburn  4702:     # If uname is for a user, and activity is course-specific, i.e.,
                   4703:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  4704: 
1.490     raeburn  4705:     if (($activity eq 'boards' || $activity eq 'chat' ||
1.1075.2.141.  .6(raebu 4706:20):          $activity eq 'groups' || $activity eq 'printout' ||
                   4707:20):          $activity eq 'reinit' || $activity eq 'alert') &&
1.1075.2.73  raeburn  4708:         ($env{'request.course.id'})) {
1.490     raeburn  4709:         foreach my $key (keys(%live_courses)) {
                   4710:             if ($key ne $env{'request.course.id'}) {
                   4711:                 delete($live_courses{$key});
                   4712:             }
                   4713:         }
                   4714:     }
                   4715: 
                   4716:     my $otheruser = 0;
                   4717:     my %own_courses;
                   4718:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   4719:         # Resource belongs to user other than current user.
                   4720:         $otheruser = 1;
                   4721:         # Gather courses for current user
                   4722:         %own_courses = 
                   4723:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   4724:     }
                   4725: 
                   4726:     # Gather active course roles - course coordinator, instructor, 
                   4727:     # exam proctor, ta, student, or custom role.
1.474     raeburn  4728: 
                   4729:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  4730:         my ($cdom,$cnum);
                   4731:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   4732:             $cdom = $env{'course.'.$course.'.domain'};
                   4733:             $cnum = $env{'course.'.$course.'.num'};
                   4734:         } else {
1.490     raeburn  4735:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  4736:         }
                   4737:         my $no_ownblock = 0;
                   4738:         my $no_userblock = 0;
1.533     raeburn  4739:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  4740:             # Check if current user has 'evb' priv for this
                   4741:             if (defined($own_courses{$course})) {
                   4742:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   4743:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   4744:                     if ($sec ne 'none') {
                   4745:                         $checkrole .= '/'.$sec;
                   4746:                     }
                   4747:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4748:                         $no_ownblock = 1;
                   4749:                         last;
                   4750:                     }
                   4751:                 }
                   4752:             }
                   4753:             # if they have 'evb' priv and are currently not playing student
                   4754:             next if (($no_ownblock) &&
                   4755:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   4756:         }
1.474     raeburn  4757:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  4758:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  4759:             if ($sec ne 'none') {
1.482     raeburn  4760:                 $checkrole .= '/'.$sec;
1.474     raeburn  4761:             }
1.490     raeburn  4762:             if ($otheruser) {
                   4763:                 # Resource belongs to user other than current user.
                   4764:                 # Assemble privs for that user, and check for 'evb' priv.
1.1058    raeburn  4765:                 my (%allroles,%userroles);
                   4766:                 if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
                   4767:                     foreach my $entry (@{$live_courses{$course}{$sec}}) { 
                   4768:                         my ($trole,$tdom,$tnum,$tsec);
                   4769:                         if ($entry =~ /^cr/) {
                   4770:                             ($trole,$tdom,$tnum,$tsec) = 
                   4771:                                 ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   4772:                         } else {
                   4773:                            ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   4774:                         }
                   4775:                         my ($spec,$area,$trest);
                   4776:                         $area = '/'.$tdom.'/'.$tnum;
                   4777:                         $trest = $tnum;
                   4778:                         if ($tsec ne '') {
                   4779:                             $area .= '/'.$tsec;
                   4780:                             $trest .= '/'.$tsec;
                   4781:                         }
                   4782:                         $spec = $trole.'.'.$area;
                   4783:                         if ($trole =~ /^cr/) {
                   4784:                             &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   4785:                                                               $tdom,$spec,$trest,$area);
                   4786:                         } else {
                   4787:                             &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   4788:                                                                 $tdom,$spec,$trest,$area);
                   4789:                         }
                   4790:                     }
1.1075.2.124  raeburn  4791:                     my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058    raeburn  4792:                     if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   4793:                         if ($1) {
                   4794:                             $no_userblock = 1;
                   4795:                             last;
                   4796:                         }
1.486     raeburn  4797:                     }
                   4798:                 }
1.490     raeburn  4799:             } else {
                   4800:                 # Resource belongs to current user
                   4801:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  4802:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4803:                     $no_ownblock = 1;
                   4804:                     last;
                   4805:                 }
1.474     raeburn  4806:             }
                   4807:         }
                   4808:         # if they have the evb priv and are currently not playing student
1.482     raeburn  4809:         next if (($no_ownblock) &&
1.491     albertel 4810:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  4811:         next if ($no_userblock);
1.474     raeburn  4812: 
1.1075.2.128  raeburn  4813:         # Retrieve blocking times and identity of blocker for course
1.490     raeburn  4814:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  4815:         
1.1062    raeburn  4816:         my ($start,$end,$trigger) = 
1.1075.2.141.  .7(raebu 4817:20):             &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502     raeburn  4818:         if (($start != 0) && 
                   4819:             (($startblock == 0) || ($startblock > $start))) {
                   4820:             $startblock = $start;
1.1062    raeburn  4821:             if ($trigger ne '') {
                   4822:                 $triggerblock = $trigger;
                   4823:             }
1.502     raeburn  4824:         }
                   4825:         if (($end != 0)  &&
                   4826:             (($endblock == 0) || ($endblock < $end))) {
                   4827:             $endblock = $end;
1.1062    raeburn  4828:             if ($trigger ne '') {
                   4829:                 $triggerblock = $trigger;
                   4830:             }
1.502     raeburn  4831:         }
1.490     raeburn  4832:     }
1.1062    raeburn  4833:     return ($startblock,$endblock,$triggerblock);
1.490     raeburn  4834: }
                   4835: 
                   4836: sub get_blocks {
1.1075.2.141.  .7(raebu 4837:20):     my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490     raeburn  4838:     my $startblock = 0;
                   4839:     my $endblock = 0;
1.1062    raeburn  4840:     my $triggerblock = '';
1.490     raeburn  4841:     my $course = $cdom.'_'.$cnum;
                   4842:     $setters->{$course} = {};
                   4843:     $setters->{$course}{'staff'} = [];
                   4844:     $setters->{$course}{'times'} = [];
1.1062    raeburn  4845:     $setters->{$course}{'triggers'} = [];
                   4846:     my (@blockers,%triggered);
                   4847:     my $now = time;
                   4848:     my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
                   4849:     if ($activity eq 'docs') {
1.1075.2.141.  .7(raebu 4850:20):         my ($blocked,$nosymbcache);
                   4851:20):         if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
                   4852:20):             $blocked = 1;
                   4853:20):             $nosymbcache = 1;
                   4854:20):         }
                   4855:20):         @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$blocked,\%commblocks);
1.1062    raeburn  4856:         foreach my $block (@blockers) {
                   4857:             if ($block =~ /^firstaccess____(.+)$/) {
                   4858:                 my $item = $1;
                   4859:                 my $type = 'map';
                   4860:                 my $timersymb = $item;
                   4861:                 if ($item eq 'course') {
                   4862:                     $type = 'course';
                   4863:                 } elsif ($item =~ /___\d+___/) {
                   4864:                     $type = 'resource';
                   4865:                 } else {
                   4866:                     $timersymb = &Apache::lonnet::symbread($item);
                   4867:                 }
                   4868:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4869:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
                   4870:                 $triggered{$block} = {
                   4871:                                        start => $start,
                   4872:                                        end   => $end,
                   4873:                                        type  => $type,
                   4874:                                      };
                   4875:             }
                   4876:         }
                   4877:     } else {
                   4878:         foreach my $block (keys(%commblocks)) {
                   4879:             if ($block =~ m/^(\d+)____(\d+)$/) { 
                   4880:                 my ($start,$end) = ($1,$2);
                   4881:                 if ($start <= time && $end >= time) {
                   4882:                     if (ref($commblocks{$block}) eq 'HASH') {
                   4883:                         if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   4884:                             if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   4885:                                 unless(grep(/^\Q$block\E$/,@blockers)) {
                   4886:                                     push(@blockers,$block);
                   4887:                                 }
                   4888:                             }
                   4889:                         }
                   4890:                     }
                   4891:                 }
                   4892:             } elsif ($block =~ /^firstaccess____(.+)$/) {
                   4893:                 my $item = $1;
                   4894:                 my $timersymb = $item; 
                   4895:                 my $type = 'map';
                   4896:                 if ($item eq 'course') {
                   4897:                     $type = 'course';
                   4898:                 } elsif ($item =~ /___\d+___/) {
                   4899:                     $type = 'resource';
                   4900:                 } else {
                   4901:                     $timersymb = &Apache::lonnet::symbread($item);
                   4902:                 }
                   4903:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4904:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb}; 
                   4905:                 if ($start && $end) {
                   4906:                     if (($start <= time) && ($end >= time)) {
                   4907:                         unless (grep(/^\Q$block\E$/,@blockers)) {
                   4908:                             push(@blockers,$block);
                   4909:                             $triggered{$block} = {
                   4910:                                                    start => $start,
                   4911:                                                    end   => $end,
                   4912:                                                    type  => $type,
                   4913:                                                  };
                   4914:                         }
                   4915:                     }
1.490     raeburn  4916:                 }
1.1062    raeburn  4917:             }
                   4918:         }
                   4919:     }
                   4920:     foreach my $blocker (@blockers) {
                   4921:         my ($staff_name,$staff_dom,$title,$blocks) =
                   4922:             &parse_block_record($commblocks{$blocker});
                   4923:         push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   4924:         my ($start,$end,$triggertype);
                   4925:         if ($blocker =~ m/^(\d+)____(\d+)$/) {
                   4926:             ($start,$end) = ($1,$2);
                   4927:         } elsif (ref($triggered{$blocker}) eq 'HASH') {
                   4928:             $start = $triggered{$blocker}{'start'};
                   4929:             $end = $triggered{$blocker}{'end'};
                   4930:             $triggertype = $triggered{$blocker}{'type'};
                   4931:         }
                   4932:         if ($start) {
                   4933:             push(@{$$setters{$course}{'times'}}, [$start,$end]);
                   4934:             if ($triggertype) {
                   4935:                 push(@{$$setters{$course}{'triggers'}},$triggertype);
                   4936:             } else {
                   4937:                 push(@{$$setters{$course}{'triggers'}},0);
                   4938:             }
                   4939:             if ( ($startblock == 0) || ($startblock > $start) ) {
                   4940:                 $startblock = $start;
                   4941:                 if ($triggertype) {
                   4942:                     $triggerblock = $blocker;
1.474     raeburn  4943:                 }
                   4944:             }
1.1062    raeburn  4945:             if ( ($endblock == 0) || ($endblock < $end) ) {
                   4946:                $endblock = $end;
                   4947:                if ($triggertype) {
                   4948:                    $triggerblock = $blocker;
                   4949:                }
                   4950:             }
1.474     raeburn  4951:         }
                   4952:     }
1.1062    raeburn  4953:     return ($startblock,$endblock,$triggerblock);
1.474     raeburn  4954: }
                   4955: 
                   4956: sub parse_block_record {
                   4957:     my ($record) = @_;
                   4958:     my ($setuname,$setudom,$title,$blocks);
                   4959:     if (ref($record) eq 'HASH') {
                   4960:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   4961:         $title = &unescape($record->{'event'});
                   4962:         $blocks = $record->{'blocks'};
                   4963:     } else {
                   4964:         my @data = split(/:/,$record,3);
                   4965:         if (scalar(@data) eq 2) {
                   4966:             $title = $data[1];
                   4967:             ($setuname,$setudom) = split(/@/,$data[0]);
                   4968:         } else {
                   4969:             ($setuname,$setudom,$title) = @data;
                   4970:         }
                   4971:         $blocks = { 'com' => 'on' };
                   4972:     }
                   4973:     return ($setuname,$setudom,$title,$blocks);
                   4974: }
                   4975: 
1.854     kalberla 4976: sub blocking_status {
1.1075.2.141.  .7(raebu 4977:20):     my ($activity,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061    raeburn  4978:     my %setters;
1.890     droeschl 4979: 
1.1061    raeburn  4980: # check for active blocking
1.1062    raeburn  4981:     my ($startblock,$endblock,$triggerblock) = 
1.1075.2.141.  .7(raebu 4982:20):         &blockcheck(\%setters,$activity,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062    raeburn  4983:     my $blocked = 0;
                   4984:     if ($startblock && $endblock) {
                   4985:         $blocked = 1;
                   4986:     }
1.890     droeschl 4987: 
1.1061    raeburn  4988: # caller just wants to know whether a block is active
                   4989:     if (!wantarray) { return $blocked; }
                   4990: 
                   4991: # build a link to a popup window containing the details
                   4992:     my $querystring  = "?activity=$activity";
                   4993: # $uname and $udom decide whose portfolio the user is trying to look at
1.1075.2.97  raeburn  4994:     if (($activity eq 'port') || ($activity eq 'passwd')) {
                   4995:         $querystring .= "&amp;udom=$udom"      if ($udom =~ /^$match_domain$/);
                   4996:         $querystring .= "&amp;uname=$uname"    if ($uname =~ /^$match_username$/);
1.1062    raeburn  4997:     } elsif ($activity eq 'docs') {
1.1075.2.141.  .7(raebu 4998:20):         my $showurl = &Apache::lonenc::check_encrypt($url);
                   4999:20):         $querystring .= '&amp;url='.&HTML::Entities::encode($showurl,'\'&"<>');
                   5000:20):         if ($symb) {
                   5001:20):             my $showsymb = &Apache::lonenc::check_encrypt($symb);
                   5002:20):             $querystring .= '&amp;symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
                   5003:20):         }
1.1062    raeburn  5004:     }
1.1061    raeburn  5005: 
                   5006:     my $output .= <<'END_MYBLOCK';
                   5007: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   5008:     var options = "width=" + w + ",height=" + h + ",";
                   5009:     options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   5010:     options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   5011:     var newWin = window.open(url, wdwName, options);
                   5012:     newWin.focus();
                   5013: }
1.890     droeschl 5014: END_MYBLOCK
1.854     kalberla 5015: 
1.1061    raeburn  5016:     $output = Apache::lonhtmlcommon::scripttag($output);
1.890     droeschl 5017:   
1.1061    raeburn  5018:     my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062    raeburn  5019:     my $text = &mt('Communication Blocked');
1.1075.2.93  raeburn  5020:     my $class = 'LC_comblock';
1.1062    raeburn  5021:     if ($activity eq 'docs') {
                   5022:         $text = &mt('Content Access Blocked');
1.1075.2.93  raeburn  5023:         $class = '';
1.1063    raeburn  5024:     } elsif ($activity eq 'printout') {
                   5025:         $text = &mt('Printing Blocked');
1.1075.2.97  raeburn  5026:     } elsif ($activity eq 'passwd') {
                   5027:         $text = &mt('Password Changing Blocked');
1.1075.2.141.  .6(raebu 5028:20):     } elsif ($activity eq 'grades') {
                   5029:20):         $text = &mt('Gradebook Blocked');
                   5030:20):     } elsif ($activity eq 'alert') {
                   5031:20):         $text = &mt('Checking Critical Messages Blocked');
                   5032:20):     } elsif ($activity eq 'reinit') {
                   5033:20):         $text = &mt('Checking Course Update Blocked');
1.1062    raeburn  5034:     }
1.1061    raeburn  5035:     $output .= <<"END_BLOCK";
1.1075.2.93  raeburn  5036: <div class='$class'>
1.869     kalberla 5037:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 5038:   title='$text'>
                   5039:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 5040:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 5041:   title='$text'>$text</a>
1.867     kalberla 5042: </div>
                   5043: 
                   5044: END_BLOCK
1.474     raeburn  5045: 
1.1061    raeburn  5046:     return ($blocked, $output);
1.854     kalberla 5047: }
1.490     raeburn  5048: 
1.60      matthew  5049: ###############################################
                   5050: 
1.682     raeburn  5051: sub check_ip_acc {
1.1075.2.105  raeburn  5052:     my ($acc,$clientip)=@_;
1.682     raeburn  5053:     &Apache::lonxml::debug("acc is $acc");
                   5054:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   5055:         return 1;
                   5056:     }
1.1075.2.141.  .4(raebu 5057:20):     my ($ip,$allowed);
                   5058:20):     if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
                   5059:20):         ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
                   5060:20):         $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
                   5061:20):     } else {
                   5062:20):         $ip = $ENV{'REMOTE_ADDR'} || $env{'request.host'} || $clientip;
                   5063:20):     }
1.682     raeburn  5064: 
                   5065:     my $name;
1.1075.2.141.  .1(raebu 5066:20):     my %access = (
                   5067:20):                      allowfrom => 1,
                   5068:20):                      denyfrom  => 0,
                   5069:20):                  );
                   5070:20):     my @allows;
                   5071:20):     my @denies;
                   5072:20):     foreach my $item (split(',',$acc)) {
                   5073:20):         $item =~ s/^\s*//;
                   5074:20):         $item =~ s/\s*$//;
                   5075:20):         if ($item =~ /^\!(.+)$/) {
                   5076:20):             push(@denies,$1);
                   5077:20):         } else {
                   5078:20):             push(@allows,$item);
                   5079:20):         }
                   5080:20):     }
                   5081:20):     my $numdenies = scalar(@denies);
                   5082:20):     my $numallows = scalar(@allows);
                   5083:20):     my $count = 0;
                   5084:20):     foreach my $pattern (@denies,@allows) {
                   5085:20):         $count ++;
                   5086:20):         my $acctype = 'allowfrom';
                   5087:20):         if ($count <= $numdenies) {
                   5088:20):             $acctype = 'denyfrom';
                   5089:20):         }
1.682     raeburn  5090:         if ($pattern =~ /\*$/) {
                   5091:             #35.8.*
                   5092:             $pattern=~s/\*//;
1.1075.2.141.  .1(raebu 5093:20):             if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682     raeburn  5094:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   5095:             #35.8.3.[34-56]
                   5096:             my $low=$2;
                   5097:             my $high=$3;
                   5098:             $pattern=$1;
                   5099:             if ($ip =~ /^\Q$pattern\E/) {
                   5100:                 my $last=(split(/\./,$ip))[3];
1.1075.2.141.  .1(raebu 5101:20):                 if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682     raeburn  5102:             }
                   5103:         } elsif ($pattern =~ /^\*/) {
                   5104:             #*.msu.edu
                   5105:             $pattern=~s/\*//;
                   5106:             if (!defined($name)) {
                   5107:                 use Socket;
                   5108:                 my $netaddr=inet_aton($ip);
                   5109:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   5110:             }
1.1075.2.141.  .1(raebu 5111:20):             if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682     raeburn  5112:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   5113:             #127.0.0.1
1.1075.2.141.  .1(raebu 5114:20):             if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682     raeburn  5115:         } else {
                   5116:             #some.name.com
                   5117:             if (!defined($name)) {
                   5118:                 use Socket;
                   5119:                 my $netaddr=inet_aton($ip);
                   5120:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   5121:             }
1.1075.2.141.  .1(raebu 5122:20):             if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
                   5123:20):         }
                   5124:20):         if ($allowed =~ /^(0|1)$/) { last; }
                   5125:20):     }
                   5126:20):     if ($allowed eq '') {
                   5127:20):         if ($numdenies && !$numallows) {
                   5128:20):             $allowed = 1;
                   5129:20):         } else {
                   5130:20):             $allowed = 0;
1.682     raeburn  5131:         }
                   5132:     }
                   5133:     return $allowed;
                   5134: }
                   5135: 
                   5136: ###############################################
                   5137: 
1.60      matthew  5138: =pod
                   5139: 
1.112     bowersj2 5140: =head1 Domain Template Functions
                   5141: 
                   5142: =over 4
                   5143: 
                   5144: =item * &determinedomain()
1.60      matthew  5145: 
                   5146: Inputs: $domain (usually will be undef)
                   5147: 
1.63      www      5148: Returns: Determines which domain should be used for designs
1.60      matthew  5149: 
                   5150: =cut
1.54      www      5151: 
1.60      matthew  5152: ###############################################
1.63      www      5153: sub determinedomain {
                   5154:     my $domain=shift;
1.531     albertel 5155:     if (! $domain) {
1.60      matthew  5156:         # Determine domain if we have not been given one
1.893     raeburn  5157:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 5158:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   5159:         if ($env{'request.role.domain'}) { 
                   5160:             $domain=$env{'request.role.domain'}; 
1.60      matthew  5161:         }
                   5162:     }
1.63      www      5163:     return $domain;
                   5164: }
                   5165: ###############################################
1.517     raeburn  5166: 
1.518     albertel 5167: sub devalidate_domconfig_cache {
                   5168:     my ($udom)=@_;
                   5169:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   5170: }
                   5171: 
                   5172: # ---------------------- Get domain configuration for a domain
                   5173: sub get_domainconf {
                   5174:     my ($udom) = @_;
                   5175:     my $cachetime=1800;
                   5176:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   5177:     if (defined($cached)) { return %{$result}; }
                   5178: 
                   5179:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  5180: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  5181:     my (%designhash,%legacy);
1.518     albertel 5182:     if (keys(%domconfig) > 0) {
                   5183:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  5184:             if (keys(%{$domconfig{'login'}})) {
                   5185:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  5186:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1075.2.87  raeburn  5187:                         if (($key eq 'loginvia') || ($key eq 'headtag')) {
                   5188:                             if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   5189:                                 foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
                   5190:                                     if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
                   5191:                                         if ($key eq 'loginvia') {
                   5192:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   5193:                                                 my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   5194:                                                 $designhash{$udom.'.login.loginvia'} = $server;
                   5195:                                                 if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   5196:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   5197:                                                 } else {
                   5198:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
                   5199:                                                 }
1.948     raeburn  5200:                                             }
1.1075.2.87  raeburn  5201:                                         } elsif ($key eq 'headtag') {
                   5202:                                             if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
                   5203:                                                 $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948     raeburn  5204:                                             }
1.946     raeburn  5205:                                         }
1.1075.2.87  raeburn  5206:                                         if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
                   5207:                                             $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
                   5208:                                         }
1.946     raeburn  5209:                                     }
                   5210:                                 }
                   5211:                             }
                   5212:                         } else {
                   5213:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   5214:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   5215:                                     $domconfig{'login'}{$key}{$img};
                   5216:                             }
1.699     raeburn  5217:                         }
                   5218:                     } else {
                   5219:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   5220:                     }
1.632     raeburn  5221:                 }
                   5222:             } else {
                   5223:                 $legacy{'login'} = 1;
1.518     albertel 5224:             }
1.632     raeburn  5225:         } else {
                   5226:             $legacy{'login'} = 1;
1.518     albertel 5227:         }
                   5228:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  5229:             if (keys(%{$domconfig{'rolecolors'}})) {
                   5230:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   5231:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   5232:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   5233:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   5234:                         }
1.518     albertel 5235:                     }
                   5236:                 }
1.632     raeburn  5237:             } else {
                   5238:                 $legacy{'rolecolors'} = 1;
1.518     albertel 5239:             }
1.632     raeburn  5240:         } else {
                   5241:             $legacy{'rolecolors'} = 1;
1.518     albertel 5242:         }
1.948     raeburn  5243:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   5244:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   5245:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   5246:             }
                   5247:         }
1.632     raeburn  5248:         if (keys(%legacy) > 0) {
                   5249:             my %legacyhash = &get_legacy_domconf($udom);
                   5250:             foreach my $item (keys(%legacyhash)) {
                   5251:                 if ($item =~ /^\Q$udom\E\.login/) {
                   5252:                     if ($legacy{'login'}) { 
                   5253:                         $designhash{$item} = $legacyhash{$item};
                   5254:                     }
                   5255:                 } else {
                   5256:                     if ($legacy{'rolecolors'}) {
                   5257:                         $designhash{$item} = $legacyhash{$item};
                   5258:                     }
1.518     albertel 5259:                 }
                   5260:             }
                   5261:         }
1.632     raeburn  5262:     } else {
                   5263:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 5264:     }
                   5265:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   5266: 				  $cachetime);
                   5267:     return %designhash;
                   5268: }
                   5269: 
1.632     raeburn  5270: sub get_legacy_domconf {
                   5271:     my ($udom) = @_;
                   5272:     my %legacyhash;
                   5273:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   5274:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   5275:     if (-e $designfile) {
1.1075.2.128  raeburn  5276:         if ( open (my $fh,'<',$designfile) ) {
1.632     raeburn  5277:             while (my $line = <$fh>) {
                   5278:                 next if ($line =~ /^\#/);
                   5279:                 chomp($line);
                   5280:                 my ($key,$val)=(split(/\=/,$line));
                   5281:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   5282:             }
                   5283:             close($fh);
                   5284:         }
                   5285:     }
1.1026    raeburn  5286:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  5287:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   5288:     }
                   5289:     return %legacyhash;
                   5290: }
                   5291: 
1.63      www      5292: =pod
                   5293: 
1.112     bowersj2 5294: =item * &domainlogo()
1.63      www      5295: 
                   5296: Inputs: $domain (usually will be undef)
                   5297: 
                   5298: Returns: A link to a domain logo, if the domain logo exists.
                   5299: If the domain logo does not exist, a description of the domain.
                   5300: 
                   5301: =cut
1.112     bowersj2 5302: 
1.63      www      5303: ###############################################
                   5304: sub domainlogo {
1.517     raeburn  5305:     my $domain = &determinedomain(shift);
1.518     albertel 5306:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  5307:     # See if there is a logo
                   5308:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  5309:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 5310:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   5311: 	    if ($imgsrc =~ m{^/res/}) {
                   5312: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   5313: 		&Apache::lonnet::repcopy($local_name);
                   5314: 	    }
                   5315: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  5316:         } 
                   5317:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 5318:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   5319:         return &Apache::lonnet::domain($domain,'description');
1.59      www      5320:     } else {
1.60      matthew  5321:         return '';
1.59      www      5322:     }
                   5323: }
1.63      www      5324: ##############################################
                   5325: 
                   5326: =pod
                   5327: 
1.112     bowersj2 5328: =item * &designparm()
1.63      www      5329: 
                   5330: Inputs: $which parameter; $domain (usually will be undef)
                   5331: 
                   5332: Returns: value of designparamter $which
                   5333: 
                   5334: =cut
1.112     bowersj2 5335: 
1.397     albertel 5336: 
1.400     albertel 5337: ##############################################
1.397     albertel 5338: sub designparm {
                   5339:     my ($which,$domain)=@_;
                   5340:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   5341:         return $env{'environment.color.'.$which};
1.96      www      5342:     }
1.63      www      5343:     $domain=&determinedomain($domain);
1.1016    raeburn  5344:     my %domdesign;
                   5345:     unless ($domain eq 'public') {
                   5346:         %domdesign = &get_domainconf($domain);
                   5347:     }
1.520     raeburn  5348:     my $output;
1.517     raeburn  5349:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   5350:         $output = $domdesign{$domain.'.'.$which};
1.63      www      5351:     } else {
1.520     raeburn  5352:         $output = $defaultdesign{$which};
                   5353:     }
                   5354:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  5355:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 5356:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   5357:             if ($output =~ m{^/res/}) {
                   5358:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   5359:                 &Apache::lonnet::repcopy($local_name);
                   5360:             }
1.520     raeburn  5361:             $output = &lonhttpdurl($output);
                   5362:         }
1.63      www      5363:     }
1.520     raeburn  5364:     return $output;
1.63      www      5365: }
1.59      www      5366: 
1.822     bisitz   5367: ##############################################
                   5368: =pod
                   5369: 
1.832     bisitz   5370: =item * &authorspace()
                   5371: 
1.1028    raeburn  5372: Inputs: $url (usually will be undef).
1.832     bisitz   5373: 
1.1075.2.40  raeburn  5374: Returns: Path to Authoring Space containing the resource or 
1.1028    raeburn  5375:          directory being viewed (or for which action is being taken). 
                   5376:          If $url is provided, and begins /priv/<domain>/<uname>
                   5377:          the path will be that portion of the $context argument.
                   5378:          Otherwise the path will be for the author space of the current
                   5379:          user when the current role is author, or for that of the 
                   5380:          co-author/assistant co-author space when the current role 
                   5381:          is co-author or assistant co-author.
1.832     bisitz   5382: 
                   5383: =cut
                   5384: 
                   5385: sub authorspace {
1.1028    raeburn  5386:     my ($url) = @_;
                   5387:     if ($url ne '') {
                   5388:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   5389:            return $1;
                   5390:         }
                   5391:     }
1.832     bisitz   5392:     my $caname = '';
1.1024    www      5393:     my $cadom = '';
1.1028    raeburn  5394:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      5395:         ($cadom,$caname) =
1.832     bisitz   5396:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  5397:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   5398:         $caname = $env{'user.name'};
1.1024    www      5399:         $cadom = $env{'user.domain'};
1.832     bisitz   5400:     }
1.1028    raeburn  5401:     if (($caname ne '') && ($cadom ne '')) {
                   5402:         return "/priv/$cadom/$caname/";
                   5403:     }
                   5404:     return;
1.832     bisitz   5405: }
                   5406: 
                   5407: ##############################################
                   5408: =pod
                   5409: 
1.822     bisitz   5410: =item * &head_subbox()
                   5411: 
                   5412: Inputs: $content (contains HTML code with page functions, etc.)
                   5413: 
                   5414: Returns: HTML div with $content
                   5415:          To be included in page header
                   5416: 
                   5417: =cut
                   5418: 
                   5419: sub head_subbox {
                   5420:     my ($content)=@_;
                   5421:     my $output =
1.993     raeburn  5422:         '<div class="LC_head_subbox">'
1.822     bisitz   5423:        .$content
                   5424:        .'</div>'
                   5425: }
                   5426: 
                   5427: ##############################################
                   5428: =pod
                   5429: 
                   5430: =item * &CSTR_pageheader()
                   5431: 
1.1026    raeburn  5432: Input: (optional) filename from which breadcrumb trail is built.
                   5433:        In most cases no input as needed, as $env{'request.filename'}
                   5434:        is appropriate for use in building the breadcrumb trail.
1.822     bisitz   5435: 
                   5436: Returns: HTML div with CSTR path and recent box
1.1075.2.40  raeburn  5437:          To be included on Authoring Space pages
1.822     bisitz   5438: 
                   5439: =cut
                   5440: 
                   5441: sub CSTR_pageheader {
1.1026    raeburn  5442:     my ($trailfile) = @_;
                   5443:     if ($trailfile eq '') {
                   5444:         $trailfile = $env{'request.filename'};
                   5445:     }
                   5446: 
                   5447: # this is for resources; directories have customtitle, and crumbs
                   5448: # and select recent are created in lonpubdir.pm
                   5449: 
                   5450:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      5451:     my ($udom,$uname,$thisdisfn)=
1.1075.2.29  raeburn  5452:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026    raeburn  5453:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   5454:     $formaction =~ s{/+}{/}g;
1.822     bisitz   5455: 
                   5456:     my $parentpath = '';
                   5457:     my $lastitem = '';
                   5458:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   5459:         $parentpath = $1;
                   5460:         $lastitem = $2;
                   5461:     } else {
                   5462:         $lastitem = $thisdisfn;
                   5463:     }
1.921     bisitz   5464: 
                   5465:     my $output =
1.822     bisitz   5466:          '<div>'
                   5467:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1075.2.40  raeburn  5468:         .'<b>'.&mt('Authoring Space:').'</b> '
1.822     bisitz   5469:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   5470:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024    www      5471:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921     bisitz   5472: 
                   5473:     if ($lastitem) {
                   5474:         $output .=
                   5475:              '<span class="LC_filename">'
                   5476:             .$lastitem
                   5477:             .'</span>';
                   5478:     }
                   5479:     $output .=
                   5480:          '<br />'
1.822     bisitz   5481:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   5482:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   5483:         .'</form>'
                   5484:         .&Apache::lonmenu::constspaceform()
                   5485:         .'</div>';
1.921     bisitz   5486: 
                   5487:     return $output;
1.822     bisitz   5488: }
                   5489: 
1.60      matthew  5490: ###############################################
                   5491: ###############################################
                   5492: 
                   5493: =pod
                   5494: 
1.112     bowersj2 5495: =back
                   5496: 
1.549     albertel 5497: =head1 HTML Helpers
1.112     bowersj2 5498: 
                   5499: =over 4
                   5500: 
                   5501: =item * &bodytag()
1.60      matthew  5502: 
                   5503: Returns a uniform header for LON-CAPA web pages.
                   5504: 
                   5505: Inputs: 
                   5506: 
1.112     bowersj2 5507: =over 4
                   5508: 
                   5509: =item * $title, A title to be displayed on the page.
                   5510: 
                   5511: =item * $function, the current role (can be undef).
                   5512: 
                   5513: =item * $addentries, extra parameters for the <body> tag.
                   5514: 
                   5515: =item * $bodyonly, if defined, only return the <body> tag.
                   5516: 
                   5517: =item * $domain, if defined, force a given domain.
                   5518: 
                   5519: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      5520:             text interface only)
1.60      matthew  5521: 
1.814     bisitz   5522: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   5523:                      navigational links
1.317     albertel 5524: 
1.338     albertel 5525: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   5526: 
1.1075.2.12  raeburn  5527: =item * $no_inline_link, if true and in remote mode, don't show the
                   5528:          'Switch To Inline Menu' link
                   5529: 
1.460     albertel 5530: =item * $args, optional argument valid values are
                   5531:             no_auto_mt_title -> prevents &mt()ing the title arg
1.1075.2.133  raeburn  5532:             use_absolute     -> for external resource or syllabus, this will
                   5533:                                 contain https://<hostname> if server uses
                   5534:                                 https (as per hosts.tab), but request is for http
                   5535:             hostname         -> hostname, from $r->hostname().
1.460     albertel 5536: 
1.1075.2.15  raeburn  5537: =item * $advtoolsref, optional argument, ref to an array containing
                   5538:             inlineremote items to be added in "Functions" menu below
                   5539:             breadcrumbs.
                   5540: 
1.112     bowersj2 5541: =back
                   5542: 
1.60      matthew  5543: Returns: A uniform header for LON-CAPA web pages.  
                   5544: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   5545: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   5546: other decorations will be returned.
                   5547: 
                   5548: =cut
                   5549: 
1.54      www      5550: sub bodytag {
1.831     bisitz   5551:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1075.2.15  raeburn  5552:         $no_nav_bar,$bgcolor,$no_inline_link,$args,$advtoolsref)=@_;
1.339     albertel 5553: 
1.954     raeburn  5554:     my $public;
                   5555:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   5556:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   5557:         $public = 1;
                   5558:     }
1.460     albertel 5559:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1075.2.52  raeburn  5560:     my $httphost = $args->{'use_absolute'};
1.1075.2.133  raeburn  5561:     my $hostname = $args->{'hostname'};
1.339     albertel 5562: 
1.183     matthew  5563:     $function = &get_users_function() if (!$function);
1.339     albertel 5564:     my $img =    &designparm($function.'.img',$domain);
                   5565:     my $font =   &designparm($function.'.font',$domain);
                   5566:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   5567: 
1.803     bisitz   5568:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 5569: 		   'bgcolor' => $pgbg,
1.339     albertel 5570: 		   'text'    => $font,
                   5571:                    'alink'   => &designparm($function.'.alink',$domain),
                   5572: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   5573: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 5574:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 5575: 
1.63      www      5576:  # role and realm
1.1075.2.68  raeburn  5577:     my ($role,$realm) = split(m{\./},$env{'request.role'},2);
                   5578:     if ($realm) {
                   5579:         $realm = '/'.$realm;
                   5580:     }
1.378     raeburn  5581:     if ($role  eq 'ca') {
1.479     albertel 5582:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 5583:         $realm = &plainname($rname,$rdom);
1.378     raeburn  5584:     } 
1.55      www      5585: # realm
1.258     albertel 5586:     if ($env{'request.course.id'}) {
1.378     raeburn  5587:         if ($env{'request.role'} !~ /^cr/) {
                   5588:             $role = &Apache::lonnet::plaintext($role,&course_type());
1.1075.2.115  raeburn  5589:         } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1075.2.121  raeburn  5590:             if ($env{'request.role.desc'}) {
                   5591:                 $role = $env{'request.role.desc'};
                   5592:             } else {
                   5593:                 $role = &mt('Helpdesk[_1]','&nbsp;'.$2);
                   5594:             }
1.1075.2.115  raeburn  5595:         } else {
                   5596:             $role = (split(/\//,$role,4))[-1];
1.378     raeburn  5597:         }
1.898     raeburn  5598:         if ($env{'request.course.sec'}) {
                   5599:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   5600:         }   
1.359     albertel 5601: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  5602:     } else {
                   5603:         $role = &Apache::lonnet::plaintext($role);
1.54      www      5604:     }
1.433     albertel 5605: 
1.359     albertel 5606:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 5607: 
1.438     albertel 5608:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 5609: 
1.101     www      5610: # construct main body tag
1.359     albertel 5611:     my $bodytag = "<body $extra_body_attr>".
1.1075.2.100  raeburn  5612: 	&Apache::lontexconvert::init_math_support();
1.252     albertel 5613: 
1.1075.2.38  raeburn  5614:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   5615: 
                   5616:     if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60      matthew  5617:         return $bodytag;
1.1075.2.38  raeburn  5618:     }
1.359     albertel 5619: 
1.954     raeburn  5620:     if ($public) {
1.433     albertel 5621: 	undef($role);
                   5622:     }
1.359     albertel 5623:     
1.762     bisitz   5624:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 5625:     #
                   5626:     # Extra info if you are the DC
                   5627:     my $dc_info = '';
                   5628:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   5629:                         $env{'course.'.$env{'request.course.id'}.
                   5630:                                  '.domain'}.'/'})) {
                   5631:         my $cid = $env{'request.course.id'};
1.917     raeburn  5632:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      5633:         $dc_info =~ s/\s+$//;
1.359     albertel 5634:     }
                   5635: 
1.1075.2.108  raeburn  5636:     $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.903     droeschl 5637: 
1.1075.2.13  raeburn  5638:     if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   5639: 
1.1075.2.38  raeburn  5640: 
                   5641: 
1.1075.2.21  raeburn  5642:     my $funclist;
                   5643:     if (($env{'environment.remote'} eq 'on') && ($env{'request.state'} ne 'construct')) {
1.1075.2.52  raeburn  5644:         $bodytag .= Apache::lonhtmlcommon::scripttag(Apache::lonmenu::utilityfunctions($httphost), 'start')."\n".
1.1075.2.21  raeburn  5645:                     Apache::lonmenu::serverform();
                   5646:         my $forbodytag;
                   5647:         &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5648:                                             $forcereg,$args->{'group'},
                   5649:                                             $args->{'bread_crumbs'},
1.1075.2.133  raeburn  5650:                                             $advtoolsref,'','',\$forbodytag);
1.1075.2.21  raeburn  5651:         unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5652:             $funclist = $forbodytag;
                   5653:         }
                   5654:     } else {
1.903     droeschl 5655: 
                   5656:         #    if ($env{'request.state'} eq 'construct') {
                   5657:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   5658:         #    }
                   5659: 
1.1075.2.38  raeburn  5660:         $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  5661:             Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359     albertel 5662: 
1.1075.2.38  raeburn  5663:         my ($left,$right) = Apache::lonmenu::primary_menu();
1.1075.2.2  raeburn  5664: 
1.916     droeschl 5665:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.1075.2.22  raeburn  5666:             if ($dc_info) {
                   5667:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
1.1075.2.1  raeburn  5668:             }
1.1075.2.38  raeburn  5669:             $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
1.1075.2.22  raeburn  5670:                            <em>$realm</em> $dc_info</div>|;
1.903     droeschl 5671:             return $bodytag;
                   5672:         }
1.894     droeschl 5673: 
1.927     raeburn  5674:         unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
1.1075.2.38  raeburn  5675:             $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
1.927     raeburn  5676:         }
1.916     droeschl 5677: 
1.1075.2.38  raeburn  5678:         $bodytag .= $right;
1.852     droeschl 5679: 
1.917     raeburn  5680:         if ($dc_info) {
                   5681:             $dc_info = &dc_courseid_toggle($dc_info);
                   5682:         }
                   5683:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 5684: 
1.1075.2.61  raeburn  5685:         #if directed to not display the secondary menu, don't.
                   5686:         if ($args->{'no_secondary_menu'}) {
                   5687:             return $bodytag;
                   5688:         }
1.903     droeschl 5689:         #don't show menus for public users
1.954     raeburn  5690:         if (!$public){
1.1075.2.52  raeburn  5691:             $bodytag .= Apache::lonmenu::secondary_menu($httphost);
1.903     droeschl 5692:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  5693:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   5694:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 5695:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1075.2.133  raeburn  5696:                                 $args->{'bread_crumbs'},'','',$hostname);
1.1075.2.116  raeburn  5697:             } elsif ($forcereg) {
1.1075.2.22  raeburn  5698:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1075.2.116  raeburn  5699:                                                             $args->{'group'},
1.1075.2.133  raeburn  5700:                                                             $args->{'hide_buttons',
                   5701:                                                             $hostname});
1.1075.2.15  raeburn  5702:             } else {
1.1075.2.21  raeburn  5703:                 my $forbodytag;
                   5704:                 &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5705:                                                     $forcereg,$args->{'group'},
                   5706:                                                     $args->{'bread_crumbs'},
1.1075.2.133  raeburn  5707:                                                     $advtoolsref,'',$hostname,
                   5708:                                                     \$forbodytag);
1.1075.2.21  raeburn  5709:                 unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5710:                     $bodytag .= $forbodytag;
                   5711:                 }
1.920     raeburn  5712:             }
1.903     droeschl 5713:         }else{
                   5714:             # this is to seperate menu from content when there's no secondary
                   5715:             # menu. Especially needed for public accessible ressources.
                   5716:             $bodytag .= '<hr style="clear:both" />';
                   5717:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  5718:         }
1.903     droeschl 5719: 
1.235     raeburn  5720:         return $bodytag;
1.1075.2.12  raeburn  5721:     }
                   5722: 
                   5723: #
                   5724: # Top frame rendering, Remote is up
                   5725: #
                   5726: 
                   5727:     my $imgsrc = $img;
                   5728:     if ($img =~ /^\/adm/) {
                   5729:         $imgsrc = &lonhttpdurl($img);
                   5730:     }
                   5731:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
                   5732: 
1.1075.2.60  raeburn  5733:     my $help=($no_inline_link?''
                   5734:               :&Apache::loncommon::top_nav_help('Help'));
                   5735: 
1.1075.2.12  raeburn  5736:     # Explicit link to get inline menu
                   5737:     my $menu= ($no_inline_link?''
                   5738:                :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
                   5739: 
                   5740:     if ($dc_info) {
                   5741:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   5742:     }
                   5743: 
1.1075.2.38  raeburn  5744:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
                   5745:     unless ($public) {
                   5746:         $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
                   5747:                                 undef,'LC_menubuttons_link');
                   5748:     }
                   5749: 
1.1075.2.12  raeburn  5750:     unless ($env{'form.inhibitmenu'}) {
                   5751:         $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.1075.2.38  raeburn  5752:                        <ol class="LC_primary_menu LC_floatright LC_right">
1.1075.2.60  raeburn  5753:                        <li>$help</li>
1.1075.2.12  raeburn  5754:                        <li>$menu</li>
                   5755:                        </ol><div id="LC_realm"> $realm $dc_info</div>|;
                   5756:     }
1.1075.2.13  raeburn  5757:     if ($env{'request.state'} eq 'construct') {
                   5758:         if (!$public){
                   5759:             if ($env{'request.state'} eq 'construct') {
                   5760:                 $funclist = &Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  5761:                                 &Apache::lonmenu::utilityfunctions($httphost), 'start').
1.1075.2.13  raeburn  5762:                             &Apache::lonhtmlcommon::scripttag('','end').
                   5763:                             &Apache::lonmenu::innerregister($forcereg,
                   5764:                                                             $args->{'bread_crumbs'});
                   5765:             }
                   5766:         }
                   5767:     }
1.1075.2.21  raeburn  5768:     return $bodytag."\n".$funclist;
1.182     matthew  5769: }
                   5770: 
1.917     raeburn  5771: sub dc_courseid_toggle {
                   5772:     my ($dc_info) = @_;
1.980     raeburn  5773:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  5774:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  5775:            &mt('(More ...)').'</a></span>'.
                   5776:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5777: }
                   5778: 
1.330     albertel 5779: sub make_attr_string {
                   5780:     my ($register,$attr_ref) = @_;
                   5781: 
                   5782:     if ($attr_ref && !ref($attr_ref)) {
                   5783: 	die("addentries Must be a hash ref ".
                   5784: 	    join(':',caller(1))." ".
                   5785: 	    join(':',caller(0))." ");
                   5786:     }
                   5787: 
                   5788:     if ($register) {
1.339     albertel 5789: 	my ($on_load,$on_unload);
                   5790: 	foreach my $key (keys(%{$attr_ref})) {
                   5791: 	    if      (lc($key) eq 'onload') {
                   5792: 		$on_load.=$attr_ref->{$key}.';';
                   5793: 		delete($attr_ref->{$key});
                   5794: 
                   5795: 	    } elsif (lc($key) eq 'onunload') {
                   5796: 		$on_unload.=$attr_ref->{$key}.';';
                   5797: 		delete($attr_ref->{$key});
                   5798: 	    }
                   5799: 	}
1.1075.2.12  raeburn  5800:         if ($env{'environment.remote'} eq 'on') {
                   5801:             $attr_ref->{'onload'}  =
                   5802:                 &Apache::lonmenu::loadevents().  $on_load;
                   5803:             $attr_ref->{'onunload'}=
                   5804:                 &Apache::lonmenu::unloadevents().$on_unload;
                   5805:         } else {  
                   5806: 	    $attr_ref->{'onload'}  = $on_load;
                   5807: 	    $attr_ref->{'onunload'}= $on_unload;
                   5808:         }
1.330     albertel 5809:     }
1.339     albertel 5810: 
1.330     albertel 5811:     my $attr_string;
1.1075.2.56  raeburn  5812:     foreach my $attr (sort(keys(%$attr_ref))) {
1.330     albertel 5813: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   5814:     }
                   5815:     return $attr_string;
                   5816: }
                   5817: 
                   5818: 
1.182     matthew  5819: ###############################################
1.251     albertel 5820: ###############################################
                   5821: 
                   5822: =pod
                   5823: 
                   5824: =item * &endbodytag()
                   5825: 
                   5826: Returns a uniform footer for LON-CAPA web pages.
                   5827: 
1.635     raeburn  5828: Inputs: 1 - optional reference to an args hash
                   5829: If in the hash, key for noredirectlink has a value which evaluates to true,
                   5830: a 'Continue' link is not displayed if the page contains an
                   5831: internal redirect in the <head></head> section,
                   5832: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 5833: 
                   5834: =cut
                   5835: 
                   5836: sub endbodytag {
1.635     raeburn  5837:     my ($args) = @_;
1.1075.2.6  raeburn  5838:     my $endbodytag;
                   5839:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   5840:         $endbodytag='</body>';
                   5841:     }
1.315     albertel 5842:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  5843:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   5844: 	    $endbodytag=
                   5845: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   5846: 	        &mt('Continue').'</a>'.
                   5847: 	        $endbodytag;
                   5848:         }
1.315     albertel 5849:     }
1.251     albertel 5850:     return $endbodytag;
                   5851: }
                   5852: 
1.352     albertel 5853: =pod
                   5854: 
                   5855: =item * &standard_css()
                   5856: 
                   5857: Returns a style sheet
                   5858: 
                   5859: Inputs: (all optional)
                   5860:             domain         -> force to color decorate a page for a specific
                   5861:                                domain
                   5862:             function       -> force usage of a specific rolish color scheme
                   5863:             bgcolor        -> override the default page bgcolor
                   5864: 
                   5865: =cut
                   5866: 
1.343     albertel 5867: sub standard_css {
1.345     albertel 5868:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 5869:     $function  = &get_users_function() if (!$function);
                   5870:     my $img    = &designparm($function.'.img',   $domain);
                   5871:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   5872:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 5873:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 5874: #second colour for later usage
1.345     albertel 5875:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 5876:     my $pgbg_or_bgcolor =
                   5877: 	         $bgcolor ||
1.352     albertel 5878: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 5879:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 5880:     my $alink  = &designparm($function.'.alink', $domain);
                   5881:     my $vlink  = &designparm($function.'.vlink', $domain);
                   5882:     my $link   = &designparm($function.'.link',  $domain);
                   5883: 
1.602     albertel 5884:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 5885:     my $mono                 = 'monospace';
1.850     bisitz   5886:     my $data_table_head      = $sidebg;
                   5887:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   5888:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 5889:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 5890:     my $data_table_highlight = '#FFFF00';
1.352     albertel 5891:     my $mail_new             = '#FFBB77';
                   5892:     my $mail_new_hover       = '#DD9955';
                   5893:     my $mail_read            = '#BBBB77';
                   5894:     my $mail_read_hover      = '#999944';
                   5895:     my $mail_replied         = '#AAAA88';
                   5896:     my $mail_replied_hover   = '#888855';
                   5897:     my $mail_other           = '#99BBBB';
                   5898:     my $mail_other_hover     = '#669999';
1.391     albertel 5899:     my $table_header         = '#DDDDDD';
1.489     raeburn  5900:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   5901:     my $lg_border_color      = '#C8C8C8';
1.952     onken    5902:     my $button_hover         = '#BF2317';
1.392     albertel 5903: 
1.608     albertel 5904:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   5905:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   5906:                                              : '0 3px 0 4px';
1.448     albertel 5907: 
1.523     albertel 5908: 
1.343     albertel 5909:     return <<END;
1.947     droeschl 5910: 
                   5911: /* needed for iframe to allow 100% height in FF */
                   5912: body, html { 
                   5913:     margin: 0;
                   5914:     padding: 0 0.5%;
                   5915:     height: 99%; /* to avoid scrollbars */
                   5916: }
                   5917: 
1.795     www      5918: body {
1.911     bisitz   5919:   font-family: $sans;
                   5920:   line-height:130%;
                   5921:   font-size:0.83em;
                   5922:   color:$font;
1.795     www      5923: }
                   5924: 
1.959     onken    5925: a:focus,
                   5926: a:focus img {
1.795     www      5927:   color: red;
                   5928: }
1.698     harmsja  5929: 
1.911     bisitz   5930: form, .inline {
                   5931:   display: inline;
1.795     www      5932: }
1.721     harmsja  5933: 
1.795     www      5934: .LC_right {
1.911     bisitz   5935:   text-align:right;
1.795     www      5936: }
                   5937: 
                   5938: .LC_middle {
1.911     bisitz   5939:   vertical-align:middle;
1.795     www      5940: }
1.721     harmsja  5941: 
1.1075.2.38  raeburn  5942: .LC_floatleft {
                   5943:   float: left;
                   5944: }
                   5945: 
                   5946: .LC_floatright {
                   5947:   float: right;
                   5948: }
                   5949: 
1.911     bisitz   5950: .LC_400Box {
                   5951:   width:400px;
                   5952: }
1.721     harmsja  5953: 
1.947     droeschl 5954: .LC_iframecontainer {
                   5955:     width: 98%;
                   5956:     margin: 0;
                   5957:     position: fixed;
                   5958:     top: 8.5em;
                   5959:     bottom: 0;
                   5960: }
                   5961: 
                   5962: .LC_iframecontainer iframe{
                   5963:     border: none;
                   5964:     width: 100%;
                   5965:     height: 100%;
                   5966: }
                   5967: 
1.778     bisitz   5968: .LC_filename {
                   5969:   font-family: $mono;
                   5970:   white-space:pre;
1.921     bisitz   5971:   font-size: 120%;
1.778     bisitz   5972: }
                   5973: 
                   5974: .LC_fileicon {
                   5975:   border: none;
                   5976:   height: 1.3em;
                   5977:   vertical-align: text-bottom;
                   5978:   margin-right: 0.3em;
                   5979:   text-decoration:none;
                   5980: }
                   5981: 
1.1008    www      5982: .LC_setting {
                   5983:   text-decoration:underline;
                   5984: }
                   5985: 
1.350     albertel 5986: .LC_error {
                   5987:   color: red;
                   5988: }
1.795     www      5989: 
1.1075.2.15  raeburn  5990: .LC_warning {
                   5991:   color: darkorange;
                   5992: }
                   5993: 
1.457     albertel 5994: .LC_diff_removed {
1.733     bisitz   5995:   color: red;
1.394     albertel 5996: }
1.532     albertel 5997: 
                   5998: .LC_info,
1.457     albertel 5999: .LC_success,
                   6000: .LC_diff_added {
1.350     albertel 6001:   color: green;
                   6002: }
1.795     www      6003: 
1.802     bisitz   6004: div.LC_confirm_box {
                   6005:   background-color: #FAFAFA;
                   6006:   border: 1px solid $lg_border_color;
                   6007:   margin-right: 0;
                   6008:   padding: 5px;
                   6009: }
                   6010: 
                   6011: div.LC_confirm_box .LC_error img,
                   6012: div.LC_confirm_box .LC_success img {
                   6013:   vertical-align: middle;
                   6014: }
                   6015: 
1.1075.2.108  raeburn  6016: .LC_maxwidth {
                   6017:   max-width: 100%;
                   6018:   height: auto;
                   6019: }
                   6020: 
                   6021: .LC_textsize_mobile {
                   6022:   \@media only screen and (max-device-width: 480px) {
                   6023:       -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
                   6024:   }
                   6025: }
                   6026: 
1.440     albertel 6027: .LC_icon {
1.771     droeschl 6028:   border: none;
1.790     droeschl 6029:   vertical-align: middle;
1.771     droeschl 6030: }
                   6031: 
1.543     albertel 6032: .LC_docs_spacer {
                   6033:   width: 25px;
                   6034:   height: 1px;
1.771     droeschl 6035:   border: none;
1.543     albertel 6036: }
1.346     albertel 6037: 
1.532     albertel 6038: .LC_internal_info {
1.735     bisitz   6039:   color: #999999;
1.532     albertel 6040: }
                   6041: 
1.794     www      6042: .LC_discussion {
1.1050    www      6043:   background: $data_table_dark;
1.911     bisitz   6044:   border: 1px solid black;
                   6045:   margin: 2px;
1.794     www      6046: }
                   6047: 
                   6048: .LC_disc_action_left {
1.1050    www      6049:   background: $sidebg;
1.911     bisitz   6050:   text-align: left;
1.1050    www      6051:   padding: 4px;
                   6052:   margin: 2px;
1.794     www      6053: }
                   6054: 
                   6055: .LC_disc_action_right {
1.1050    www      6056:   background: $sidebg;
1.911     bisitz   6057:   text-align: right;
1.1050    www      6058:   padding: 4px;
                   6059:   margin: 2px;
1.794     www      6060: }
                   6061: 
                   6062: .LC_disc_new_item {
1.911     bisitz   6063:   background: white;
                   6064:   border: 2px solid red;
1.1050    www      6065:   margin: 4px;
                   6066:   padding: 4px;
1.794     www      6067: }
                   6068: 
                   6069: .LC_disc_old_item {
1.911     bisitz   6070:   background: white;
1.1050    www      6071:   margin: 4px;
                   6072:   padding: 4px;
1.794     www      6073: }
                   6074: 
1.458     albertel 6075: table.LC_pastsubmission {
                   6076:   border: 1px solid black;
                   6077:   margin: 2px;
                   6078: }
                   6079: 
1.924     bisitz   6080: table#LC_menubuttons {
1.345     albertel 6081:   width: 100%;
                   6082:   background: $pgbg;
1.392     albertel 6083:   border: 2px;
1.402     albertel 6084:   border-collapse: separate;
1.803     bisitz   6085:   padding: 0;
1.345     albertel 6086: }
1.392     albertel 6087: 
1.801     tempelho 6088: table#LC_title_bar a {
                   6089:   color: $fontmenu;
                   6090: }
1.836     bisitz   6091: 
1.807     droeschl 6092: table#LC_title_bar {
1.819     tempelho 6093:   clear: both;
1.836     bisitz   6094:   display: none;
1.807     droeschl 6095: }
                   6096: 
1.795     www      6097: table#LC_title_bar,
1.933     droeschl 6098: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 6099: table#LC_title_bar.LC_with_remote {
1.359     albertel 6100:   width: 100%;
1.392     albertel 6101:   border-color: $pgbg;
                   6102:   border-style: solid;
                   6103:   border-width: $border;
1.379     albertel 6104:   background: $pgbg;
1.801     tempelho 6105:   color: $fontmenu;
1.392     albertel 6106:   border-collapse: collapse;
1.803     bisitz   6107:   padding: 0;
1.819     tempelho 6108:   margin: 0;
1.359     albertel 6109: }
1.795     www      6110: 
1.933     droeschl 6111: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 6112:     margin: 0;
                   6113:     padding: 0;
1.933     droeschl 6114:     position: relative;
                   6115:     list-style: none;
1.913     droeschl 6116: }
1.933     droeschl 6117: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 6118:     display: inline;
                   6119: }
1.933     droeschl 6120: 
                   6121: .LC_breadcrumb_tools_navigation {
1.913     droeschl 6122:     padding: 0;
1.933     droeschl 6123:     margin: 0;
                   6124:     float: left;
1.913     droeschl 6125: }
1.933     droeschl 6126: .LC_breadcrumb_tools_tools {
                   6127:     padding: 0;
                   6128:     margin: 0;
1.913     droeschl 6129:     float: right;
                   6130: }
                   6131: 
1.359     albertel 6132: table#LC_title_bar td {
                   6133:   background: $tabbg;
                   6134: }
1.795     www      6135: 
1.911     bisitz   6136: table#LC_menubuttons img {
1.803     bisitz   6137:   border: none;
1.346     albertel 6138: }
1.795     www      6139: 
1.842     droeschl 6140: .LC_breadcrumbs_component {
1.911     bisitz   6141:   float: right;
                   6142:   margin: 0 1em;
1.357     albertel 6143: }
1.842     droeschl 6144: .LC_breadcrumbs_component img {
1.911     bisitz   6145:   vertical-align: middle;
1.777     tempelho 6146: }
1.795     www      6147: 
1.1075.2.108  raeburn  6148: .LC_breadcrumbs_hoverable {
                   6149:   background: $sidebg;
                   6150: }
                   6151: 
1.383     albertel 6152: td.LC_table_cell_checkbox {
                   6153:   text-align: center;
                   6154: }
1.795     www      6155: 
                   6156: .LC_fontsize_small {
1.911     bisitz   6157:   font-size: 70%;
1.705     tempelho 6158: }
                   6159: 
1.844     bisitz   6160: #LC_breadcrumbs {
1.911     bisitz   6161:   clear:both;
                   6162:   background: $sidebg;
                   6163:   border-bottom: 1px solid $lg_border_color;
                   6164:   line-height: 2.5em;
1.933     droeschl 6165:   overflow: hidden;
1.911     bisitz   6166:   margin: 0;
                   6167:   padding: 0;
1.995     raeburn  6168:   text-align: left;
1.819     tempelho 6169: }
1.862     bisitz   6170: 
1.1075.2.16  raeburn  6171: .LC_head_subbox, .LC_actionbox {
1.911     bisitz   6172:   clear:both;
                   6173:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 6174:   border: 1px solid $sidebg;
1.1075.2.16  raeburn  6175:   margin: 0 0 10px 0;
1.966     bisitz   6176:   padding: 3px;
1.995     raeburn  6177:   text-align: left;
1.822     bisitz   6178: }
                   6179: 
1.795     www      6180: .LC_fontsize_medium {
1.911     bisitz   6181:   font-size: 85%;
1.705     tempelho 6182: }
                   6183: 
1.795     www      6184: .LC_fontsize_large {
1.911     bisitz   6185:   font-size: 120%;
1.705     tempelho 6186: }
                   6187: 
1.346     albertel 6188: .LC_menubuttons_inline_text {
                   6189:   color: $font;
1.698     harmsja  6190:   font-size: 90%;
1.701     harmsja  6191:   padding-left:3px;
1.346     albertel 6192: }
                   6193: 
1.934     droeschl 6194: .LC_menubuttons_inline_text img{
                   6195:   vertical-align: middle;
                   6196: }
                   6197: 
1.1051    www      6198: li.LC_menubuttons_inline_text img {
1.951     onken    6199:   cursor:pointer;
1.1002    droeschl 6200:   text-decoration: none;
1.951     onken    6201: }
                   6202: 
1.526     www      6203: .LC_menubuttons_link {
                   6204:   text-decoration: none;
                   6205: }
1.795     www      6206: 
1.522     albertel 6207: .LC_menubuttons_category {
1.521     www      6208:   color: $font;
1.526     www      6209:   background: $pgbg;
1.521     www      6210:   font-size: larger;
                   6211:   font-weight: bold;
                   6212: }
                   6213: 
1.346     albertel 6214: td.LC_menubuttons_text {
1.911     bisitz   6215:   color: $font;
1.346     albertel 6216: }
1.706     harmsja  6217: 
1.346     albertel 6218: .LC_current_location {
                   6219:   background: $tabbg;
                   6220: }
1.795     www      6221: 
1.1075.2.134  raeburn  6222: td.LC_zero_height {
                   6223:   line-height: 0;
                   6224:   cellpadding: 0;
                   6225: }
                   6226: 
1.938     bisitz   6227: table.LC_data_table {
1.347     albertel 6228:   border: 1px solid #000000;
1.402     albertel 6229:   border-collapse: separate;
1.426     albertel 6230:   border-spacing: 1px;
1.610     albertel 6231:   background: $pgbg;
1.347     albertel 6232: }
1.795     www      6233: 
1.422     albertel 6234: .LC_data_table_dense {
                   6235:   font-size: small;
                   6236: }
1.795     www      6237: 
1.507     raeburn  6238: table.LC_nested_outer {
                   6239:   border: 1px solid #000000;
1.589     raeburn  6240:   border-collapse: collapse;
1.803     bisitz   6241:   border-spacing: 0;
1.507     raeburn  6242:   width: 100%;
                   6243: }
1.795     www      6244: 
1.879     raeburn  6245: table.LC_innerpickbox,
1.507     raeburn  6246: table.LC_nested {
1.803     bisitz   6247:   border: none;
1.589     raeburn  6248:   border-collapse: collapse;
1.803     bisitz   6249:   border-spacing: 0;
1.507     raeburn  6250:   width: 100%;
                   6251: }
1.795     www      6252: 
1.911     bisitz   6253: table.LC_data_table tr th,
                   6254: table.LC_calendar tr th,
1.879     raeburn  6255: table.LC_prior_tries tr th,
                   6256: table.LC_innerpickbox tr th {
1.349     albertel 6257:   font-weight: bold;
                   6258:   background-color: $data_table_head;
1.801     tempelho 6259:   color:$fontmenu;
1.701     harmsja  6260:   font-size:90%;
1.347     albertel 6261: }
1.795     www      6262: 
1.879     raeburn  6263: table.LC_innerpickbox tr th,
                   6264: table.LC_innerpickbox tr td {
                   6265:   vertical-align: top;
                   6266: }
                   6267: 
1.711     raeburn  6268: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   6269:   background-color: #CCCCCC;
1.711     raeburn  6270:   font-weight: bold;
                   6271:   text-align: left;
                   6272: }
1.795     www      6273: 
1.912     bisitz   6274: table.LC_data_table tr.LC_odd_row > td {
                   6275:   background-color: $data_table_light;
                   6276:   padding: 2px;
                   6277:   vertical-align: top;
                   6278: }
                   6279: 
1.809     bisitz   6280: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 6281:   background-color: $data_table_light;
1.912     bisitz   6282:   vertical-align: top;
                   6283: }
                   6284: 
                   6285: table.LC_data_table tr.LC_even_row > td {
                   6286:   background-color: $data_table_dark;
1.425     albertel 6287:   padding: 2px;
1.900     bisitz   6288:   vertical-align: top;
1.347     albertel 6289: }
1.795     www      6290: 
1.809     bisitz   6291: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 6292:   background-color: $data_table_dark;
1.900     bisitz   6293:   vertical-align: top;
1.347     albertel 6294: }
1.795     www      6295: 
1.425     albertel 6296: table.LC_data_table tr.LC_data_table_highlight td {
                   6297:   background-color: $data_table_darker;
                   6298: }
1.795     www      6299: 
1.639     raeburn  6300: table.LC_data_table tr td.LC_leftcol_header {
                   6301:   background-color: $data_table_head;
                   6302:   font-weight: bold;
                   6303: }
1.795     www      6304: 
1.451     albertel 6305: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  6306: table.LC_nested tr.LC_empty_row td {
1.421     albertel 6307:   font-weight: bold;
                   6308:   font-style: italic;
                   6309:   text-align: center;
                   6310:   padding: 8px;
1.347     albertel 6311: }
1.795     www      6312: 
1.1075.2.30  raeburn  6313: table.LC_data_table tr.LC_empty_row td,
                   6314: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   6315:   background-color: $sidebg;
                   6316: }
                   6317: 
                   6318: table.LC_nested tr.LC_empty_row td {
                   6319:   background-color: #FFFFFF;
                   6320: }
                   6321: 
1.890     droeschl 6322: table.LC_caption {
                   6323: }
                   6324: 
1.507     raeburn  6325: table.LC_nested tr.LC_empty_row td {
1.465     albertel 6326:   padding: 4ex
                   6327: }
1.795     www      6328: 
1.507     raeburn  6329: table.LC_nested_outer tr th {
                   6330:   font-weight: bold;
1.801     tempelho 6331:   color:$fontmenu;
1.507     raeburn  6332:   background-color: $data_table_head;
1.701     harmsja  6333:   font-size: small;
1.507     raeburn  6334:   border-bottom: 1px solid #000000;
                   6335: }
1.795     www      6336: 
1.507     raeburn  6337: table.LC_nested_outer tr td.LC_subheader {
                   6338:   background-color: $data_table_head;
                   6339:   font-weight: bold;
                   6340:   font-size: small;
                   6341:   border-bottom: 1px solid #000000;
                   6342:   text-align: right;
1.451     albertel 6343: }
1.795     www      6344: 
1.507     raeburn  6345: table.LC_nested tr.LC_info_row td {
1.735     bisitz   6346:   background-color: #CCCCCC;
1.451     albertel 6347:   font-weight: bold;
                   6348:   font-size: small;
1.507     raeburn  6349:   text-align: center;
                   6350: }
1.795     www      6351: 
1.589     raeburn  6352: table.LC_nested tr.LC_info_row td.LC_left_item,
                   6353: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  6354:   text-align: left;
1.451     albertel 6355: }
1.795     www      6356: 
1.507     raeburn  6357: table.LC_nested td {
1.735     bisitz   6358:   background-color: #FFFFFF;
1.451     albertel 6359:   font-size: small;
1.507     raeburn  6360: }
1.795     www      6361: 
1.507     raeburn  6362: table.LC_nested_outer tr th.LC_right_item,
                   6363: table.LC_nested tr.LC_info_row td.LC_right_item,
                   6364: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   6365: table.LC_nested tr td.LC_right_item {
1.451     albertel 6366:   text-align: right;
                   6367: }
                   6368: 
1.507     raeburn  6369: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   6370:   background-color: #EEEEEE;
1.451     albertel 6371: }
                   6372: 
1.473     raeburn  6373: table.LC_createuser {
                   6374: }
                   6375: 
                   6376: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  6377:   font-size: small;
1.473     raeburn  6378: }
                   6379: 
                   6380: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   6381:   background-color: #CCCCCC;
1.473     raeburn  6382:   font-weight: bold;
                   6383:   text-align: center;
                   6384: }
                   6385: 
1.349     albertel 6386: table.LC_calendar {
                   6387:   border: 1px solid #000000;
                   6388:   border-collapse: collapse;
1.917     raeburn  6389:   width: 98%;
1.349     albertel 6390: }
1.795     www      6391: 
1.349     albertel 6392: table.LC_calendar_pickdate {
                   6393:   font-size: xx-small;
                   6394: }
1.795     www      6395: 
1.349     albertel 6396: table.LC_calendar tr td {
                   6397:   border: 1px solid #000000;
                   6398:   vertical-align: top;
1.917     raeburn  6399:   width: 14%;
1.349     albertel 6400: }
1.795     www      6401: 
1.349     albertel 6402: table.LC_calendar tr td.LC_calendar_day_empty {
                   6403:   background-color: $data_table_dark;
                   6404: }
1.795     www      6405: 
1.779     bisitz   6406: table.LC_calendar tr td.LC_calendar_day_current {
                   6407:   background-color: $data_table_highlight;
1.777     tempelho 6408: }
1.795     www      6409: 
1.938     bisitz   6410: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 6411:   background-color: $mail_new;
                   6412: }
1.795     www      6413: 
1.938     bisitz   6414: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 6415:   background-color: $mail_new_hover;
                   6416: }
1.795     www      6417: 
1.938     bisitz   6418: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 6419:   background-color: $mail_read;
                   6420: }
1.795     www      6421: 
1.938     bisitz   6422: /*
                   6423: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 6424:   background-color: $mail_read_hover;
                   6425: }
1.938     bisitz   6426: */
1.795     www      6427: 
1.938     bisitz   6428: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 6429:   background-color: $mail_replied;
                   6430: }
1.795     www      6431: 
1.938     bisitz   6432: /*
                   6433: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 6434:   background-color: $mail_replied_hover;
                   6435: }
1.938     bisitz   6436: */
1.795     www      6437: 
1.938     bisitz   6438: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 6439:   background-color: $mail_other;
                   6440: }
1.795     www      6441: 
1.938     bisitz   6442: /*
                   6443: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 6444:   background-color: $mail_other_hover;
                   6445: }
1.938     bisitz   6446: */
1.494     raeburn  6447: 
1.777     tempelho 6448: table.LC_data_table tr > td.LC_browser_file,
                   6449: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   6450:   background: #AAEE77;
1.389     albertel 6451: }
1.795     www      6452: 
1.777     tempelho 6453: table.LC_data_table tr > td.LC_browser_file_locked,
                   6454: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 6455:   background: #FFAA99;
1.387     albertel 6456: }
1.795     www      6457: 
1.777     tempelho 6458: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   6459:   background: #888888;
1.779     bisitz   6460: }
1.795     www      6461: 
1.777     tempelho 6462: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   6463: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   6464:   background: #F8F866;
1.777     tempelho 6465: }
1.795     www      6466: 
1.696     bisitz   6467: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   6468:   background: #E0E8FF;
1.387     albertel 6469: }
1.696     bisitz   6470: 
1.707     bisitz   6471: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   6472:   /* background: #77FF77; */
1.707     bisitz   6473: }
1.795     www      6474: 
1.707     bisitz   6475: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   6476:   border-right: 8px solid #FFFF77;
1.707     bisitz   6477: }
1.795     www      6478: 
1.707     bisitz   6479: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   6480:   border-right: 8px solid #FFAA77;
1.707     bisitz   6481: }
1.795     www      6482: 
1.707     bisitz   6483: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   6484:   border-right: 8px solid #FF7777;
1.707     bisitz   6485: }
1.795     www      6486: 
1.707     bisitz   6487: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   6488:   border-right: 8px solid #AAFF77;
1.707     bisitz   6489: }
1.795     www      6490: 
1.707     bisitz   6491: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   6492:   border-right: 8px solid #11CC55;
1.707     bisitz   6493: }
                   6494: 
1.388     albertel 6495: span.LC_current_location {
1.701     harmsja  6496:   font-size:larger;
1.388     albertel 6497:   background: $pgbg;
                   6498: }
1.387     albertel 6499: 
1.1029    www      6500: span.LC_current_nav_location {
                   6501:   font-weight:bold;
                   6502:   background: $sidebg;
                   6503: }
                   6504: 
1.395     albertel 6505: span.LC_parm_menu_item {
                   6506:   font-size: larger;
                   6507: }
1.795     www      6508: 
1.395     albertel 6509: span.LC_parm_scope_all {
                   6510:   color: red;
                   6511: }
1.795     www      6512: 
1.395     albertel 6513: span.LC_parm_scope_folder {
                   6514:   color: green;
                   6515: }
1.795     www      6516: 
1.395     albertel 6517: span.LC_parm_scope_resource {
                   6518:   color: orange;
                   6519: }
1.795     www      6520: 
1.395     albertel 6521: span.LC_parm_part {
                   6522:   color: blue;
                   6523: }
1.795     www      6524: 
1.911     bisitz   6525: span.LC_parm_folder,
                   6526: span.LC_parm_symb {
1.395     albertel 6527:   font-size: x-small;
                   6528:   font-family: $mono;
                   6529:   color: #AAAAAA;
                   6530: }
                   6531: 
1.977     bisitz   6532: ul.LC_parm_parmlist li {
                   6533:   display: inline-block;
                   6534:   padding: 0.3em 0.8em;
                   6535:   vertical-align: top;
                   6536:   width: 150px;
                   6537:   border-top:1px solid $lg_border_color;
                   6538: }
                   6539: 
1.795     www      6540: td.LC_parm_overview_level_menu,
                   6541: td.LC_parm_overview_map_menu,
                   6542: td.LC_parm_overview_parm_selectors,
                   6543: td.LC_parm_overview_restrictions  {
1.396     albertel 6544:   border: 1px solid black;
                   6545:   border-collapse: collapse;
                   6546: }
1.795     www      6547: 
1.396     albertel 6548: table.LC_parm_overview_restrictions td {
                   6549:   border-width: 1px 4px 1px 4px;
                   6550:   border-style: solid;
                   6551:   border-color: $pgbg;
                   6552:   text-align: center;
                   6553: }
1.795     www      6554: 
1.396     albertel 6555: table.LC_parm_overview_restrictions th {
                   6556:   background: $tabbg;
                   6557:   border-width: 1px 4px 1px 4px;
                   6558:   border-style: solid;
                   6559:   border-color: $pgbg;
                   6560: }
1.795     www      6561: 
1.398     albertel 6562: table#LC_helpmenu {
1.803     bisitz   6563:   border: none;
1.398     albertel 6564:   height: 55px;
1.803     bisitz   6565:   border-spacing: 0;
1.398     albertel 6566: }
                   6567: 
                   6568: table#LC_helpmenu fieldset legend {
                   6569:   font-size: larger;
                   6570: }
1.795     www      6571: 
1.397     albertel 6572: table#LC_helpmenu_links {
                   6573:   width: 100%;
                   6574:   border: 1px solid black;
                   6575:   background: $pgbg;
1.803     bisitz   6576:   padding: 0;
1.397     albertel 6577:   border-spacing: 1px;
                   6578: }
1.795     www      6579: 
1.397     albertel 6580: table#LC_helpmenu_links tr td {
                   6581:   padding: 1px;
                   6582:   background: $tabbg;
1.399     albertel 6583:   text-align: center;
                   6584:   font-weight: bold;
1.397     albertel 6585: }
1.396     albertel 6586: 
1.795     www      6587: table#LC_helpmenu_links a:link,
                   6588: table#LC_helpmenu_links a:visited,
1.397     albertel 6589: table#LC_helpmenu_links a:active {
                   6590:   text-decoration: none;
                   6591:   color: $font;
                   6592: }
1.795     www      6593: 
1.397     albertel 6594: table#LC_helpmenu_links a:hover {
                   6595:   text-decoration: underline;
                   6596:   color: $vlink;
                   6597: }
1.396     albertel 6598: 
1.417     albertel 6599: .LC_chrt_popup_exists {
                   6600:   border: 1px solid #339933;
                   6601:   margin: -1px;
                   6602: }
1.795     www      6603: 
1.417     albertel 6604: .LC_chrt_popup_up {
                   6605:   border: 1px solid yellow;
                   6606:   margin: -1px;
                   6607: }
1.795     www      6608: 
1.417     albertel 6609: .LC_chrt_popup {
                   6610:   border: 1px solid #8888FF;
                   6611:   background: #CCCCFF;
                   6612: }
1.795     www      6613: 
1.421     albertel 6614: table.LC_pick_box {
                   6615:   border-collapse: separate;
                   6616:   background: white;
                   6617:   border: 1px solid black;
                   6618:   border-spacing: 1px;
                   6619: }
1.795     www      6620: 
1.421     albertel 6621: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   6622:   background: $sidebg;
1.421     albertel 6623:   font-weight: bold;
1.900     bisitz   6624:   text-align: left;
1.740     bisitz   6625:   vertical-align: top;
1.421     albertel 6626:   width: 184px;
                   6627:   padding: 8px;
                   6628: }
1.795     www      6629: 
1.579     raeburn  6630: table.LC_pick_box td.LC_pick_box_value {
                   6631:   text-align: left;
                   6632:   padding: 8px;
                   6633: }
1.795     www      6634: 
1.579     raeburn  6635: table.LC_pick_box td.LC_pick_box_select {
                   6636:   text-align: left;
                   6637:   padding: 8px;
                   6638: }
1.795     www      6639: 
1.424     albertel 6640: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   6641:   padding: 0;
1.421     albertel 6642:   height: 1px;
                   6643:   background: black;
                   6644: }
1.795     www      6645: 
1.421     albertel 6646: table.LC_pick_box td.LC_pick_box_submit {
                   6647:   text-align: right;
                   6648: }
1.795     www      6649: 
1.579     raeburn  6650: table.LC_pick_box td.LC_evenrow_value {
                   6651:   text-align: left;
                   6652:   padding: 8px;
                   6653:   background-color: $data_table_light;
                   6654: }
1.795     www      6655: 
1.579     raeburn  6656: table.LC_pick_box td.LC_oddrow_value {
                   6657:   text-align: left;
                   6658:   padding: 8px;
                   6659:   background-color: $data_table_light;
                   6660: }
1.795     www      6661: 
1.579     raeburn  6662: span.LC_helpform_receipt_cat {
                   6663:   font-weight: bold;
                   6664: }
1.795     www      6665: 
1.424     albertel 6666: table.LC_group_priv_box {
                   6667:   background: white;
                   6668:   border: 1px solid black;
                   6669:   border-spacing: 1px;
                   6670: }
1.795     www      6671: 
1.424     albertel 6672: table.LC_group_priv_box td.LC_pick_box_title {
                   6673:   background: $tabbg;
                   6674:   font-weight: bold;
                   6675:   text-align: right;
                   6676:   width: 184px;
                   6677: }
1.795     www      6678: 
1.424     albertel 6679: table.LC_group_priv_box td.LC_groups_fixed {
                   6680:   background: $data_table_light;
                   6681:   text-align: center;
                   6682: }
1.795     www      6683: 
1.424     albertel 6684: table.LC_group_priv_box td.LC_groups_optional {
                   6685:   background: $data_table_dark;
                   6686:   text-align: center;
                   6687: }
1.795     www      6688: 
1.424     albertel 6689: table.LC_group_priv_box td.LC_groups_functionality {
                   6690:   background: $data_table_darker;
                   6691:   text-align: center;
                   6692:   font-weight: bold;
                   6693: }
1.795     www      6694: 
1.424     albertel 6695: table.LC_group_priv td {
                   6696:   text-align: left;
1.803     bisitz   6697:   padding: 0;
1.424     albertel 6698: }
                   6699: 
                   6700: .LC_navbuttons {
                   6701:   margin: 2ex 0ex 2ex 0ex;
                   6702: }
1.795     www      6703: 
1.423     albertel 6704: .LC_topic_bar {
                   6705:   font-weight: bold;
                   6706:   background: $tabbg;
1.918     wenzelju 6707:   margin: 1em 0em 1em 2em;
1.805     bisitz   6708:   padding: 3px;
1.918     wenzelju 6709:   font-size: 1.2em;
1.423     albertel 6710: }
1.795     www      6711: 
1.423     albertel 6712: .LC_topic_bar span {
1.918     wenzelju 6713:   left: 0.5em;
                   6714:   position: absolute;
1.423     albertel 6715:   vertical-align: middle;
1.918     wenzelju 6716:   font-size: 1.2em;
1.423     albertel 6717: }
1.795     www      6718: 
1.423     albertel 6719: table.LC_course_group_status {
                   6720:   margin: 20px;
                   6721: }
1.795     www      6722: 
1.423     albertel 6723: table.LC_status_selector td {
                   6724:   vertical-align: top;
                   6725:   text-align: center;
1.424     albertel 6726:   padding: 4px;
                   6727: }
1.795     www      6728: 
1.599     albertel 6729: div.LC_feedback_link {
1.616     albertel 6730:   clear: both;
1.829     kalberla 6731:   background: $sidebg;
1.779     bisitz   6732:   width: 100%;
1.829     kalberla 6733:   padding-bottom: 10px;
                   6734:   border: 1px $tabbg solid;
1.833     kalberla 6735:   height: 22px;
                   6736:   line-height: 22px;
                   6737:   padding-top: 5px;
                   6738: }
                   6739: 
                   6740: div.LC_feedback_link img {
                   6741:   height: 22px;
1.867     kalberla 6742:   vertical-align:middle;
1.829     kalberla 6743: }
                   6744: 
1.911     bisitz   6745: div.LC_feedback_link a {
1.829     kalberla 6746:   text-decoration: none;
1.489     raeburn  6747: }
1.795     www      6748: 
1.867     kalberla 6749: div.LC_comblock {
1.911     bisitz   6750:   display:inline;
1.867     kalberla 6751:   color:$font;
                   6752:   font-size:90%;
                   6753: }
                   6754: 
                   6755: div.LC_feedback_link div.LC_comblock {
                   6756:   padding-left:5px;
                   6757: }
                   6758: 
                   6759: div.LC_feedback_link div.LC_comblock a {
                   6760:   color:$font;
                   6761: }
                   6762: 
1.489     raeburn  6763: span.LC_feedback_link {
1.858     bisitz   6764:   /* background: $feedback_link_bg; */
1.599     albertel 6765:   font-size: larger;
                   6766: }
1.795     www      6767: 
1.599     albertel 6768: span.LC_message_link {
1.858     bisitz   6769:   /* background: $feedback_link_bg; */
1.599     albertel 6770:   font-size: larger;
                   6771:   position: absolute;
                   6772:   right: 1em;
1.489     raeburn  6773: }
1.421     albertel 6774: 
1.515     albertel 6775: table.LC_prior_tries {
1.524     albertel 6776:   border: 1px solid #000000;
                   6777:   border-collapse: separate;
                   6778:   border-spacing: 1px;
1.515     albertel 6779: }
1.523     albertel 6780: 
1.515     albertel 6781: table.LC_prior_tries td {
1.524     albertel 6782:   padding: 2px;
1.515     albertel 6783: }
1.523     albertel 6784: 
                   6785: .LC_answer_correct {
1.795     www      6786:   background: lightgreen;
                   6787:   color: darkgreen;
                   6788:   padding: 6px;
1.523     albertel 6789: }
1.795     www      6790: 
1.523     albertel 6791: .LC_answer_charged_try {
1.797     www      6792:   background: #FFAAAA;
1.795     www      6793:   color: darkred;
                   6794:   padding: 6px;
1.523     albertel 6795: }
1.795     www      6796: 
1.779     bisitz   6797: .LC_answer_not_charged_try,
1.523     albertel 6798: .LC_answer_no_grade,
                   6799: .LC_answer_late {
1.795     www      6800:   background: lightyellow;
1.523     albertel 6801:   color: black;
1.795     www      6802:   padding: 6px;
1.523     albertel 6803: }
1.795     www      6804: 
1.523     albertel 6805: .LC_answer_previous {
1.795     www      6806:   background: lightblue;
                   6807:   color: darkblue;
                   6808:   padding: 6px;
1.523     albertel 6809: }
1.795     www      6810: 
1.779     bisitz   6811: .LC_answer_no_message {
1.777     tempelho 6812:   background: #FFFFFF;
                   6813:   color: black;
1.795     www      6814:   padding: 6px;
1.779     bisitz   6815: }
1.795     www      6816: 
1.1075.2.140  raeburn  6817: .LC_answer_unknown,
                   6818: .LC_answer_warning {
1.779     bisitz   6819:   background: orange;
                   6820:   color: black;
1.795     www      6821:   padding: 6px;
1.777     tempelho 6822: }
1.795     www      6823: 
1.529     albertel 6824: span.LC_prior_numerical,
                   6825: span.LC_prior_string,
                   6826: span.LC_prior_custom,
                   6827: span.LC_prior_reaction,
                   6828: span.LC_prior_math {
1.925     bisitz   6829:   font-family: $mono;
1.523     albertel 6830:   white-space: pre;
                   6831: }
                   6832: 
1.525     albertel 6833: span.LC_prior_string {
1.925     bisitz   6834:   font-family: $mono;
1.525     albertel 6835:   white-space: pre;
                   6836: }
                   6837: 
1.523     albertel 6838: table.LC_prior_option {
                   6839:   width: 100%;
                   6840:   border-collapse: collapse;
                   6841: }
1.795     www      6842: 
1.911     bisitz   6843: table.LC_prior_rank,
1.795     www      6844: table.LC_prior_match {
1.528     albertel 6845:   border-collapse: collapse;
                   6846: }
1.795     www      6847: 
1.528     albertel 6848: table.LC_prior_option tr td,
                   6849: table.LC_prior_rank tr td,
                   6850: table.LC_prior_match tr td {
1.524     albertel 6851:   border: 1px solid #000000;
1.515     albertel 6852: }
                   6853: 
1.855     bisitz   6854: .LC_nobreak {
1.544     albertel 6855:   white-space: nowrap;
1.519     raeburn  6856: }
                   6857: 
1.576     raeburn  6858: span.LC_cusr_emph {
                   6859:   font-style: italic;
                   6860: }
                   6861: 
1.633     raeburn  6862: span.LC_cusr_subheading {
                   6863:   font-weight: normal;
                   6864:   font-size: 85%;
                   6865: }
                   6866: 
1.861     bisitz   6867: div.LC_docs_entry_move {
1.859     bisitz   6868:   border: 1px solid #BBBBBB;
1.545     albertel 6869:   background: #DDDDDD;
1.861     bisitz   6870:   width: 22px;
1.859     bisitz   6871:   padding: 1px;
                   6872:   margin: 0;
1.545     albertel 6873: }
                   6874: 
1.861     bisitz   6875: table.LC_data_table tr > td.LC_docs_entry_commands,
                   6876: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 6877:   font-size: x-small;
                   6878: }
1.795     www      6879: 
1.861     bisitz   6880: .LC_docs_entry_parameter {
                   6881:   white-space: nowrap;
                   6882: }
                   6883: 
1.544     albertel 6884: .LC_docs_copy {
1.545     albertel 6885:   color: #000099;
1.544     albertel 6886: }
1.795     www      6887: 
1.544     albertel 6888: .LC_docs_cut {
1.545     albertel 6889:   color: #550044;
1.544     albertel 6890: }
1.795     www      6891: 
1.544     albertel 6892: .LC_docs_rename {
1.545     albertel 6893:   color: #009900;
1.544     albertel 6894: }
1.795     www      6895: 
1.544     albertel 6896: .LC_docs_remove {
1.545     albertel 6897:   color: #990000;
                   6898: }
                   6899: 
1.1075.2.134  raeburn  6900: .LC_domprefs_email,
1.547     albertel 6901: .LC_docs_reinit_warn,
                   6902: .LC_docs_ext_edit {
                   6903:   font-size: x-small;
                   6904: }
                   6905: 
1.545     albertel 6906: table.LC_docs_adddocs td,
                   6907: table.LC_docs_adddocs th {
                   6908:   border: 1px solid #BBBBBB;
                   6909:   padding: 4px;
                   6910:   background: #DDDDDD;
1.543     albertel 6911: }
                   6912: 
1.584     albertel 6913: table.LC_sty_begin {
                   6914:   background: #BBFFBB;
                   6915: }
1.795     www      6916: 
1.584     albertel 6917: table.LC_sty_end {
                   6918:   background: #FFBBBB;
                   6919: }
                   6920: 
1.589     raeburn  6921: table.LC_double_column {
1.803     bisitz   6922:   border-width: 0;
1.589     raeburn  6923:   border-collapse: collapse;
                   6924:   width: 100%;
                   6925:   padding: 2px;
                   6926: }
                   6927: 
                   6928: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  6929:   top: 2px;
1.589     raeburn  6930:   left: 2px;
                   6931:   width: 47%;
                   6932:   vertical-align: top;
                   6933: }
                   6934: 
                   6935: table.LC_double_column tr td.LC_right_col {
                   6936:   top: 2px;
1.779     bisitz   6937:   right: 2px;
1.589     raeburn  6938:   width: 47%;
                   6939:   vertical-align: top;
                   6940: }
                   6941: 
1.591     raeburn  6942: div.LC_left_float {
                   6943:   float: left;
                   6944:   padding-right: 5%;
1.597     albertel 6945:   padding-bottom: 4px;
1.591     raeburn  6946: }
                   6947: 
                   6948: div.LC_clear_float_header {
1.597     albertel 6949:   padding-bottom: 2px;
1.591     raeburn  6950: }
                   6951: 
                   6952: div.LC_clear_float_footer {
1.597     albertel 6953:   padding-top: 10px;
1.591     raeburn  6954:   clear: both;
                   6955: }
                   6956: 
1.597     albertel 6957: div.LC_grade_show_user {
1.941     bisitz   6958: /*  border-left: 5px solid $sidebg; */
                   6959:   border-top: 5px solid #000000;
                   6960:   margin: 50px 0 0 0;
1.936     bisitz   6961:   padding: 15px 0 5px 10px;
1.597     albertel 6962: }
1.795     www      6963: 
1.936     bisitz   6964: div.LC_grade_show_user_odd_row {
1.941     bisitz   6965: /*  border-left: 5px solid #000000; */
                   6966: }
                   6967: 
                   6968: div.LC_grade_show_user div.LC_Box {
                   6969:   margin-right: 50px;
1.597     albertel 6970: }
                   6971: 
                   6972: div.LC_grade_submissions,
                   6973: div.LC_grade_message_center,
1.936     bisitz   6974: div.LC_grade_info_links {
1.597     albertel 6975:   margin: 5px;
                   6976:   width: 99%;
                   6977:   background: #FFFFFF;
                   6978: }
1.795     www      6979: 
1.597     albertel 6980: div.LC_grade_submissions_header,
1.936     bisitz   6981: div.LC_grade_message_center_header {
1.705     tempelho 6982:   font-weight: bold;
                   6983:   font-size: large;
1.597     albertel 6984: }
1.795     www      6985: 
1.597     albertel 6986: div.LC_grade_submissions_body,
1.936     bisitz   6987: div.LC_grade_message_center_body {
1.597     albertel 6988:   border: 1px solid black;
                   6989:   width: 99%;
                   6990:   background: #FFFFFF;
                   6991: }
1.795     www      6992: 
1.613     albertel 6993: table.LC_scantron_action {
                   6994:   width: 100%;
                   6995: }
1.795     www      6996: 
1.613     albertel 6997: table.LC_scantron_action tr th {
1.698     harmsja  6998:   font-weight:bold;
                   6999:   font-style:normal;
1.613     albertel 7000: }
1.795     www      7001: 
1.779     bisitz   7002: .LC_edit_problem_header,
1.614     albertel 7003: div.LC_edit_problem_footer {
1.705     tempelho 7004:   font-weight: normal;
                   7005:   font-size:  medium;
1.602     albertel 7006:   margin: 2px;
1.1060    bisitz   7007:   background-color: $sidebg;
1.600     albertel 7008: }
1.795     www      7009: 
1.600     albertel 7010: div.LC_edit_problem_header,
1.602     albertel 7011: div.LC_edit_problem_header div,
1.614     albertel 7012: div.LC_edit_problem_footer,
                   7013: div.LC_edit_problem_footer div,
1.602     albertel 7014: div.LC_edit_problem_editxml_header,
                   7015: div.LC_edit_problem_editxml_header div {
1.1075.2.112  raeburn  7016:   z-index: 100;
1.600     albertel 7017: }
1.795     www      7018: 
1.600     albertel 7019: div.LC_edit_problem_header_title {
1.705     tempelho 7020:   font-weight: bold;
                   7021:   font-size: larger;
1.602     albertel 7022:   background: $tabbg;
                   7023:   padding: 3px;
1.1060    bisitz   7024:   margin: 0 0 5px 0;
1.602     albertel 7025: }
1.795     www      7026: 
1.602     albertel 7027: table.LC_edit_problem_header_title {
                   7028:   width: 100%;
1.600     albertel 7029:   background: $tabbg;
1.602     albertel 7030: }
                   7031: 
1.1075.2.112  raeburn  7032: div.LC_edit_actionbar {
                   7033:     background-color: $sidebg;
                   7034:     margin: 0;
                   7035:     padding: 0;
                   7036:     line-height: 200%;
1.602     albertel 7037: }
1.795     www      7038: 
1.1075.2.112  raeburn  7039: div.LC_edit_actionbar div{
                   7040:     padding: 0;
                   7041:     margin: 0;
                   7042:     display: inline-block;
1.600     albertel 7043: }
1.795     www      7044: 
1.1075.2.34  raeburn  7045: .LC_edit_opt {
                   7046:   padding-left: 1em;
                   7047:   white-space: nowrap;
                   7048: }
                   7049: 
1.1075.2.57  raeburn  7050: .LC_edit_problem_latexhelper{
                   7051:     text-align: right;
                   7052: }
                   7053: 
                   7054: #LC_edit_problem_colorful div{
                   7055:     margin-left: 40px;
                   7056: }
                   7057: 
1.1075.2.112  raeburn  7058: #LC_edit_problem_codemirror div{
                   7059:     margin-left: 0px;
                   7060: }
                   7061: 
1.911     bisitz   7062: img.stift {
1.803     bisitz   7063:   border-width: 0;
                   7064:   vertical-align: middle;
1.677     riegler  7065: }
1.680     riegler  7066: 
1.923     bisitz   7067: table td.LC_mainmenu_col_fieldset {
1.680     riegler  7068:   vertical-align: top;
1.777     tempelho 7069: }
1.795     www      7070: 
1.716     raeburn  7071: div.LC_createcourse {
1.911     bisitz   7072:   margin: 10px 10px 10px 10px;
1.716     raeburn  7073: }
                   7074: 
1.917     raeburn  7075: .LC_dccid {
1.1075.2.38  raeburn  7076:   float: right;
1.917     raeburn  7077:   margin: 0.2em 0 0 0;
                   7078:   padding: 0;
                   7079:   font-size: 90%;
                   7080:   display:none;
                   7081: }
                   7082: 
1.897     wenzelju 7083: ol.LC_primary_menu a:hover,
1.721     harmsja  7084: ol#LC_MenuBreadcrumbs a:hover,
                   7085: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 7086: ul#LC_secondary_menu a:hover,
1.721     harmsja  7087: .LC_FormSectionClearButton input:hover
1.795     www      7088: ul.LC_TabContent   li:hover a {
1.952     onken    7089:   color:$button_hover;
1.911     bisitz   7090:   text-decoration:none;
1.693     droeschl 7091: }
                   7092: 
1.779     bisitz   7093: h1 {
1.911     bisitz   7094:   padding: 0;
                   7095:   line-height:130%;
1.693     droeschl 7096: }
1.698     harmsja  7097: 
1.911     bisitz   7098: h2,
                   7099: h3,
                   7100: h4,
                   7101: h5,
                   7102: h6 {
                   7103:   margin: 5px 0 5px 0;
                   7104:   padding: 0;
                   7105:   line-height:130%;
1.693     droeschl 7106: }
1.795     www      7107: 
                   7108: .LC_hcell {
1.911     bisitz   7109:   padding:3px 15px 3px 15px;
                   7110:   margin: 0;
                   7111:   background-color:$tabbg;
                   7112:   color:$fontmenu;
                   7113:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 7114: }
1.795     www      7115: 
1.840     bisitz   7116: .LC_Box > .LC_hcell {
1.911     bisitz   7117:   margin: 0 -10px 10px -10px;
1.835     bisitz   7118: }
                   7119: 
1.721     harmsja  7120: .LC_noBorder {
1.911     bisitz   7121:   border: 0;
1.698     harmsja  7122: }
1.693     droeschl 7123: 
1.721     harmsja  7124: .LC_FormSectionClearButton input {
1.911     bisitz   7125:   background-color:transparent;
                   7126:   border: none;
                   7127:   cursor:pointer;
                   7128:   text-decoration:underline;
1.693     droeschl 7129: }
1.763     bisitz   7130: 
                   7131: .LC_help_open_topic {
1.911     bisitz   7132:   color: #FFFFFF;
                   7133:   background-color: #EEEEFF;
                   7134:   margin: 1px;
                   7135:   padding: 4px;
                   7136:   border: 1px solid #000033;
                   7137:   white-space: nowrap;
                   7138:   /* vertical-align: middle; */
1.759     neumanie 7139: }
1.693     droeschl 7140: 
1.911     bisitz   7141: dl,
                   7142: ul,
                   7143: div,
                   7144: fieldset {
                   7145:   margin: 10px 10px 10px 0;
                   7146:   /* overflow: hidden; */
1.693     droeschl 7147: }
1.795     www      7148: 
1.1075.2.90  raeburn  7149: article.geogebraweb div {
                   7150:     margin: 0;
                   7151: }
                   7152: 
1.838     bisitz   7153: fieldset > legend {
1.911     bisitz   7154:   font-weight: bold;
                   7155:   padding: 0 5px 0 5px;
1.838     bisitz   7156: }
                   7157: 
1.813     bisitz   7158: #LC_nav_bar {
1.911     bisitz   7159:   float: left;
1.995     raeburn  7160:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   7161:   margin: 0 0 2px 0;
1.807     droeschl 7162: }
                   7163: 
1.916     droeschl 7164: #LC_realm {
                   7165:   margin: 0.2em 0 0 0;
                   7166:   padding: 0;
                   7167:   font-weight: bold;
                   7168:   text-align: center;
1.995     raeburn  7169:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 7170: }
                   7171: 
1.911     bisitz   7172: #LC_nav_bar em {
                   7173:   font-weight: bold;
                   7174:   font-style: normal;
1.807     droeschl 7175: }
                   7176: 
1.897     wenzelju 7177: ol.LC_primary_menu {
1.934     droeschl 7178:   margin: 0;
1.1075.2.2  raeburn  7179:   padding: 0;
1.807     droeschl 7180: }
                   7181: 
1.852     droeschl 7182: ol#LC_PathBreadcrumbs {
1.911     bisitz   7183:   margin: 0;
1.693     droeschl 7184: }
                   7185: 
1.897     wenzelju 7186: ol.LC_primary_menu li {
1.1075.2.2  raeburn  7187:   color: RGB(80, 80, 80);
                   7188:   vertical-align: middle;
                   7189:   text-align: left;
                   7190:   list-style: none;
1.1075.2.112  raeburn  7191:   position: relative;
1.1075.2.2  raeburn  7192:   float: left;
1.1075.2.112  raeburn  7193:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   7194:   line-height: 1.5em;
1.1075.2.2  raeburn  7195: }
                   7196: 
1.1075.2.113  raeburn  7197: ol.LC_primary_menu li a, 
1.1075.2.112  raeburn  7198: ol.LC_primary_menu li p {
1.1075.2.2  raeburn  7199:   display: block;
                   7200:   margin: 0;
                   7201:   padding: 0 5px 0 10px;
                   7202:   text-decoration: none;
                   7203: }
                   7204: 
1.1075.2.112  raeburn  7205: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   7206:   display: inline-block;
                   7207:   width: 95%;
                   7208:   text-align: left;
                   7209: }
                   7210: 
                   7211: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   7212:   display: inline-block;
                   7213:   width: 5%;
                   7214:   float: right;
                   7215:   text-align: right;
                   7216:   font-size: 70%;
                   7217: }
                   7218: 
                   7219: ol.LC_primary_menu ul {
1.1075.2.2  raeburn  7220:   display: none;
1.1075.2.112  raeburn  7221:   width: 15em;
1.1075.2.2  raeburn  7222:   background-color: $data_table_light;
1.1075.2.112  raeburn  7223:   position: absolute;
                   7224:   top: 100%;
                   7225: }
                   7226: 
                   7227: ol.LC_primary_menu ul ul {
                   7228:   left: 100%;
                   7229:   top: 0;
1.1075.2.2  raeburn  7230: }
                   7231: 
1.1075.2.112  raeburn  7232: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1075.2.2  raeburn  7233:   display: block;
                   7234:   position: absolute;
                   7235:   margin: 0;
                   7236:   padding: 0;
1.1075.2.5  raeburn  7237:   z-index: 2;
1.1075.2.2  raeburn  7238: }
                   7239: 
                   7240: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1075.2.112  raeburn  7241: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1075.2.2  raeburn  7242:   font-size: 90%;
1.911     bisitz   7243:   vertical-align: top;
1.1075.2.2  raeburn  7244:   float: none;
1.1075.2.5  raeburn  7245:   border-left: 1px solid black;
                   7246:   border-right: 1px solid black;
1.1075.2.112  raeburn  7247: /* A dark bottom border to visualize different menu options;
                   7248: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   7249:   border-bottom: 1px solid $data_table_dark;
1.1075.2.2  raeburn  7250: }
                   7251: 
1.1075.2.112  raeburn  7252: ol.LC_primary_menu li li p:hover {
                   7253:   color:$button_hover;
                   7254:   text-decoration:none;
                   7255:   background-color:$data_table_dark;
1.1075.2.2  raeburn  7256: }
                   7257: 
                   7258: ol.LC_primary_menu li li a:hover {
                   7259:    color:$button_hover;
                   7260:    background-color:$data_table_dark;
1.693     droeschl 7261: }
                   7262: 
1.1075.2.112  raeburn  7263: /* Font-size equal to the size of the predecessors*/
                   7264: ol.LC_primary_menu li:hover li li {
                   7265:   font-size: 100%;
                   7266: }
                   7267: 
1.897     wenzelju 7268: ol.LC_primary_menu li img {
1.911     bisitz   7269:   vertical-align: bottom;
1.934     droeschl 7270:   height: 1.1em;
1.1075.2.3  raeburn  7271:   margin: 0.2em 0 0 0;
1.693     droeschl 7272: }
                   7273: 
1.897     wenzelju 7274: ol.LC_primary_menu a {
1.911     bisitz   7275:   color: RGB(80, 80, 80);
                   7276:   text-decoration: none;
1.693     droeschl 7277: }
1.795     www      7278: 
1.949     droeschl 7279: ol.LC_primary_menu a.LC_new_message {
                   7280:   font-weight:bold;
                   7281:   color: darkred;
                   7282: }
                   7283: 
1.975     raeburn  7284: ol.LC_docs_parameters {
                   7285:   margin-left: 0;
                   7286:   padding: 0;
                   7287:   list-style: none;
                   7288: }
                   7289: 
                   7290: ol.LC_docs_parameters li {
                   7291:   margin: 0;
                   7292:   padding-right: 20px;
                   7293:   display: inline;
                   7294: }
                   7295: 
1.976     raeburn  7296: ol.LC_docs_parameters li:before {
                   7297:   content: "\\002022 \\0020";
                   7298: }
                   7299: 
                   7300: li.LC_docs_parameters_title {
                   7301:   font-weight: bold;
                   7302: }
                   7303: 
                   7304: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   7305:   content: "";
                   7306: }
                   7307: 
1.897     wenzelju 7308: ul#LC_secondary_menu {
1.1075.2.23  raeburn  7309:   clear: right;
1.911     bisitz   7310:   color: $fontmenu;
                   7311:   background: $tabbg;
                   7312:   list-style: none;
                   7313:   padding: 0;
                   7314:   margin: 0;
                   7315:   width: 100%;
1.995     raeburn  7316:   text-align: left;
1.1075.2.4  raeburn  7317:   float: left;
1.808     droeschl 7318: }
                   7319: 
1.897     wenzelju 7320: ul#LC_secondary_menu li {
1.911     bisitz   7321:   font-weight: bold;
                   7322:   line-height: 1.8em;
                   7323:   border-right: 1px solid black;
1.1075.2.4  raeburn  7324:   float: left;
                   7325: }
                   7326: 
                   7327: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   7328:   background-color: $data_table_light;
                   7329: }
                   7330: 
                   7331: ul#LC_secondary_menu li a {
                   7332:   padding: 0 0.8em;
                   7333: }
                   7334: 
                   7335: ul#LC_secondary_menu li ul {
                   7336:   display: none;
                   7337: }
                   7338: 
                   7339: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   7340:   display: block;
                   7341:   position: absolute;
                   7342:   margin: 0;
                   7343:   padding: 0;
                   7344:   list-style:none;
                   7345:   float: none;
                   7346:   background-color: $data_table_light;
1.1075.2.5  raeburn  7347:   z-index: 2;
1.1075.2.10  raeburn  7348:   margin-left: -1px;
1.1075.2.4  raeburn  7349: }
                   7350: 
                   7351: ul#LC_secondary_menu li ul li {
                   7352:   font-size: 90%;
                   7353:   vertical-align: top;
                   7354:   border-left: 1px solid black;
                   7355:   border-right: 1px solid black;
1.1075.2.33  raeburn  7356:   background-color: $data_table_light;
1.1075.2.4  raeburn  7357:   list-style:none;
                   7358:   float: none;
                   7359: }
                   7360: 
                   7361: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   7362:   background-color: $data_table_dark;
1.807     droeschl 7363: }
                   7364: 
1.847     tempelho 7365: ul.LC_TabContent {
1.911     bisitz   7366:   display:block;
                   7367:   background: $sidebg;
                   7368:   border-bottom: solid 1px $lg_border_color;
                   7369:   list-style:none;
1.1020    raeburn  7370:   margin: -1px -10px 0 -10px;
1.911     bisitz   7371:   padding: 0;
1.693     droeschl 7372: }
                   7373: 
1.795     www      7374: ul.LC_TabContent li,
                   7375: ul.LC_TabContentBigger li {
1.911     bisitz   7376:   float:left;
1.741     harmsja  7377: }
1.795     www      7378: 
1.897     wenzelju 7379: ul#LC_secondary_menu li a {
1.911     bisitz   7380:   color: $fontmenu;
                   7381:   text-decoration: none;
1.693     droeschl 7382: }
1.795     www      7383: 
1.721     harmsja  7384: ul.LC_TabContent {
1.952     onken    7385:   min-height:20px;
1.721     harmsja  7386: }
1.795     www      7387: 
                   7388: ul.LC_TabContent li {
1.911     bisitz   7389:   vertical-align:middle;
1.959     onken    7390:   padding: 0 16px 0 10px;
1.911     bisitz   7391:   background-color:$tabbg;
                   7392:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  7393:   border-left: solid 1px $font;
1.721     harmsja  7394: }
1.795     www      7395: 
1.847     tempelho 7396: ul.LC_TabContent .right {
1.911     bisitz   7397:   float:right;
1.847     tempelho 7398: }
                   7399: 
1.911     bisitz   7400: ul.LC_TabContent li a,
                   7401: ul.LC_TabContent li {
                   7402:   color:rgb(47,47,47);
                   7403:   text-decoration:none;
                   7404:   font-size:95%;
                   7405:   font-weight:bold;
1.952     onken    7406:   min-height:20px;
                   7407: }
                   7408: 
1.959     onken    7409: ul.LC_TabContent li a:hover,
                   7410: ul.LC_TabContent li a:focus {
1.952     onken    7411:   color: $button_hover;
1.959     onken    7412:   background:none;
                   7413:   outline:none;
1.952     onken    7414: }
                   7415: 
                   7416: ul.LC_TabContent li:hover {
                   7417:   color: $button_hover;
                   7418:   cursor:pointer;
1.721     harmsja  7419: }
1.795     www      7420: 
1.911     bisitz   7421: ul.LC_TabContent li.active {
1.952     onken    7422:   color: $font;
1.911     bisitz   7423:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    7424:   border-bottom:solid 1px #FFFFFF;
                   7425:   cursor: default;
1.744     ehlerst  7426: }
1.795     www      7427: 
1.959     onken    7428: ul.LC_TabContent li.active a {
                   7429:   color:$font;
                   7430:   background:#FFFFFF;
                   7431:   outline: none;
                   7432: }
1.1047    raeburn  7433: 
                   7434: ul.LC_TabContent li.goback {
                   7435:   float: left;
                   7436:   border-left: none;
                   7437: }
                   7438: 
1.870     tempelho 7439: #maincoursedoc {
1.911     bisitz   7440:   clear:both;
1.870     tempelho 7441: }
                   7442: 
                   7443: ul.LC_TabContentBigger {
1.911     bisitz   7444:   display:block;
                   7445:   list-style:none;
                   7446:   padding: 0;
1.870     tempelho 7447: }
                   7448: 
1.795     www      7449: ul.LC_TabContentBigger li {
1.911     bisitz   7450:   vertical-align:bottom;
                   7451:   height: 30px;
                   7452:   font-size:110%;
                   7453:   font-weight:bold;
                   7454:   color: #737373;
1.841     tempelho 7455: }
                   7456: 
1.957     onken    7457: ul.LC_TabContentBigger li.active {
                   7458:   position: relative;
                   7459:   top: 1px;
                   7460: }
                   7461: 
1.870     tempelho 7462: ul.LC_TabContentBigger li a {
1.911     bisitz   7463:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   7464:   height: 30px;
                   7465:   line-height: 30px;
                   7466:   text-align: center;
                   7467:   display: block;
                   7468:   text-decoration: none;
1.958     onken    7469:   outline: none;  
1.741     harmsja  7470: }
1.795     www      7471: 
1.870     tempelho 7472: ul.LC_TabContentBigger li.active a {
1.911     bisitz   7473:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   7474:   color:$font;
1.744     ehlerst  7475: }
1.795     www      7476: 
1.870     tempelho 7477: ul.LC_TabContentBigger li b {
1.911     bisitz   7478:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   7479:   display: block;
                   7480:   float: left;
                   7481:   padding: 0 30px;
1.957     onken    7482:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 7483: }
                   7484: 
1.956     onken    7485: ul.LC_TabContentBigger li:hover b {
                   7486:   color:$button_hover;
                   7487: }
                   7488: 
1.870     tempelho 7489: ul.LC_TabContentBigger li.active b {
1.911     bisitz   7490:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   7491:   color:$font;
1.957     onken    7492:   border: 0;
1.741     harmsja  7493: }
1.693     droeschl 7494: 
1.870     tempelho 7495: 
1.862     bisitz   7496: ul.LC_CourseBreadcrumbs {
                   7497:   background: $sidebg;
1.1020    raeburn  7498:   height: 2em;
1.862     bisitz   7499:   padding-left: 10px;
1.1020    raeburn  7500:   margin: 0;
1.862     bisitz   7501:   list-style-position: inside;
                   7502: }
                   7503: 
1.911     bisitz   7504: ol#LC_MenuBreadcrumbs,
1.862     bisitz   7505: ol#LC_PathBreadcrumbs {
1.911     bisitz   7506:   padding-left: 10px;
                   7507:   margin: 0;
1.933     droeschl 7508:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 7509: }
                   7510: 
1.911     bisitz   7511: ol#LC_MenuBreadcrumbs li,
                   7512: ol#LC_PathBreadcrumbs li,
1.862     bisitz   7513: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   7514:   display: inline;
1.933     droeschl 7515:   white-space: normal;  
1.693     droeschl 7516: }
                   7517: 
1.823     bisitz   7518: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   7519: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   7520:   text-decoration: none;
                   7521:   font-size:90%;
1.693     droeschl 7522: }
1.795     www      7523: 
1.969     droeschl 7524: ol#LC_MenuBreadcrumbs h1 {
                   7525:   display: inline;
                   7526:   font-size: 90%;
                   7527:   line-height: 2.5em;
                   7528:   margin: 0;
                   7529:   padding: 0;
                   7530: }
                   7531: 
1.795     www      7532: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   7533:   text-decoration:none;
                   7534:   font-size:100%;
                   7535:   font-weight:bold;
1.693     droeschl 7536: }
1.795     www      7537: 
1.840     bisitz   7538: .LC_Box {
1.911     bisitz   7539:   border: solid 1px $lg_border_color;
                   7540:   padding: 0 10px 10px 10px;
1.746     neumanie 7541: }
1.795     www      7542: 
1.1020    raeburn  7543: .LC_DocsBox {
                   7544:   border: solid 1px $lg_border_color;
                   7545:   padding: 0 0 10px 10px;
                   7546: }
                   7547: 
1.795     www      7548: .LC_AboutMe_Image {
1.911     bisitz   7549:   float:left;
                   7550:   margin-right:10px;
1.747     neumanie 7551: }
1.795     www      7552: 
                   7553: .LC_Clear_AboutMe_Image {
1.911     bisitz   7554:   clear:left;
1.747     neumanie 7555: }
1.795     www      7556: 
1.721     harmsja  7557: dl.LC_ListStyleClean dt {
1.911     bisitz   7558:   padding-right: 5px;
                   7559:   display: table-header-group;
1.693     droeschl 7560: }
                   7561: 
1.721     harmsja  7562: dl.LC_ListStyleClean dd {
1.911     bisitz   7563:   display: table-row;
1.693     droeschl 7564: }
                   7565: 
1.721     harmsja  7566: .LC_ListStyleClean,
                   7567: .LC_ListStyleSimple,
                   7568: .LC_ListStyleNormal,
1.795     www      7569: .LC_ListStyleSpecial {
1.911     bisitz   7570:   /* display:block; */
                   7571:   list-style-position: inside;
                   7572:   list-style-type: none;
                   7573:   overflow: hidden;
                   7574:   padding: 0;
1.693     droeschl 7575: }
                   7576: 
1.721     harmsja  7577: .LC_ListStyleSimple li,
                   7578: .LC_ListStyleSimple dd,
                   7579: .LC_ListStyleNormal li,
                   7580: .LC_ListStyleNormal dd,
                   7581: .LC_ListStyleSpecial li,
1.795     www      7582: .LC_ListStyleSpecial dd {
1.911     bisitz   7583:   margin: 0;
                   7584:   padding: 5px 5px 5px 10px;
                   7585:   clear: both;
1.693     droeschl 7586: }
                   7587: 
1.721     harmsja  7588: .LC_ListStyleClean li,
                   7589: .LC_ListStyleClean dd {
1.911     bisitz   7590:   padding-top: 0;
                   7591:   padding-bottom: 0;
1.693     droeschl 7592: }
                   7593: 
1.721     harmsja  7594: .LC_ListStyleSimple dd,
1.795     www      7595: .LC_ListStyleSimple li {
1.911     bisitz   7596:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 7597: }
                   7598: 
1.721     harmsja  7599: .LC_ListStyleSpecial li,
                   7600: .LC_ListStyleSpecial dd {
1.911     bisitz   7601:   list-style-type: none;
                   7602:   background-color: RGB(220, 220, 220);
                   7603:   margin-bottom: 4px;
1.693     droeschl 7604: }
                   7605: 
1.721     harmsja  7606: table.LC_SimpleTable {
1.911     bisitz   7607:   margin:5px;
                   7608:   border:solid 1px $lg_border_color;
1.795     www      7609: }
1.693     droeschl 7610: 
1.721     harmsja  7611: table.LC_SimpleTable tr {
1.911     bisitz   7612:   padding: 0;
                   7613:   border:solid 1px $lg_border_color;
1.693     droeschl 7614: }
1.795     www      7615: 
                   7616: table.LC_SimpleTable thead {
1.911     bisitz   7617:   background:rgb(220,220,220);
1.693     droeschl 7618: }
                   7619: 
1.721     harmsja  7620: div.LC_columnSection {
1.911     bisitz   7621:   display: block;
                   7622:   clear: both;
                   7623:   overflow: hidden;
                   7624:   margin: 0;
1.693     droeschl 7625: }
                   7626: 
1.721     harmsja  7627: div.LC_columnSection>* {
1.911     bisitz   7628:   float: left;
                   7629:   margin: 10px 20px 10px 0;
                   7630:   overflow:hidden;
1.693     droeschl 7631: }
1.721     harmsja  7632: 
1.795     www      7633: table em {
1.911     bisitz   7634:   font-weight: bold;
                   7635:   font-style: normal;
1.748     schulted 7636: }
1.795     www      7637: 
1.779     bisitz   7638: table.LC_tableBrowseRes,
1.795     www      7639: table.LC_tableOfContent {
1.911     bisitz   7640:   border:none;
                   7641:   border-spacing: 1px;
                   7642:   padding: 3px;
                   7643:   background-color: #FFFFFF;
                   7644:   font-size: 90%;
1.753     droeschl 7645: }
1.789     droeschl 7646: 
1.911     bisitz   7647: table.LC_tableOfContent {
                   7648:   border-collapse: collapse;
1.789     droeschl 7649: }
                   7650: 
1.771     droeschl 7651: table.LC_tableBrowseRes a,
1.768     schulted 7652: table.LC_tableOfContent a {
1.911     bisitz   7653:   background-color: transparent;
                   7654:   text-decoration: none;
1.753     droeschl 7655: }
                   7656: 
1.795     www      7657: table.LC_tableOfContent img {
1.911     bisitz   7658:   border: none;
                   7659:   height: 1.3em;
                   7660:   vertical-align: text-bottom;
                   7661:   margin-right: 0.3em;
1.753     droeschl 7662: }
1.757     schulted 7663: 
1.795     www      7664: a#LC_content_toolbar_firsthomework {
1.911     bisitz   7665:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  7666: }
                   7667: 
1.795     www      7668: a#LC_content_toolbar_everything {
1.911     bisitz   7669:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  7670: }
                   7671: 
1.795     www      7672: a#LC_content_toolbar_uncompleted {
1.911     bisitz   7673:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  7674: }
                   7675: 
1.795     www      7676: #LC_content_toolbar_clearbubbles {
1.911     bisitz   7677:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  7678: }
                   7679: 
1.795     www      7680: a#LC_content_toolbar_changefolder {
1.911     bisitz   7681:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 7682: }
                   7683: 
1.795     www      7684: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   7685:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 7686: }
                   7687: 
1.1043    raeburn  7688: a#LC_content_toolbar_edittoplevel {
                   7689:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   7690: }
                   7691: 
1.795     www      7692: ul#LC_toolbar li a:hover {
1.911     bisitz   7693:   background-position: bottom center;
1.757     schulted 7694: }
                   7695: 
1.795     www      7696: ul#LC_toolbar {
1.911     bisitz   7697:   padding: 0;
                   7698:   margin: 2px;
                   7699:   list-style:none;
                   7700:   position:relative;
                   7701:   background-color:white;
1.1075.2.9  raeburn  7702:   overflow: auto;
1.757     schulted 7703: }
                   7704: 
1.795     www      7705: ul#LC_toolbar li {
1.911     bisitz   7706:   border:1px solid white;
                   7707:   padding: 0;
                   7708:   margin: 0;
                   7709:   float: left;
                   7710:   display:inline;
                   7711:   vertical-align:middle;
1.1075.2.9  raeburn  7712:   white-space: nowrap;
1.911     bisitz   7713: }
1.757     schulted 7714: 
1.783     amueller 7715: 
1.795     www      7716: a.LC_toolbarItem {
1.911     bisitz   7717:   display:block;
                   7718:   padding: 0;
                   7719:   margin: 0;
                   7720:   height: 32px;
                   7721:   width: 32px;
                   7722:   color:white;
                   7723:   border: none;
                   7724:   background-repeat:no-repeat;
                   7725:   background-color:transparent;
1.757     schulted 7726: }
                   7727: 
1.915     droeschl 7728: ul.LC_funclist {
                   7729:     margin: 0;
                   7730:     padding: 0.5em 1em 0.5em 0;
                   7731: }
                   7732: 
1.933     droeschl 7733: ul.LC_funclist > li:first-child {
                   7734:     font-weight:bold; 
                   7735:     margin-left:0.8em;
                   7736: }
                   7737: 
1.915     droeschl 7738: ul.LC_funclist + ul.LC_funclist {
                   7739:     /* 
                   7740:        left border as a seperator if we have more than
                   7741:        one list 
                   7742:     */
                   7743:     border-left: 1px solid $sidebg;
                   7744:     /* 
                   7745:        this hides the left border behind the border of the 
                   7746:        outer box if element is wrapped to the next 'line' 
                   7747:     */
                   7748:     margin-left: -1px;
                   7749: }
                   7750: 
1.843     bisitz   7751: ul.LC_funclist li {
1.915     droeschl 7752:   display: inline;
1.782     bisitz   7753:   white-space: nowrap;
1.915     droeschl 7754:   margin: 0 0 0 25px;
                   7755:   line-height: 150%;
1.782     bisitz   7756: }
                   7757: 
1.974     wenzelju 7758: .LC_hidden {
                   7759:   display: none;
                   7760: }
                   7761: 
1.1030    www      7762: .LCmodal-overlay {
                   7763: 		position:fixed;
                   7764: 		top:0;
                   7765: 		right:0;
                   7766: 		bottom:0;
                   7767: 		left:0;
                   7768: 		height:100%;
                   7769: 		width:100%;
                   7770: 		margin:0;
                   7771: 		padding:0;
                   7772: 		background:#999;
                   7773: 		opacity:.75;
                   7774: 		filter: alpha(opacity=75);
                   7775: 		-moz-opacity: 0.75;
                   7776: 		z-index:101;
                   7777: }
                   7778: 
                   7779: * html .LCmodal-overlay {   
                   7780: 		position: absolute;
                   7781: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   7782: }
                   7783: 
                   7784: .LCmodal-window {
                   7785: 		position:fixed;
                   7786: 		top:50%;
                   7787: 		left:50%;
                   7788: 		margin:0;
                   7789: 		padding:0;
                   7790: 		z-index:102;
                   7791: 	}
                   7792: 
                   7793: * html .LCmodal-window {
                   7794: 		position:absolute;
                   7795: }
                   7796: 
                   7797: .LCclose-window {
                   7798: 		position:absolute;
                   7799: 		width:32px;
                   7800: 		height:32px;
                   7801: 		right:8px;
                   7802: 		top:8px;
                   7803: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   7804: 		text-indent:-99999px;
                   7805: 		overflow:hidden;
                   7806: 		cursor:pointer;
                   7807: }
                   7808: 
1.1075.2.141  raeburn  7809: pre.LC_wordwrap {
                   7810:   white-space: pre-wrap;
                   7811:   white-space: -moz-pre-wrap;
                   7812:   white-space: -pre-wrap;
                   7813:   white-space: -o-pre-wrap;
                   7814:   word-wrap: break-word;
                   7815: }
                   7816: 
1.1075.2.17  raeburn  7817: /*
                   7818:   styles used by TTH when "Default set of options to pass to tth/m
                   7819:   when converting TeX" in course settings has been set
                   7820: 
                   7821:   option passed: -t
                   7822: 
                   7823: */
                   7824: 
                   7825: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   7826: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   7827: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   7828: td div.norm {line-height:normal;}
                   7829: 
                   7830: /*
                   7831:   option passed -y3
                   7832: */
                   7833: 
                   7834: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   7835: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   7836: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   7837: 
1.1075.2.121  raeburn  7838: #LC_minitab_header {
                   7839:   float:left;
                   7840:   width:100%;
                   7841:   background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
                   7842:   font-size:93%;
                   7843:   line-height:normal;
                   7844:   margin: 0.5em 0 0.5em 0;
                   7845: }
                   7846: #LC_minitab_header ul {
                   7847:   margin:0;
                   7848:   padding:10px 10px 0;
                   7849:   list-style:none;
                   7850: }
                   7851: #LC_minitab_header li {
                   7852:   float:left;
                   7853:   background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
                   7854:   margin:0;
                   7855:   padding:0 0 0 9px;
                   7856: }
                   7857: #LC_minitab_header a {
                   7858:   display:block;
                   7859:   background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
                   7860:   padding:5px 15px 4px 6px;
                   7861: }
                   7862: #LC_minitab_header #LC_current_minitab {
                   7863:   background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
                   7864: }
                   7865: #LC_minitab_header #LC_current_minitab a {
                   7866:   background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
                   7867:   padding-bottom:5px;
                   7868: }
                   7869: 
                   7870: 
1.343     albertel 7871: END
                   7872: }
                   7873: 
1.306     albertel 7874: =pod
                   7875: 
                   7876: =item * &headtag()
                   7877: 
                   7878: Returns a uniform footer for LON-CAPA web pages.
                   7879: 
1.307     albertel 7880: Inputs: $title - optional title for the head
                   7881:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 7882:         $args - optional arguments
1.319     albertel 7883:             force_register - if is true call registerurl so the remote is 
                   7884:                              informed
1.415     albertel 7885:             redirect       -> array ref of
                   7886:                                    1- seconds before redirect occurs
                   7887:                                    2- url to redirect to
                   7888:                                    3- whether the side effect should occur
1.315     albertel 7889:                            (side effect of setting 
                   7890:                                $env{'internal.head.redirect'} to the url 
                   7891:                                redirected too)
1.352     albertel 7892:             domain         -> force to color decorate a page for a specific
                   7893:                                domain
                   7894:             function       -> force usage of a specific rolish color scheme
                   7895:             bgcolor        -> override the default page bgcolor
1.460     albertel 7896:             no_auto_mt_title
                   7897:                            -> prevent &mt()ing the title arg
1.464     albertel 7898: 
1.306     albertel 7899: =cut
                   7900: 
                   7901: sub headtag {
1.313     albertel 7902:     my ($title,$head_extra,$args) = @_;
1.306     albertel 7903:     
1.363     albertel 7904:     my $function = $args->{'function'} || &get_users_function();
                   7905:     my $domain   = $args->{'domain'}   || &determinedomain();
                   7906:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1075.2.52  raeburn  7907:     my $httphost = $args->{'use_absolute'};
1.418     albertel 7908:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 7909: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 7910: 		   #time(),
1.418     albertel 7911: 		   $env{'environment.color.timestamp'},
1.363     albertel 7912: 		   $function,$domain,$bgcolor);
                   7913: 
1.369     www      7914:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 7915: 
1.308     albertel 7916:     my $result =
                   7917: 	'<head>'.
1.1075.2.56  raeburn  7918: 	&font_settings($args);
1.319     albertel 7919: 
1.1075.2.72  raeburn  7920:     my $inhibitprint;
                   7921:     if ($args->{'print_suppress'}) {
                   7922:         $inhibitprint = &print_suppression();
                   7923:     }
1.1064    raeburn  7924: 
1.461     albertel 7925:     if (!$args->{'frameset'}) {
                   7926: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   7927:     }
1.1075.2.12  raeburn  7928:     if ($args->{'force_register'}) {
                   7929:         $result .= &Apache::lonmenu::registerurl(1);
1.319     albertel 7930:     }
1.436     albertel 7931:     if (!$args->{'no_nav_bar'} 
                   7932: 	&& !$args->{'only_body'}
                   7933: 	&& !$args->{'frameset'}) {
1.1075.2.52  raeburn  7934: 	$result .= &help_menu_js($httphost);
1.1032    www      7935:         $result.=&modal_window();
1.1038    www      7936:         $result.=&togglebox_script();
1.1034    www      7937:         $result.=&wishlist_window();
1.1041    www      7938:         $result.=&LCprogressbarUpdate_script();
1.1034    www      7939:     } else {
                   7940:         if ($args->{'add_modal'}) {
                   7941:            $result.=&modal_window();
                   7942:         }
                   7943:         if ($args->{'add_wishlist'}) {
                   7944:            $result.=&wishlist_window();
                   7945:         }
1.1038    www      7946:         if ($args->{'add_togglebox'}) {
                   7947:            $result.=&togglebox_script();
                   7948:         }
1.1041    www      7949:         if ($args->{'add_progressbar'}) {
                   7950:            $result.=&LCprogressbarUpdate_script();
                   7951:         }
1.436     albertel 7952:     }
1.314     albertel 7953:     if (ref($args->{'redirect'})) {
1.414     albertel 7954: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 7955: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 7956: 	if (!$inhibit_continue) {
                   7957: 	    $env{'internal.head.redirect'} = $url;
                   7958: 	}
1.313     albertel 7959: 	$result.=<<ADDMETA
                   7960: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 7961: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 7962: ADDMETA
1.1075.2.89  raeburn  7963:     } else {
                   7964:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
                   7965:             my $requrl = $env{'request.uri'};
                   7966:             if ($requrl eq '') {
                   7967:                 $requrl = $ENV{'REQUEST_URI'};
                   7968:                 $requrl =~ s/\?.+$//;
                   7969:             }
                   7970:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
                   7971:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
                   7972:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
                   7973:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
                   7974:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
                   7975:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1075.2.141.  .4(raebu 7976:20):                     my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   7977:20):                     my $offload;
1.1075.2.89  raeburn  7978:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
                   7979:                         if ($domdefs{'offloadnow'}{$lonhost}) {
1.1075.2.141.  .4(raebu 7980:20):                             $offload = 1;
                   7981:20):                         }
                   7982:20):                     }
                   7983:20):                     unless ($offload) {
                   7984:20):                         if (ref($domdefs{'offloadoth'}) eq 'HASH') {
                   7985:20):                             if ($domdefs{'offloadoth'}{$lonhost}) {
                   7986:20):                                 if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   7987:20):                                     (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   7988:20):                                     unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   7989:20):                                         $offload = 1;
                   7990:20):                                         $dom_in_use = $env{'user.domain'};
                   7991:20):                                     }
1.1075.2.89  raeburn  7992:                                 }
1.1075.2.141.  .4(raebu 7993:20):                             }
                   7994:20):                         }
                   7995:20):                     }
                   7996:20):                     if ($offload) {
                   7997:20):                         my $newserver = &Apache::lonnet::spareserver(30000,undef,1,$dom_in_use);
                   7998:20):                         if (($newserver) && ($newserver ne $lonhost)) {
                   7999:20):                             my $numsec = 5;
                   8000:20):                             my $timeout = $numsec * 1000;
                   8001:20):                             my ($newurl,$locknum,%locks,$msg);
                   8002:20):                             if ($env{'request.role.adv'}) {
                   8003:20):                                 ($locknum,%locks) = &Apache::lonnet::get_locks();
                   8004:20):                             }
                   8005:20):                             my $disable_submit = 0;
                   8006:20):                             if ($requrl =~ /$LONCAPA::assess_re/) {
                   8007:20):                                 $disable_submit = 1;
                   8008:20):                             }
                   8009:20):                             if ($locknum) {
                   8010:20):                                 my @lockinfo = sort(values(%locks));
                   8011:20):                                 $msg = &mt('Once the following tasks are complete: ')."\n".
                   8012:20):                                        join(", ",sort(values(%locks)))."\n";
                   8013:20):                                 if (&show_course()) {
                   8014:20):                                     $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
1.1075.2.89  raeburn  8015:                                 } else {
1.1075.2.141.  .4(raebu 8016:20):                                     $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
                   8017:20):                                 }
                   8018:20):                             } else {
                   8019:20):                                 if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
                   8020:20):                                     $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
                   8021:20):                                 }
                   8022:20):                                 $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
                   8023:20):                                 $newurl = '/adm/switchserver?otherserver='.$newserver;
                   8024:20):                                 if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
                   8025:20):                                     $newurl .= '&role='.$env{'request.role'};
                   8026:20):                                 }
                   8027:20):                                 if ($env{'request.symb'}) {
                   8028:20):                                     my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
                   8029:20):                                     if ($shownsymb =~ m{^/enc/}) {
                   8030:20):                                         my $reqdmajor = 2;
                   8031:20):                                         my $reqdminor = 11;
                   8032:20):                                         my $reqdsubminor = 3;
                   8033:20):                                         my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
                   8034:20):                                         my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
                   8035:20):                                         my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
                   8036:20):                                         if (($major eq '' && $minor eq '') ||
                   8037:20):                                             (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
                   8038:20):                                             (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
                   8039:20):                                              ($reqdsubminor > $subminor))))) {
                   8040:20):                                             undef($shownsymb);
                   8041:20):                                         }
1.1075.2.89  raeburn  8042:                                     }
1.1075.2.141.  .4(raebu 8043:20):                                     if ($shownsymb) {
                   8044:20):                                         &js_escape(\$shownsymb);
                   8045:20):                                         $newurl .= '&symb='.$shownsymb;
1.1075.2.89  raeburn  8046:                                     }
1.1075.2.141.  .4(raebu 8047:20):                                 } else {
                   8048:20):                                     my $shownurl = &Apache::lonenc::check_encrypt($requrl);
                   8049:20):                                     &js_escape(\$shownurl);
                   8050:20):                                     $newurl .= '&origurl='.$shownurl;
1.1075.2.89  raeburn  8051:                                 }
1.1075.2.141.  .4(raebu 8052:20):                             }
                   8053:20):                             &js_escape(\$msg);
                   8054:20):                             $result.=<<OFFLOAD
1.1075.2.89  raeburn  8055: <meta http-equiv="pragma" content="no-cache" />
                   8056: <script type="text/javascript">
1.1075.2.92  raeburn  8057: // <![CDATA[
1.1075.2.89  raeburn  8058: function LC_Offload_Now() {
                   8059:     var dest = "$newurl";
                   8060:     if (dest != '') {
                   8061:         window.location.href="$newurl";
                   8062:     }
                   8063: }
1.1075.2.92  raeburn  8064: \$(document).ready(function () {
                   8065:     window.alert('$msg');
                   8066:     if ($disable_submit) {
1.1075.2.89  raeburn  8067:         \$(".LC_hwk_submit").prop("disabled", true);
                   8068:         \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1075.2.92  raeburn  8069:     }
                   8070:     setTimeout('LC_Offload_Now()', $timeout);
                   8071: });
                   8072: // ]]>
1.1075.2.89  raeburn  8073: </script>
                   8074: OFFLOAD
                   8075:                         }
                   8076:                     }
                   8077:                 }
                   8078:             }
                   8079:         }
1.313     albertel 8080:     }
1.306     albertel 8081:     if (!defined($title)) {
                   8082: 	$title = 'The LearningOnline Network with CAPA';
                   8083:     }
1.460     albertel 8084:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   8085:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.1075.2.61  raeburn  8086: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'"';
                   8087:     if (!$args->{'frameset'}) {
                   8088:         $result .= ' /';
                   8089:     }
                   8090:     $result .= '>'
1.1064    raeburn  8091:         .$inhibitprint
1.414     albertel 8092: 	.$head_extra;
1.1075.2.108  raeburn  8093:     my $clientmobile;
                   8094:     if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   8095:         (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
                   8096:     } else {
                   8097:         $clientmobile = $env{'browser.mobile'};
                   8098:     }
                   8099:     if ($clientmobile) {
1.1075.2.42  raeburn  8100:         $result .= '
                   8101: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
                   8102: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   8103:     }
1.1075.2.126  raeburn  8104:     $result .= '<meta name="google" content="notranslate" />'."\n";
1.962     droeschl 8105:     return $result.'</head>';
1.306     albertel 8106: }
                   8107: 
                   8108: =pod
                   8109: 
1.340     albertel 8110: =item * &font_settings()
                   8111: 
                   8112: Returns neccessary <meta> to set the proper encoding
                   8113: 
1.1075.2.56  raeburn  8114: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 8115: 
                   8116: =cut
                   8117: 
                   8118: sub font_settings {
1.1075.2.56  raeburn  8119:     my ($args) = @_;
1.340     albertel 8120:     my $headerstring='';
1.1075.2.56  raeburn  8121:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   8122:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.340     albertel 8123: 	$headerstring.=
1.1075.2.61  raeburn  8124: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   8125:         if (!$args->{'frameset'}) {
                   8126:             $headerstring.= ' /';
                   8127:         }
                   8128:         $headerstring .= '>'."\n";
1.340     albertel 8129:     }
                   8130:     return $headerstring;
                   8131: }
                   8132: 
1.341     albertel 8133: =pod
                   8134: 
1.1064    raeburn  8135: =item * &print_suppression()
                   8136: 
                   8137: In course context returns css which causes the body to be blank when media="print",
                   8138: if printout generation is unavailable for the current resource.
                   8139: 
                   8140: This could be because:
                   8141: 
                   8142: (a) printstartdate is in the future
                   8143: 
                   8144: (b) printenddate is in the past
                   8145: 
                   8146: (c) there is an active exam block with "printout"
                   8147: functionality blocked
                   8148: 
                   8149: Users with pav, pfo or evb privileges are exempt.
                   8150: 
                   8151: Inputs: none
                   8152: 
                   8153: =cut
                   8154: 
                   8155: 
                   8156: sub print_suppression {
                   8157:     my $noprint;
                   8158:     if ($env{'request.course.id'}) {
                   8159:         my $scope = $env{'request.course.id'};
                   8160:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8161:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   8162:             return;
                   8163:         }
                   8164:         if ($env{'request.course.sec'} ne '') {
                   8165:             $scope .= "/$env{'request.course.sec'}";
                   8166:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8167:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  8168:                 return;
1.1064    raeburn  8169:             }
                   8170:         }
                   8171:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8172:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.73  raeburn  8173:         my $blocked = &blocking_status('printout',$cnum,$cdom,undef,1);
1.1064    raeburn  8174:         if ($blocked) {
                   8175:             my $checkrole = "cm./$cdom/$cnum";
                   8176:             if ($env{'request.course.sec'} ne '') {
                   8177:                 $checkrole .= "/$env{'request.course.sec'}";
                   8178:             }
                   8179:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   8180:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   8181:                 $noprint = 1;
                   8182:             }
                   8183:         }
                   8184:         unless ($noprint) {
                   8185:             my $symb = &Apache::lonnet::symbread();
                   8186:             if ($symb ne '') {
                   8187:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   8188:                 if (ref($navmap)) {
                   8189:                     my $res = $navmap->getBySymb($symb);
                   8190:                     if (ref($res)) {
                   8191:                         if (!$res->resprintable()) {
                   8192:                             $noprint = 1;
                   8193:                         }
                   8194:                     }
                   8195:                 }
                   8196:             }
                   8197:         }
                   8198:         if ($noprint) {
                   8199:             return <<"ENDSTYLE";
                   8200: <style type="text/css" media="print">
                   8201:     body { display:none }
                   8202: </style>
                   8203: ENDSTYLE
                   8204:         }
                   8205:     }
                   8206:     return;
                   8207: }
                   8208: 
                   8209: =pod
                   8210: 
1.341     albertel 8211: =item * &xml_begin()
                   8212: 
                   8213: Returns the needed doctype and <html>
                   8214: 
                   8215: Inputs: none
                   8216: 
                   8217: =cut
                   8218: 
                   8219: sub xml_begin {
1.1075.2.61  raeburn  8220:     my ($is_frameset) = @_;
1.341     albertel 8221:     my $output='';
                   8222: 
                   8223:     if ($env{'browser.mathml'}) {
                   8224: 	$output='<?xml version="1.0"?>'
                   8225:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   8226: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   8227:             
                   8228: #	    .'<!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">] >'
                   8229: 	    .'<!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">'
                   8230:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   8231: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1075.2.61  raeburn  8232:     } elsif ($is_frameset) {
                   8233:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
                   8234:                 '<html>'."\n";
1.341     albertel 8235:     } else {
1.1075.2.61  raeburn  8236: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   8237:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 8238:     }
                   8239:     return $output;
                   8240: }
1.340     albertel 8241: 
                   8242: =pod
                   8243: 
1.306     albertel 8244: =item * &start_page()
                   8245: 
                   8246: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   8247: 
1.648     raeburn  8248: Inputs:
                   8249: 
                   8250: =over 4
                   8251: 
                   8252: $title - optional title for the page
                   8253: 
                   8254: $head_extra - optional extra HTML to incude inside the <head>
                   8255: 
                   8256: $args - additional optional args supported are:
                   8257: 
                   8258: =over 8
                   8259: 
                   8260:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 8261:                                     arg on
1.814     bisitz   8262:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  8263:              add_entries    -> additional attributes to add to the  <body>
                   8264:              domain         -> force to color decorate a page for a 
1.317     albertel 8265:                                     specific domain
1.648     raeburn  8266:              function       -> force usage of a specific rolish color
1.317     albertel 8267:                                     scheme
1.648     raeburn  8268:              redirect       -> see &headtag()
                   8269:              bgcolor        -> override the default page bg color
                   8270:              js_ready       -> return a string ready for being used in 
1.317     albertel 8271:                                     a javascript writeln
1.648     raeburn  8272:              html_encode    -> return a string ready for being used in 
1.320     albertel 8273:                                     a html attribute
1.648     raeburn  8274:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 8275:                                     $forcereg arg
1.648     raeburn  8276:              frameset       -> if true will start with a <frameset>
1.330     albertel 8277:                                     rather than <body>
1.648     raeburn  8278:              skip_phases    -> hash ref of 
1.338     albertel 8279:                                     head -> skip the <html><head> generation
                   8280:                                     body -> skip all <body> generation
1.1075.2.12  raeburn  8281:              no_inline_link -> if true and in remote mode, don't show the
                   8282:                                     'Switch To Inline Menu' link
1.648     raeburn  8283:              no_auto_mt_title -> prevent &mt()ing the title arg
1.867     kalberla 8284:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  8285:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1075.2.123  raeburn  8286:              bread_crumbs_nomenu -> if true will pass false as the value of $menulink
                   8287:                                     to lonhtmlcommon::breadcrumbs
1.1075.2.15  raeburn  8288:              group          -> includes the current group, if page is for a
                   8289:                                specific group
1.1075.2.133  raeburn  8290:              use_absolute   -> for request for external resource or syllabus, this
                   8291:                                will contain https://<hostname> if server uses
                   8292:                                https (as per hosts.tab), but request is for http
                   8293:              hostname       -> hostname, originally from $r->hostname(), (optional).
1.361     albertel 8294: 
1.648     raeburn  8295: =back
1.460     albertel 8296: 
1.648     raeburn  8297: =back
1.562     albertel 8298: 
1.306     albertel 8299: =cut
                   8300: 
                   8301: sub start_page {
1.309     albertel 8302:     my ($title,$head_extra,$args) = @_;
1.318     albertel 8303:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 8304: 
1.315     albertel 8305:     $env{'internal.start_page'}++;
1.1075.2.15  raeburn  8306:     my ($result,@advtools);
1.964     droeschl 8307: 
1.338     albertel 8308:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1075.2.62  raeburn  8309:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 8310:     }
                   8311:     
                   8312:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   8313: 	if ($args->{'frameset'}) {
                   8314: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   8315: 						$args->{'add_entries'});
                   8316: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   8317:         } else {
                   8318:             $result .=
                   8319:                 &bodytag($title, 
                   8320:                          $args->{'function'},       $args->{'add_entries'},
                   8321:                          $args->{'only_body'},      $args->{'domain'},
                   8322:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12  raeburn  8323:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
1.1075.2.15  raeburn  8324:                          $args,                     \@advtools);
1.831     bisitz   8325:         }
1.330     albertel 8326:     }
1.338     albertel 8327: 
1.315     albertel 8328:     if ($args->{'js_ready'}) {
1.713     kaisler  8329: 		$result = &js_ready($result);
1.315     albertel 8330:     }
1.320     albertel 8331:     if ($args->{'html_encode'}) {
1.713     kaisler  8332: 		$result = &html_encode($result);
                   8333:     }
                   8334: 
1.813     bisitz   8335:     # Preparation for new and consistent functionlist at top of screen
                   8336:     # if ($args->{'functionlist'}) {
                   8337:     #            $result .= &build_functionlist();
                   8338:     #}
                   8339: 
1.964     droeschl 8340:     # Don't add anything more if only_body wanted or in const space
                   8341:     return $result if    $args->{'only_body'} 
                   8342:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   8343: 
                   8344:     #Breadcrumbs
1.758     kaisler  8345:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   8346: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   8347: 		#if any br links exists, add them to the breadcrumbs
                   8348: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   8349: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   8350: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   8351: 			}
                   8352: 		}
1.1075.2.19  raeburn  8353:                 # if @advtools array contains items add then to the breadcrumbs
                   8354:                 if (@advtools > 0) {
                   8355:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   8356:                 }
1.1075.2.123  raeburn  8357:                 my $menulink;
                   8358:                 # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
                   8359:                 if (exists($args->{'bread_crumbs_nomenu'})) {
                   8360:                     $menulink = 0;
                   8361:                 } else {
                   8362:                     undef($menulink);
                   8363:                 }
1.758     kaisler  8364: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   8365: 		if(exists($args->{'bread_crumbs_component'})){
1.1075.2.123  raeburn  8366: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.758     kaisler  8367: 		}else{
1.1075.2.123  raeburn  8368: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758     kaisler  8369: 		}
1.1075.2.24  raeburn  8370:     } elsif (($env{'environment.remote'} eq 'on') &&
                   8371:              ($env{'form.inhibitmenu'} ne 'yes') &&
                   8372:              ($env{'request.noversionuri'} =~ m{^/res/}) &&
                   8373:              ($env{'request.noversionuri'} !~ m{^/res/adm/pages/})) {
1.1075.2.21  raeburn  8374:         $result .= '<div style="padding:0;margin:0;clear:both"><hr /></div>';
1.320     albertel 8375:     }
1.315     albertel 8376:     return $result;
1.306     albertel 8377: }
                   8378: 
                   8379: sub end_page {
1.315     albertel 8380:     my ($args) = @_;
                   8381:     $env{'internal.end_page'}++;
1.330     albertel 8382:     my $result;
1.335     albertel 8383:     if ($args->{'discussion'}) {
                   8384: 	my ($target,$parser);
                   8385: 	if (ref($args->{'discussion'})) {
                   8386: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   8387: 				$args->{'discussion'}{'parser'});
                   8388: 	}
                   8389: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   8390:     }
1.330     albertel 8391:     if ($args->{'frameset'}) {
                   8392: 	$result .= '</frameset>';
                   8393:     } else {
1.635     raeburn  8394: 	$result .= &endbodytag($args);
1.330     albertel 8395:     }
1.1075.2.6  raeburn  8396:     unless ($args->{'notbody'}) {
                   8397:         $result .= "\n</html>";
                   8398:     }
1.330     albertel 8399: 
1.315     albertel 8400:     if ($args->{'js_ready'}) {
1.317     albertel 8401: 	$result = &js_ready($result);
1.315     albertel 8402:     }
1.335     albertel 8403: 
1.320     albertel 8404:     if ($args->{'html_encode'}) {
                   8405: 	$result = &html_encode($result);
                   8406:     }
1.335     albertel 8407: 
1.315     albertel 8408:     return $result;
                   8409: }
                   8410: 
1.1034    www      8411: sub wishlist_window {
                   8412:     return(<<'ENDWISHLIST');
1.1046    raeburn  8413: <script type="text/javascript">
1.1034    www      8414: // <![CDATA[
                   8415: // <!-- BEGIN LON-CAPA Internal
                   8416: function set_wishlistlink(title, path) {
                   8417:     if (!title) {
                   8418:         title = document.title;
                   8419:         title = title.replace(/^LON-CAPA /,'');
                   8420:     }
1.1075.2.65  raeburn  8421:     title = encodeURIComponent(title);
1.1075.2.83  raeburn  8422:     title = title.replace("'","\\\'");
1.1034    www      8423:     if (!path) {
                   8424:         path = location.pathname;
                   8425:     }
1.1075.2.65  raeburn  8426:     path = encodeURIComponent(path);
1.1075.2.83  raeburn  8427:     path = path.replace("'","\\\'");
1.1034    www      8428:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   8429:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   8430: }
                   8431: // END LON-CAPA Internal -->
                   8432: // ]]>
                   8433: </script>
                   8434: ENDWISHLIST
                   8435: }
                   8436: 
1.1030    www      8437: sub modal_window {
                   8438:     return(<<'ENDMODAL');
1.1046    raeburn  8439: <script type="text/javascript">
1.1030    www      8440: // <![CDATA[
                   8441: // <!-- BEGIN LON-CAPA Internal
                   8442: var modalWindow = {
                   8443: 	parent:"body",
                   8444: 	windowId:null,
                   8445: 	content:null,
                   8446: 	width:null,
                   8447: 	height:null,
                   8448: 	close:function()
                   8449: 	{
                   8450: 	        $(".LCmodal-window").remove();
                   8451: 	        $(".LCmodal-overlay").remove();
                   8452: 	},
                   8453: 	open:function()
                   8454: 	{
                   8455: 		var modal = "";
                   8456: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   8457: 		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;\">";
                   8458: 		modal += this.content;
                   8459: 		modal += "</div>";	
                   8460: 
                   8461: 		$(this.parent).append(modal);
                   8462: 
                   8463: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   8464: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   8465: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   8466: 	}
                   8467: };
1.1075.2.42  raeburn  8468: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      8469: 	{
1.1075.2.119  raeburn  8470:                 source = source.replace(/'/g,"&#39;");
1.1030    www      8471: 		modalWindow.windowId = "myModal";
                   8472: 		modalWindow.width = width;
                   8473: 		modalWindow.height = height;
1.1075.2.80  raeburn  8474: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      8475: 		modalWindow.open();
1.1075.2.87  raeburn  8476: 	};
1.1030    www      8477: // END LON-CAPA Internal -->
                   8478: // ]]>
                   8479: </script>
                   8480: ENDMODAL
                   8481: }
                   8482: 
                   8483: sub modal_link {
1.1075.2.42  raeburn  8484:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      8485:     unless ($width) { $width=480; }
                   8486:     unless ($height) { $height=400; }
1.1031    www      8487:     unless ($scrolling) { $scrolling='yes'; }
1.1075.2.42  raeburn  8488:     unless ($transparency) { $transparency='true'; }
                   8489: 
1.1074    raeburn  8490:     my $target_attr;
                   8491:     if (defined($target)) {
                   8492:         $target_attr = 'target="'.$target.'"';
                   8493:     }
                   8494:     return <<"ENDLINK";
1.1075.2.141.  .3(raebu 8495:20): <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074    raeburn  8496: ENDLINK
1.1030    www      8497: }
                   8498: 
1.1032    www      8499: sub modal_adhoc_script {
                   8500:     my ($funcname,$width,$height,$content)=@_;
                   8501:     return (<<ENDADHOC);
1.1046    raeburn  8502: <script type="text/javascript">
1.1032    www      8503: // <![CDATA[
                   8504:         var $funcname = function()
                   8505:         {
                   8506:                 modalWindow.windowId = "myModal";
                   8507:                 modalWindow.width = $width;
                   8508:                 modalWindow.height = $height;
                   8509:                 modalWindow.content = '$content';
                   8510:                 modalWindow.open();
                   8511:         };  
                   8512: // ]]>
                   8513: </script>
                   8514: ENDADHOC
                   8515: }
                   8516: 
1.1041    www      8517: sub modal_adhoc_inner {
                   8518:     my ($funcname,$width,$height,$content)=@_;
                   8519:     my $innerwidth=$width-20;
                   8520:     $content=&js_ready(
1.1042    www      8521:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1075.2.42  raeburn  8522:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   8523:                  $content.
1.1041    www      8524:                  &end_scrollbox().
1.1075.2.42  raeburn  8525:                  &end_page()
1.1041    www      8526:              );
                   8527:     return &modal_adhoc_script($funcname,$width,$height,$content);
                   8528: }
                   8529: 
                   8530: sub modal_adhoc_window {
                   8531:     my ($funcname,$width,$height,$content,$linktext)=@_;
                   8532:     return &modal_adhoc_inner($funcname,$width,$height,$content).
                   8533:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   8534: }
                   8535: 
                   8536: sub modal_adhoc_launch {
                   8537:     my ($funcname,$width,$height,$content)=@_;
                   8538:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   8539: <script type="text/javascript">
                   8540: // <![CDATA[
                   8541: $funcname();
                   8542: // ]]>
                   8543: </script>
                   8544: ENDLAUNCH
                   8545: }
                   8546: 
                   8547: sub modal_adhoc_close {
                   8548:     return (<<ENDCLOSE);
                   8549: <script type="text/javascript">
                   8550: // <![CDATA[
                   8551: modalWindow.close();
                   8552: // ]]>
                   8553: </script>
                   8554: ENDCLOSE
                   8555: }
                   8556: 
1.1038    www      8557: sub togglebox_script {
                   8558:    return(<<ENDTOGGLE);
                   8559: <script type="text/javascript"> 
                   8560: // <![CDATA[
                   8561: function LCtoggleDisplay(id,hidetext,showtext) {
                   8562:    link = document.getElementById(id + "link").childNodes[0];
                   8563:    with (document.getElementById(id).style) {
                   8564:       if (display == "none" ) {
                   8565:           display = "inline";
                   8566:           link.nodeValue = hidetext;
                   8567:         } else {
                   8568:           display = "none";
                   8569:           link.nodeValue = showtext;
                   8570:        }
                   8571:    }
                   8572: }
                   8573: // ]]>
                   8574: </script>
                   8575: ENDTOGGLE
                   8576: }
                   8577: 
1.1039    www      8578: sub start_togglebox {
                   8579:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   8580:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   8581:     unless ($showtext) { $showtext=&mt('show'); }
                   8582:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   8583:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   8584:     return &start_data_table().
                   8585:            &start_data_table_header_row().
                   8586:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   8587:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   8588:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   8589:            &end_data_table_header_row().
                   8590:            '<tr id="'.$id.'" style="display:none""><td>';
                   8591: }
                   8592: 
                   8593: sub end_togglebox {
                   8594:     return '</td></tr>'.&end_data_table();
                   8595: }
                   8596: 
1.1041    www      8597: sub LCprogressbar_script {
1.1075.2.130  raeburn  8598:    my ($id,$number_to_do)=@_;
                   8599:    if ($number_to_do) {
                   8600:        return(<<ENDPROGRESS);
1.1041    www      8601: <script type="text/javascript">
                   8602: // <![CDATA[
1.1045    www      8603: \$('#progressbar$id').progressbar({
1.1041    www      8604:   value: 0,
                   8605:   change: function(event, ui) {
                   8606:     var newVal = \$(this).progressbar('option', 'value');
                   8607:     \$('.pblabel', this).text(LCprogressTxt);
                   8608:   }
                   8609: });
                   8610: // ]]>
                   8611: </script>
                   8612: ENDPROGRESS
1.1075.2.130  raeburn  8613:    } else {
                   8614:        return(<<ENDPROGRESS);
                   8615: <script type="text/javascript">
                   8616: // <![CDATA[
                   8617: \$('#progressbar$id').progressbar({
                   8618:   value: false,
                   8619:   create: function(event, ui) {
                   8620:     \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
                   8621:     \$('.ui-progressbar-overlay', this).css({'margin':'0'});
                   8622:   }
                   8623: });
                   8624: // ]]>
                   8625: </script>
                   8626: ENDPROGRESS
                   8627:    }
1.1041    www      8628: }
                   8629: 
                   8630: sub LCprogressbarUpdate_script {
                   8631:    return(<<ENDPROGRESSUPDATE);
                   8632: <style type="text/css">
                   8633: .ui-progressbar { position:relative; }
1.1075.2.130  raeburn  8634: .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      8635: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   8636: </style>
                   8637: <script type="text/javascript">
                   8638: // <![CDATA[
1.1045    www      8639: var LCprogressTxt='---';
                   8640: 
1.1075.2.130  raeburn  8641: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041    www      8642:    LCprogressTxt=progresstext;
1.1075.2.130  raeburn  8643:    if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
                   8644:        \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
                   8645:    } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
                   8646:        \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
                   8647:    } else {
                   8648:        \$('#progressbar'+id).progressbar('value',percent);
                   8649:    }
1.1041    www      8650: }
                   8651: // ]]>
                   8652: </script>
                   8653: ENDPROGRESSUPDATE
                   8654: }
                   8655: 
1.1042    www      8656: my $LClastpercent;
1.1045    www      8657: my $LCidcnt;
                   8658: my $LCcurrentid;
1.1042    www      8659: 
1.1041    www      8660: sub LCprogressbar {
1.1075.2.130  raeburn  8661:     my ($r,$number_to_do,$preamble)=@_;
1.1042    www      8662:     $LClastpercent=0;
1.1045    www      8663:     $LCidcnt++;
                   8664:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1075.2.130  raeburn  8665:     my ($starting,$content);
                   8666:     if ($number_to_do) {
                   8667:         $starting=&mt('Starting');
                   8668:         $content=(<<ENDPROGBAR);
                   8669: $preamble
1.1045    www      8670:   <div id="progressbar$LCcurrentid">
1.1041    www      8671:     <span class="pblabel">$starting</span>
                   8672:   </div>
                   8673: ENDPROGBAR
1.1075.2.130  raeburn  8674:     } else {
                   8675:         $starting=&mt('Loading...');
                   8676:         $LClastpercent='false';
                   8677:         $content=(<<ENDPROGBAR);
                   8678: $preamble
                   8679:   <div id="progressbar$LCcurrentid">
                   8680:       <div class="progress-label">$starting</div>
                   8681:   </div>
                   8682: ENDPROGBAR
                   8683:     }
                   8684:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041    www      8685: }
                   8686: 
                   8687: sub LCprogressbarUpdate {
1.1075.2.130  raeburn  8688:     my ($r,$val,$text,$number_to_do)=@_;
                   8689:     if ($number_to_do) {
                   8690:         unless ($val) { 
                   8691:             if ($LClastpercent) {
                   8692:                 $val=$LClastpercent;
                   8693:             } else {
                   8694:                 $val=0;
                   8695:             }
                   8696:         }
                   8697:         if ($val<0) { $val=0; }
                   8698:         if ($val>100) { $val=0; }
                   8699:         $LClastpercent=$val;
                   8700:         unless ($text) { $text=$val.'%'; }
                   8701:     } else {
                   8702:         $val = 'false';
1.1042    www      8703:     }
1.1041    www      8704:     $text=&js_ready($text);
1.1044    www      8705:     &r_print($r,<<ENDUPDATE);
1.1041    www      8706: <script type="text/javascript">
                   8707: // <![CDATA[
1.1075.2.130  raeburn  8708: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041    www      8709: // ]]>
                   8710: </script>
                   8711: ENDUPDATE
1.1035    www      8712: }
                   8713: 
1.1042    www      8714: sub LCprogressbarClose {
                   8715:     my ($r)=@_;
                   8716:     $LClastpercent=0;
1.1044    www      8717:     &r_print($r,<<ENDCLOSE);
1.1042    www      8718: <script type="text/javascript">
                   8719: // <![CDATA[
1.1045    www      8720: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      8721: // ]]>
                   8722: </script>
                   8723: ENDCLOSE
1.1044    www      8724: }
                   8725: 
                   8726: sub r_print {
                   8727:     my ($r,$to_print)=@_;
                   8728:     if ($r) {
                   8729:       $r->print($to_print);
                   8730:       $r->rflush();
                   8731:     } else {
                   8732:       print($to_print);
                   8733:     }
1.1042    www      8734: }
                   8735: 
1.320     albertel 8736: sub html_encode {
                   8737:     my ($result) = @_;
                   8738: 
1.322     albertel 8739:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 8740:     
                   8741:     return $result;
                   8742: }
1.1044    www      8743: 
1.317     albertel 8744: sub js_ready {
                   8745:     my ($result) = @_;
                   8746: 
1.323     albertel 8747:     $result =~ s/[\n\r]/ /xmsg;
                   8748:     $result =~ s/\\/\\\\/xmsg;
                   8749:     $result =~ s/'/\\'/xmsg;
1.372     albertel 8750:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 8751:     
                   8752:     return $result;
                   8753: }
                   8754: 
1.315     albertel 8755: sub validate_page {
                   8756:     if (  exists($env{'internal.start_page'})
1.316     albertel 8757: 	  &&     $env{'internal.start_page'} > 1) {
                   8758: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 8759: 				 $env{'internal.start_page'}.' '.
1.316     albertel 8760: 				 $ENV{'request.filename'});
1.315     albertel 8761:     }
                   8762:     if (  exists($env{'internal.end_page'})
1.316     albertel 8763: 	  &&     $env{'internal.end_page'} > 1) {
                   8764: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 8765: 				 $env{'internal.end_page'}.' '.
1.316     albertel 8766: 				 $env{'request.filename'});
1.315     albertel 8767:     }
                   8768:     if (     exists($env{'internal.start_page'})
                   8769: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 8770: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   8771: 				 $env{'request.filename'});
1.315     albertel 8772:     }
                   8773:     if (   ! exists($env{'internal.start_page'})
                   8774: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 8775: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   8776: 				 $env{'request.filename'});
1.315     albertel 8777:     }
1.306     albertel 8778: }
1.315     albertel 8779: 
1.996     www      8780: 
                   8781: sub start_scrollbox {
1.1075.2.56  raeburn  8782:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  8783:     unless ($outerwidth) { $outerwidth='520px'; }
                   8784:     unless ($width) { $width='500px'; }
                   8785:     unless ($height) { $height='200px'; }
1.1075    raeburn  8786:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  8787:     if ($id ne '') {
1.1075.2.42  raeburn  8788:         $table_id = ' id="table_'.$id.'"';
                   8789:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  8790:     }
1.1075    raeburn  8791:     if ($bgcolor ne '') {
                   8792:         $tdcol = "background-color: $bgcolor;";
                   8793:     }
1.1075.2.42  raeburn  8794:     my $nicescroll_js;
                   8795:     if ($env{'browser.mobile'}) {
                   8796:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   8797:     }
1.1075    raeburn  8798:     return <<"END";
1.1075.2.42  raeburn  8799: $nicescroll_js
                   8800: 
                   8801: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
1.1075.2.56  raeburn  8802: <div style="overflow:auto; width:$width; height:$height;"$div_id>
1.1075    raeburn  8803: END
1.996     www      8804: }
                   8805: 
                   8806: sub end_scrollbox {
1.1036    www      8807:     return '</div></td></tr></table>';
1.996     www      8808: }
                   8809: 
1.1075.2.42  raeburn  8810: sub nicescroll_javascript {
                   8811:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   8812:     my %options;
                   8813:     if (ref($cursor) eq 'HASH') {
                   8814:         %options = %{$cursor};
                   8815:     }
                   8816:     unless ($options{'railalign'} =~ /^left|right$/) {
                   8817:         $options{'railalign'} = 'left';
                   8818:     }
                   8819:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   8820:         my $function  = &get_users_function();
                   8821:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
                   8822:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   8823:             $options{'cursorcolor'} = '#00F';
                   8824:         }
                   8825:     }
                   8826:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   8827:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
                   8828:             $options{'cursoropacity'}='1.0';
                   8829:         }
                   8830:     } else {
                   8831:         $options{'cursoropacity'}='1.0';
                   8832:     }
                   8833:     if ($options{'cursorfixedheight'} eq 'none') {
                   8834:         delete($options{'cursorfixedheight'});
                   8835:     } else {
                   8836:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   8837:     }
                   8838:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   8839:         delete($options{'railoffset'});
                   8840:     }
                   8841:     my @niceoptions;
                   8842:     while (my($key,$value) = each(%options)) {
                   8843:         if ($value =~ /^\{.+\}$/) {
                   8844:             push(@niceoptions,$key.':'.$value);
                   8845:         } else {
                   8846:             push(@niceoptions,$key.':"'.$value.'"');
                   8847:         }
                   8848:     }
                   8849:     my $nicescroll_js = '
                   8850: $(document).ready(
                   8851:       function() {
                   8852:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   8853:       }
                   8854: );
                   8855: ';
                   8856:     if ($framecheck) {
                   8857:         $nicescroll_js .= '
                   8858: function expand_div(caller) {
                   8859:     if (top === self) {
                   8860:         document.getElementById("'.$id.'").style.width = "auto";
                   8861:         document.getElementById("'.$id.'").style.height = "auto";
                   8862:     } else {
                   8863:         try {
                   8864:             if (parent.frames) {
                   8865:                 if (parent.frames.length > 1) {
                   8866:                     var framesrc = parent.frames[1].location.href;
                   8867:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   8868:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   8869:                         document.getElementById("'.$id.'").style.width = "auto";
                   8870:                         document.getElementById("'.$id.'").style.height = "auto";
                   8871:                     }
                   8872:                 }
                   8873:             }
                   8874:         } catch (e) {
                   8875:             return;
                   8876:         }
                   8877:     }
                   8878:     return;
                   8879: }
                   8880: ';
                   8881:     }
                   8882:     if ($needjsready) {
                   8883:         $nicescroll_js = '
                   8884: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   8885:     } else {
                   8886:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   8887:     }
                   8888:     return $nicescroll_js;
                   8889: }
                   8890: 
1.318     albertel 8891: sub simple_error_page {
1.1075.2.49  raeburn  8892:     my ($r,$title,$msg,$args) = @_;
                   8893:     if (ref($args) eq 'HASH') {
                   8894:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
                   8895:     } else {
                   8896:         $msg = &mt($msg);
                   8897:     }
                   8898: 
1.318     albertel 8899:     my $page =
                   8900: 	&Apache::loncommon::start_page($title).
1.1075.2.49  raeburn  8901: 	'<p class="LC_error">'.$msg.'</p>'.
1.318     albertel 8902: 	&Apache::loncommon::end_page();
                   8903:     if (ref($r)) {
                   8904: 	$r->print($page);
1.327     albertel 8905: 	return;
1.318     albertel 8906:     }
                   8907:     return $page;
                   8908: }
1.347     albertel 8909: 
                   8910: {
1.610     albertel 8911:     my @row_count;
1.961     onken    8912: 
                   8913:     sub start_data_table_count {
                   8914:         unshift(@row_count, 0);
                   8915:         return;
                   8916:     }
                   8917: 
                   8918:     sub end_data_table_count {
                   8919:         shift(@row_count);
                   8920:         return;
                   8921:     }
                   8922: 
1.347     albertel 8923:     sub start_data_table {
1.1018    raeburn  8924: 	my ($add_class,$id) = @_;
1.422     albertel 8925: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  8926:         my $table_id;
                   8927:         if (defined($id)) {
                   8928:             $table_id = ' id="'.$id.'"';
                   8929:         }
1.961     onken    8930: 	&start_data_table_count();
1.1018    raeburn  8931: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 8932:     }
                   8933: 
                   8934:     sub end_data_table {
1.961     onken    8935: 	&end_data_table_count();
1.389     albertel 8936: 	return '</table>'."\n";;
1.347     albertel 8937:     }
                   8938: 
                   8939:     sub start_data_table_row {
1.974     wenzelju 8940: 	my ($add_class, $id) = @_;
1.610     albertel 8941: 	$row_count[0]++;
                   8942: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   8943: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 8944:         $id = (' id="'.$id.'"') unless ($id eq '');
                   8945:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 8946:     }
1.471     banghart 8947:     
                   8948:     sub continue_data_table_row {
1.974     wenzelju 8949: 	my ($add_class, $id) = @_;
1.610     albertel 8950: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 8951: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   8952:         $id = (' id="'.$id.'"') unless ($id eq '');
                   8953:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 8954:     }
1.347     albertel 8955: 
                   8956:     sub end_data_table_row {
1.389     albertel 8957: 	return '</tr>'."\n";;
1.347     albertel 8958:     }
1.367     www      8959: 
1.421     albertel 8960:     sub start_data_table_empty_row {
1.707     bisitz   8961: #	$row_count[0]++;
1.421     albertel 8962: 	return  '<tr class="LC_empty_row" >'."\n";;
                   8963:     }
                   8964: 
                   8965:     sub end_data_table_empty_row {
                   8966: 	return '</tr>'."\n";;
                   8967:     }
                   8968: 
1.367     www      8969:     sub start_data_table_header_row {
1.389     albertel 8970: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      8971:     }
                   8972: 
                   8973:     sub end_data_table_header_row {
1.389     albertel 8974: 	return '</tr>'."\n";;
1.367     www      8975:     }
1.890     droeschl 8976: 
                   8977:     sub data_table_caption {
                   8978:         my $caption = shift;
                   8979:         return "<caption class=\"LC_caption\">$caption</caption>";
                   8980:     }
1.347     albertel 8981: }
                   8982: 
1.548     albertel 8983: =pod
                   8984: 
                   8985: =item * &inhibit_menu_check($arg)
                   8986: 
                   8987: Checks for a inhibitmenu state and generates output to preserve it
                   8988: 
                   8989: Inputs:         $arg - can be any of
                   8990:                      - undef - in which case the return value is a string 
                   8991:                                to add  into arguments list of a uri
                   8992:                      - 'input' - in which case the return value is a HTML
                   8993:                                  <form> <input> field of type hidden to
                   8994:                                  preserve the value
                   8995:                      - a url - in which case the return value is the url with
                   8996:                                the neccesary cgi args added to preserve the
                   8997:                                inhibitmenu state
                   8998:                      - a ref to a url - no return value, but the string is
                   8999:                                         updated to include the neccessary cgi
                   9000:                                         args to preserve the inhibitmenu state
                   9001: 
                   9002: =cut
                   9003: 
                   9004: sub inhibit_menu_check {
                   9005:     my ($arg) = @_;
                   9006:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   9007:     if ($arg eq 'input') {
                   9008: 	if ($env{'form.inhibitmenu'}) {
                   9009: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   9010: 	} else {
                   9011: 	    return
                   9012: 	}
                   9013:     }
                   9014:     if ($env{'form.inhibitmenu'}) {
                   9015: 	if (ref($arg)) {
                   9016: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9017: 	} elsif ($arg eq '') {
                   9018: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   9019: 	} else {
                   9020: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9021: 	}
                   9022:     }
                   9023:     if (!ref($arg)) {
                   9024: 	return $arg;
                   9025:     }
                   9026: }
                   9027: 
1.251     albertel 9028: ###############################################
1.182     matthew  9029: 
                   9030: =pod
                   9031: 
1.549     albertel 9032: =back
                   9033: 
                   9034: =head1 User Information Routines
                   9035: 
                   9036: =over 4
                   9037: 
1.405     albertel 9038: =item * &get_users_function()
1.182     matthew  9039: 
                   9040: Used by &bodytag to determine the current users primary role.
                   9041: Returns either 'student','coordinator','admin', or 'author'.
                   9042: 
                   9043: =cut
                   9044: 
                   9045: ###############################################
                   9046: sub get_users_function {
1.815     tempelho 9047:     my $function = 'norole';
1.818     tempelho 9048:     if ($env{'request.role'}=~/^(st)/) {
                   9049:         $function='student';
                   9050:     }
1.907     raeburn  9051:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  9052:         $function='coordinator';
                   9053:     }
1.258     albertel 9054:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  9055:         $function='admin';
                   9056:     }
1.826     bisitz   9057:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  9058:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  9059:         $function='author';
                   9060:     }
                   9061:     return $function;
1.54      www      9062: }
1.99      www      9063: 
                   9064: ###############################################
                   9065: 
1.233     raeburn  9066: =pod
                   9067: 
1.821     raeburn  9068: =item * &show_course()
                   9069: 
                   9070: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   9071: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   9072: 
                   9073: Inputs:
                   9074: None
                   9075: 
                   9076: Outputs:
                   9077: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   9078: 
                   9079: =cut
                   9080: 
                   9081: ###############################################
                   9082: sub show_course {
                   9083:     my $course = !$env{'user.adv'};
                   9084:     if (!$env{'user.adv'}) {
                   9085:         foreach my $env (keys(%env)) {
                   9086:             next if ($env !~ m/^user\.priv\./);
                   9087:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   9088:                 $course = 0;
                   9089:                 last;
                   9090:             }
                   9091:         }
                   9092:     }
                   9093:     return $course;
                   9094: }
                   9095: 
                   9096: ###############################################
                   9097: 
                   9098: =pod
                   9099: 
1.542     raeburn  9100: =item * &check_user_status()
1.274     raeburn  9101: 
                   9102: Determines current status of supplied role for a
                   9103: specific user. Roles can be active, previous or future.
                   9104: 
                   9105: Inputs: 
                   9106: user's domain, user's username, course's domain,
1.375     raeburn  9107: course's number, optional section ID.
1.274     raeburn  9108: 
                   9109: Outputs:
                   9110: role status: active, previous or future. 
                   9111: 
                   9112: =cut
                   9113: 
                   9114: sub check_user_status {
1.412     raeburn  9115:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  9116:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1075.2.85  raeburn  9117:     my @uroles = keys(%userinfo);
1.274     raeburn  9118:     my $srchstr;
                   9119:     my $active_chk = 'none';
1.412     raeburn  9120:     my $now = time;
1.274     raeburn  9121:     if (@uroles > 0) {
1.908     raeburn  9122:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  9123:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   9124:         } else {
1.412     raeburn  9125:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   9126:         }
                   9127:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  9128:             my $role_end = 0;
                   9129:             my $role_start = 0;
                   9130:             $active_chk = 'active';
1.412     raeburn  9131:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   9132:                 $role_end = $1;
                   9133:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   9134:                     $role_start = $1;
1.274     raeburn  9135:                 }
                   9136:             }
                   9137:             if ($role_start > 0) {
1.412     raeburn  9138:                 if ($now < $role_start) {
1.274     raeburn  9139:                     $active_chk = 'future';
                   9140:                 }
                   9141:             }
                   9142:             if ($role_end > 0) {
1.412     raeburn  9143:                 if ($now > $role_end) {
1.274     raeburn  9144:                     $active_chk = 'previous';
                   9145:                 }
                   9146:             }
                   9147:         }
                   9148:     }
                   9149:     return $active_chk;
                   9150: }
                   9151: 
                   9152: ###############################################
                   9153: 
                   9154: =pod
                   9155: 
1.405     albertel 9156: =item * &get_sections()
1.233     raeburn  9157: 
                   9158: Determines all the sections for a course including
                   9159: sections with students and sections containing other roles.
1.419     raeburn  9160: Incoming parameters: 
                   9161: 
                   9162: 1. domain
                   9163: 2. course number 
                   9164: 3. reference to array containing roles for which sections should 
                   9165: be gathered (optional).
                   9166: 4. reference to array containing status types for which sections 
                   9167: should be gathered (optional).
                   9168: 
                   9169: If the third argument is undefined, sections are gathered for any role. 
                   9170: If the fourth argument is undefined, sections are gathered for any status.
                   9171: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  9172:  
1.374     raeburn  9173: Returns section hash (keys are section IDs, values are
                   9174: number of users in each section), subject to the
1.419     raeburn  9175: optional roles filter, optional status filter 
1.233     raeburn  9176: 
                   9177: =cut
                   9178: 
                   9179: ###############################################
                   9180: sub get_sections {
1.419     raeburn  9181:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 9182:     if (!defined($cdom) || !defined($cnum)) {
                   9183:         my $cid =  $env{'request.course.id'};
                   9184: 
                   9185: 	return if (!defined($cid));
                   9186: 
                   9187:         $cdom = $env{'course.'.$cid.'.domain'};
                   9188:         $cnum = $env{'course.'.$cid.'.num'};
                   9189:     }
                   9190: 
                   9191:     my %sectioncount;
1.419     raeburn  9192:     my $now = time;
1.240     albertel 9193: 
1.1075.2.33  raeburn  9194:     my $check_students = 1;
                   9195:     my $only_students = 0;
                   9196:     if (ref($possible_roles) eq 'ARRAY') {
                   9197:         if (grep(/^st$/,@{$possible_roles})) {
                   9198:             if (@{$possible_roles} == 1) {
                   9199:                 $only_students = 1;
                   9200:             }
                   9201:         } else {
                   9202:             $check_students = 0;
                   9203:         }
                   9204:     }
                   9205: 
                   9206:     if ($check_students) {
1.276     albertel 9207: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 9208: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   9209: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  9210:         my $start_index = &Apache::loncoursedata::CL_START();
                   9211:         my $end_index = &Apache::loncoursedata::CL_END();
                   9212:         my $status;
1.366     albertel 9213: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  9214: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   9215: 				                     $data->[$status_index],
                   9216:                                                      $data->[$start_index],
                   9217:                                                      $data->[$end_index]);
                   9218:             if ($stu_status eq 'Active') {
                   9219:                 $status = 'active';
                   9220:             } elsif ($end < $now) {
                   9221:                 $status = 'previous';
                   9222:             } elsif ($start > $now) {
                   9223:                 $status = 'future';
                   9224:             } 
                   9225: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   9226:                 if ((!defined($possible_status)) || (($status ne '') && 
                   9227:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   9228: 		    $sectioncount{$section}++;
                   9229:                 }
1.240     albertel 9230: 	    }
                   9231: 	}
                   9232:     }
1.1075.2.33  raeburn  9233:     if ($only_students) {
                   9234:         return %sectioncount;
                   9235:     }
1.240     albertel 9236:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9237:     foreach my $user (sort(keys(%courseroles))) {
                   9238: 	if ($user !~ /^(\w{2})/) { next; }
                   9239: 	my ($role) = ($user =~ /^(\w{2})/);
                   9240: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  9241: 	my ($section,$status);
1.240     albertel 9242: 	if ($role eq 'cr' &&
                   9243: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   9244: 	    $section=$1;
                   9245: 	}
                   9246: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   9247: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  9248:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   9249:         if ($end == -1 && $start == -1) {
                   9250:             next; #deleted role
                   9251:         }
                   9252:         if (!defined($possible_status)) { 
                   9253:             $sectioncount{$section}++;
                   9254:         } else {
                   9255:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   9256:                 $status = 'active';
                   9257:             } elsif ($end < $now) {
                   9258:                 $status = 'future';
                   9259:             } elsif ($start > $now) {
                   9260:                 $status = 'previous';
                   9261:             }
                   9262:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   9263:                 $sectioncount{$section}++;
                   9264:             }
                   9265:         }
1.233     raeburn  9266:     }
1.366     albertel 9267:     return %sectioncount;
1.233     raeburn  9268: }
                   9269: 
1.274     raeburn  9270: ###############################################
1.294     raeburn  9271: 
                   9272: =pod
1.405     albertel 9273: 
                   9274: =item * &get_course_users()
                   9275: 
1.275     raeburn  9276: Retrieves usernames:domains for users in the specified course
                   9277: with specific role(s), and access status. 
                   9278: 
                   9279: Incoming parameters:
1.277     albertel 9280: 1. course domain
                   9281: 2. course number
                   9282: 3. access status: users must have - either active, 
1.275     raeburn  9283: previous, future, or all.
1.277     albertel 9284: 4. reference to array of permissible roles
1.288     raeburn  9285: 5. reference to array of section restrictions (optional)
                   9286: 6. reference to results object (hash of hashes).
                   9287: 7. reference to optional userdata hash
1.609     raeburn  9288: 8. reference to optional statushash
1.630     raeburn  9289: 9. flag if privileged users (except those set to unhide in
                   9290:    course settings) should be excluded    
1.609     raeburn  9291: Keys of top level results hash are roles.
1.275     raeburn  9292: Keys of inner hashes are username:domain, with 
                   9293: values set to access type.
1.288     raeburn  9294: Optional userdata hash returns an array with arguments in the 
                   9295: same order as loncoursedata::get_classlist() for student data.
                   9296: 
1.609     raeburn  9297: Optional statushash returns
                   9298: 
1.288     raeburn  9299: Entries for end, start, section and status are blank because
                   9300: of the possibility of multiple values for non-student roles.
                   9301: 
1.275     raeburn  9302: =cut
1.405     albertel 9303: 
1.275     raeburn  9304: ###############################################
1.405     albertel 9305: 
1.275     raeburn  9306: sub get_course_users {
1.630     raeburn  9307:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  9308:     my %idx = ();
1.419     raeburn  9309:     my %seclists;
1.288     raeburn  9310: 
                   9311:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   9312:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   9313:     $idx{end} = &Apache::loncoursedata::CL_END();
                   9314:     $idx{start} = &Apache::loncoursedata::CL_START();
                   9315:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   9316:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   9317:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   9318:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   9319: 
1.290     albertel 9320:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 9321:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  9322:         my $now = time;
1.277     albertel 9323:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  9324:             my $match = 0;
1.412     raeburn  9325:             my $secmatch = 0;
1.419     raeburn  9326:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  9327:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  9328:             if ($section eq '') {
                   9329:                 $section = 'none';
                   9330:             }
1.291     albertel 9331:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9332:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9333:                     $secmatch = 1;
                   9334:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 9335:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9336:                         $secmatch = 1;
                   9337:                     }
                   9338:                 } else {  
1.419     raeburn  9339: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  9340: 		        $secmatch = 1;
                   9341:                     }
1.290     albertel 9342: 		}
1.412     raeburn  9343:                 if (!$secmatch) {
                   9344:                     next;
                   9345:                 }
1.419     raeburn  9346:             }
1.275     raeburn  9347:             if (defined($$types{'active'})) {
1.288     raeburn  9348:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  9349:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  9350:                     $match = 1;
1.275     raeburn  9351:                 }
                   9352:             }
                   9353:             if (defined($$types{'previous'})) {
1.609     raeburn  9354:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  9355:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  9356:                     $match = 1;
1.275     raeburn  9357:                 }
                   9358:             }
                   9359:             if (defined($$types{'future'})) {
1.609     raeburn  9360:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  9361:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  9362:                     $match = 1;
1.275     raeburn  9363:                 }
                   9364:             }
1.609     raeburn  9365:             if ($match) {
                   9366:                 push(@{$seclists{$student}},$section);
                   9367:                 if (ref($userdata) eq 'HASH') {
                   9368:                     $$userdata{$student} = $$classlist{$student};
                   9369:                 }
                   9370:                 if (ref($statushash) eq 'HASH') {
                   9371:                     $statushash->{$student}{'st'}{$section} = $status;
                   9372:                 }
1.288     raeburn  9373:             }
1.275     raeburn  9374:         }
                   9375:     }
1.412     raeburn  9376:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  9377:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9378:         my $now = time;
1.609     raeburn  9379:         my %displaystatus = ( previous => 'Expired',
                   9380:                               active   => 'Active',
                   9381:                               future   => 'Future',
                   9382:                             );
1.1075.2.36  raeburn  9383:         my (%nothide,@possdoms);
1.630     raeburn  9384:         if ($hidepriv) {
                   9385:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   9386:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   9387:                 if ($user !~ /:/) {
                   9388:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   9389:                 } else {
                   9390:                     $nothide{$user} = 1;
                   9391:                 }
                   9392:             }
1.1075.2.36  raeburn  9393:             my @possdoms = ($cdom);
                   9394:             if ($coursehash{'checkforpriv'}) {
                   9395:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   9396:             }
1.630     raeburn  9397:         }
1.439     raeburn  9398:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  9399:             my $match = 0;
1.412     raeburn  9400:             my $secmatch = 0;
1.439     raeburn  9401:             my $status;
1.412     raeburn  9402:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  9403:             $user =~ s/:$//;
1.439     raeburn  9404:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   9405:             if ($end == -1 || $start == -1) {
                   9406:                 next;
                   9407:             }
                   9408:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   9409:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  9410:                 my ($uname,$udom) = split(/:/,$user);
                   9411:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9412:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9413:                         $secmatch = 1;
                   9414:                     } elsif ($usec eq '') {
1.420     albertel 9415:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9416:                             $secmatch = 1;
                   9417:                         }
                   9418:                     } else {
                   9419:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   9420:                             $secmatch = 1;
                   9421:                         }
                   9422:                     }
                   9423:                     if (!$secmatch) {
                   9424:                         next;
                   9425:                     }
1.288     raeburn  9426:                 }
1.419     raeburn  9427:                 if ($usec eq '') {
                   9428:                     $usec = 'none';
                   9429:                 }
1.275     raeburn  9430:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  9431:                     if ($hidepriv) {
1.1075.2.36  raeburn  9432:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  9433:                             (!$nothide{$uname.':'.$udom})) {
                   9434:                             next;
                   9435:                         }
                   9436:                     }
1.503     raeburn  9437:                     if ($end > 0 && $end < $now) {
1.439     raeburn  9438:                         $status = 'previous';
                   9439:                     } elsif ($start > $now) {
                   9440:                         $status = 'future';
                   9441:                     } else {
                   9442:                         $status = 'active';
                   9443:                     }
1.277     albertel 9444:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  9445:                         if ($status eq $type) {
1.420     albertel 9446:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  9447:                                 push(@{$$users{$role}{$user}},$type);
                   9448:                             }
1.288     raeburn  9449:                             $match = 1;
                   9450:                         }
                   9451:                     }
1.419     raeburn  9452:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   9453:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   9454: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   9455:                         }
1.420     albertel 9456:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  9457:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   9458:                         }
1.609     raeburn  9459:                         if (ref($statushash) eq 'HASH') {
                   9460:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   9461:                         }
1.275     raeburn  9462:                     }
                   9463:                 }
                   9464:             }
                   9465:         }
1.290     albertel 9466:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  9467:             if ((defined($cdom)) && (defined($cnum))) {
                   9468:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   9469:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   9470:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  9471:                     next if ($owner eq '');
                   9472:                     my ($ownername,$ownerdom);
                   9473:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   9474:                         $ownername = $1;
                   9475:                         $ownerdom = $2;
                   9476:                     } else {
                   9477:                         $ownername = $owner;
                   9478:                         $ownerdom = $cdom;
                   9479:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  9480:                     }
                   9481:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 9482:                     if (defined($userdata) && 
1.609     raeburn  9483: 			!exists($$userdata{$owner})) {
                   9484: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   9485:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   9486:                             push(@{$seclists{$owner}},'none');
                   9487:                         }
                   9488:                         if (ref($statushash) eq 'HASH') {
                   9489:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  9490:                         }
1.290     albertel 9491: 		    }
1.279     raeburn  9492:                 }
                   9493:             }
                   9494:         }
1.419     raeburn  9495:         foreach my $user (keys(%seclists)) {
                   9496:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   9497:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   9498:         }
1.275     raeburn  9499:     }
                   9500:     return;
                   9501: }
                   9502: 
1.288     raeburn  9503: sub get_user_info {
                   9504:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 9505:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   9506: 	&plainname($uname,$udom,'lastname');
1.291     albertel 9507:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  9508:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  9509:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   9510:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  9511:     return;
                   9512: }
1.275     raeburn  9513: 
1.472     raeburn  9514: ###############################################
                   9515: 
                   9516: =pod
                   9517: 
                   9518: =item * &get_user_quota()
                   9519: 
1.1075.2.41  raeburn  9520: Retrieves quota assigned for storage of user files.
                   9521: Default is to report quota for portfolio files.
1.472     raeburn  9522: 
                   9523: Incoming parameters:
                   9524: 1. user's username
                   9525: 2. user's domain
1.1075.2.41  raeburn  9526: 3. quota name - portfolio, author, or course
                   9527:    (if no quota name provided, defaults to portfolio).
1.1075.2.59  raeburn  9528: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1075.2.42  raeburn  9529:    course
1.472     raeburn  9530: 
                   9531: Returns:
1.1075.2.58  raeburn  9532: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  9533: 2. (Optional) Type of setting: custom or default
                   9534:    (individually assigned or default for user's 
                   9535:    institutional status).
                   9536: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   9537:    or student - types as defined in localenroll::inst_usertypes 
                   9538:    for user's domain, which determines default quota for user.
                   9539: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  9540: 
                   9541: If a value has been stored in the user's environment, 
1.536     raeburn  9542: it will return that, otherwise it returns the maximal default
1.1075.2.41  raeburn  9543: defined for the user's institutional status(es) in the domain.
1.472     raeburn  9544: 
                   9545: =cut
                   9546: 
                   9547: ###############################################
                   9548: 
                   9549: 
                   9550: sub get_user_quota {
1.1075.2.42  raeburn  9551:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  9552:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  9553:     if (!defined($udom)) {
                   9554:         $udom = $env{'user.domain'};
                   9555:     }
                   9556:     if (!defined($uname)) {
                   9557:         $uname = $env{'user.name'};
                   9558:     }
                   9559:     if (($udom eq '' || $uname eq '') ||
                   9560:         ($udom eq 'public') && ($uname eq 'public')) {
                   9561:         $quota = 0;
1.536     raeburn  9562:         $quotatype = 'default';
                   9563:         $defquota = 0; 
1.472     raeburn  9564:     } else {
1.536     raeburn  9565:         my $inststatus;
1.1075.2.41  raeburn  9566:         if ($quotaname eq 'course') {
                   9567:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   9568:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   9569:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   9570:             } else {
                   9571:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   9572:                 $quota = $cenv{'internal.uploadquota'};
                   9573:             }
1.536     raeburn  9574:         } else {
1.1075.2.41  raeburn  9575:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   9576:                 if ($quotaname eq 'author') {
                   9577:                     $quota = $env{'environment.authorquota'};
                   9578:                 } else {
                   9579:                     $quota = $env{'environment.portfolioquota'};
                   9580:                 }
                   9581:                 $inststatus = $env{'environment.inststatus'};
                   9582:             } else {
                   9583:                 my %userenv = 
                   9584:                     &Apache::lonnet::get('environment',['portfolioquota',
                   9585:                                          'authorquota','inststatus'],$udom,$uname);
                   9586:                 my ($tmp) = keys(%userenv);
                   9587:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   9588:                     if ($quotaname eq 'author') {
                   9589:                         $quota = $userenv{'authorquota'};
                   9590:                     } else {
                   9591:                         $quota = $userenv{'portfolioquota'};
                   9592:                     }
                   9593:                     $inststatus = $userenv{'inststatus'};
                   9594:                 } else {
                   9595:                     undef(%userenv);
                   9596:                 }
                   9597:             }
                   9598:         }
                   9599:         if ($quota eq '' || wantarray) {
                   9600:             if ($quotaname eq 'course') {
                   9601:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1075.2.59  raeburn  9602:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
                   9603:                     ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1075.2.42  raeburn  9604:                     $defquota = $domdefs{$crstype.'quota'};
                   9605:                 }
                   9606:                 if ($defquota eq '') {
                   9607:                     $defquota = 500;
                   9608:                 }
1.1075.2.41  raeburn  9609:             } else {
                   9610:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   9611:             }
                   9612:             if ($quota eq '') {
                   9613:                 $quota = $defquota;
                   9614:                 $quotatype = 'default';
                   9615:             } else {
                   9616:                 $quotatype = 'custom';
                   9617:             }
1.472     raeburn  9618:         }
                   9619:     }
1.536     raeburn  9620:     if (wantarray) {
                   9621:         return ($quota,$quotatype,$settingstatus,$defquota);
                   9622:     } else {
                   9623:         return $quota;
                   9624:     }
1.472     raeburn  9625: }
                   9626: 
                   9627: ###############################################
                   9628: 
                   9629: =pod
                   9630: 
                   9631: =item * &default_quota()
                   9632: 
1.536     raeburn  9633: Retrieves default quota assigned for storage of user portfolio files,
                   9634: given an (optional) user's institutional status.
1.472     raeburn  9635: 
                   9636: Incoming parameters:
1.1075.2.42  raeburn  9637: 
1.472     raeburn  9638: 1. domain
1.536     raeburn  9639: 2. (Optional) institutional status(es).  This is a : separated list of 
                   9640:    status types (e.g., faculty, staff, student etc.)
                   9641:    which apply to the user for whom the default is being retrieved.
                   9642:    If the institutional status string in undefined, the domain
1.1075.2.41  raeburn  9643:    default quota will be returned.
                   9644: 3.  quota name - portfolio, author, or course
                   9645:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  9646: 
                   9647: Returns:
1.1075.2.42  raeburn  9648: 
1.1075.2.58  raeburn  9649: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  9650: 2. (Optional) institutional type which determined the value of the
                   9651:    default quota.
1.472     raeburn  9652: 
                   9653: If a value has been stored in the domain's configuration db,
                   9654: it will return that, otherwise it returns 20 (for backwards 
                   9655: compatibility with domains which have not set up a configuration
1.1075.2.58  raeburn  9656: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  9657: 
1.536     raeburn  9658: If the user's status includes multiple types (e.g., staff and student),
                   9659: the largest default quota which applies to the user determines the
                   9660: default quota returned.
                   9661: 
1.472     raeburn  9662: =cut
                   9663: 
                   9664: ###############################################
                   9665: 
                   9666: 
                   9667: sub default_quota {
1.1075.2.41  raeburn  9668:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  9669:     my ($defquota,$settingstatus);
                   9670:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  9671:                                             ['quotas'],$udom);
1.1075.2.41  raeburn  9672:     my $key = 'defaultquota';
                   9673:     if ($quotaname eq 'author') {
                   9674:         $key = 'authorquota';
                   9675:     }
1.622     raeburn  9676:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  9677:         if ($inststatus ne '') {
1.765     raeburn  9678:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  9679:             foreach my $item (@statuses) {
1.1075.2.41  raeburn  9680:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9681:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  9682:                         if ($defquota eq '') {
1.1075.2.41  raeburn  9683:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9684:                             $settingstatus = $item;
1.1075.2.41  raeburn  9685:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   9686:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9687:                             $settingstatus = $item;
                   9688:                         }
                   9689:                     }
1.1075.2.41  raeburn  9690:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  9691:                     if ($quotahash{'quotas'}{$item} ne '') {
                   9692:                         if ($defquota eq '') {
                   9693:                             $defquota = $quotahash{'quotas'}{$item};
                   9694:                             $settingstatus = $item;
                   9695:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   9696:                             $defquota = $quotahash{'quotas'}{$item};
                   9697:                             $settingstatus = $item;
                   9698:                         }
1.536     raeburn  9699:                     }
                   9700:                 }
                   9701:             }
                   9702:         }
                   9703:         if ($defquota eq '') {
1.1075.2.41  raeburn  9704:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9705:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   9706:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  9707:                 $defquota = $quotahash{'quotas'}{'default'};
                   9708:             }
1.536     raeburn  9709:             $settingstatus = 'default';
1.1075.2.42  raeburn  9710:             if ($defquota eq '') {
                   9711:                 if ($quotaname eq 'author') {
                   9712:                     $defquota = 500;
                   9713:                 }
                   9714:             }
1.536     raeburn  9715:         }
                   9716:     } else {
                   9717:         $settingstatus = 'default';
1.1075.2.41  raeburn  9718:         if ($quotaname eq 'author') {
                   9719:             $defquota = 500;
                   9720:         } else {
                   9721:             $defquota = 20;
                   9722:         }
1.536     raeburn  9723:     }
                   9724:     if (wantarray) {
                   9725:         return ($defquota,$settingstatus);
1.472     raeburn  9726:     } else {
1.536     raeburn  9727:         return $defquota;
1.472     raeburn  9728:     }
                   9729: }
                   9730: 
1.1075.2.41  raeburn  9731: ###############################################
                   9732: 
                   9733: =pod
                   9734: 
1.1075.2.42  raeburn  9735: =item * &excess_filesize_warning()
1.1075.2.41  raeburn  9736: 
                   9737: Returns warning message if upload of file to authoring space, or copying
1.1075.2.42  raeburn  9738: of existing file within authoring space will cause quota for the authoring
                   9739: space to be exceeded.
                   9740: 
                   9741: Same, if upload of a file directly to a course/community via Course Editor
                   9742: will cause quota for uploaded content for the course to be exceeded.
1.1075.2.41  raeburn  9743: 
1.1075.2.61  raeburn  9744: Inputs: 7 
1.1075.2.42  raeburn  9745: 1. username or coursenum
1.1075.2.41  raeburn  9746: 2. domain
1.1075.2.42  raeburn  9747: 3. context ('author' or 'course')
1.1075.2.41  raeburn  9748: 4. filename of file for which action is being requested
                   9749: 5. filesize (kB) of file
                   9750: 6. action being taken: copy or upload.
1.1075.2.59  raeburn  9751: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1075.2.41  raeburn  9752: 
                   9753: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
                   9754:          otherwise return null.
                   9755: 
1.1075.2.42  raeburn  9756: =back
                   9757: 
1.1075.2.41  raeburn  9758: =cut
                   9759: 
1.1075.2.42  raeburn  9760: sub excess_filesize_warning {
1.1075.2.59  raeburn  9761:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1075.2.42  raeburn  9762:     my $current_disk_usage = 0;
1.1075.2.59  raeburn  9763:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1075.2.42  raeburn  9764:     if ($context eq 'author') {
                   9765:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   9766:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   9767:     } else {
                   9768:         foreach my $subdir ('docs','supplemental') {
                   9769:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   9770:         }
                   9771:     }
1.1075.2.41  raeburn  9772:     $disk_quota = int($disk_quota * 1000);
                   9773:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1075.2.69  raeburn  9774:         return '<p class="LC_warning">'.
1.1075.2.41  raeburn  9775:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1075.2.69  raeburn  9776:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   9777:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1075.2.41  raeburn  9778:                             $disk_quota,$current_disk_usage).
                   9779:                '</p>';
                   9780:     }
                   9781:     return;
                   9782: }
                   9783: 
                   9784: ###############################################
                   9785: 
                   9786: 
1.384     raeburn  9787: sub get_secgrprole_info {
                   9788:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   9789:     my %sections_count = &get_sections($cdom,$cnum);
                   9790:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   9791:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   9792:     my @groups = sort(keys(%curr_groups));
                   9793:     my $allroles = [];
                   9794:     my $rolehash;
                   9795:     my $accesshash = {
                   9796:                      active => 'Currently has access',
                   9797:                      future => 'Will have future access',
                   9798:                      previous => 'Previously had access',
                   9799:                   };
                   9800:     if ($needroles) {
                   9801:         $rolehash = {'all' => 'all'};
1.385     albertel 9802:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9803: 	if (&Apache::lonnet::error(%user_roles)) {
                   9804: 	    undef(%user_roles);
                   9805: 	}
                   9806:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  9807:             my ($role)=split(/\:/,$item,2);
                   9808:             if ($role eq 'cr') { next; }
                   9809:             if ($role =~ /^cr/) {
                   9810:                 $$rolehash{$role} = (split('/',$role))[3];
                   9811:             } else {
                   9812:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   9813:             }
                   9814:         }
                   9815:         foreach my $key (sort(keys(%{$rolehash}))) {
                   9816:             push(@{$allroles},$key);
                   9817:         }
                   9818:         push (@{$allroles},'st');
                   9819:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   9820:     }
                   9821:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   9822: }
                   9823: 
1.555     raeburn  9824: sub user_picker {
1.1075.2.127  raeburn  9825:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  9826:     my $currdom = $dom;
1.1075.2.114  raeburn  9827:     my @alldoms = &Apache::lonnet::all_domains();
                   9828:     if (@alldoms == 1) {
                   9829:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   9830:                                                ['directorysrch'],$alldoms[0]);
                   9831:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   9832:         my $showdom = $domdesc;
                   9833:         if ($showdom eq '') {
                   9834:             $showdom = $dom;
                   9835:         }
                   9836:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   9837:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   9838:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   9839:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   9840:             }
                   9841:         }
                   9842:     }
1.555     raeburn  9843:     my %curr_selected = (
                   9844:                         srchin => 'dom',
1.580     raeburn  9845:                         srchby => 'lastname',
1.555     raeburn  9846:                       );
                   9847:     my $srchterm;
1.625     raeburn  9848:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  9849:         if ($srch->{'srchby'} ne '') {
                   9850:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   9851:         }
                   9852:         if ($srch->{'srchin'} ne '') {
                   9853:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   9854:         }
                   9855:         if ($srch->{'srchtype'} ne '') {
                   9856:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   9857:         }
                   9858:         if ($srch->{'srchdomain'} ne '') {
                   9859:             $currdom = $srch->{'srchdomain'};
                   9860:         }
                   9861:         $srchterm = $srch->{'srchterm'};
                   9862:     }
1.1075.2.98  raeburn  9863:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  9864:                     'usr'       => 'Search criteria',
1.563     raeburn  9865:                     'doma'      => 'Domain/institution to search',
1.558     albertel 9866:                     'uname'     => 'username',
                   9867:                     'lastname'  => 'last name',
1.555     raeburn  9868:                     'lastfirst' => 'last name, first name',
1.558     albertel 9869:                     'crs'       => 'in this course',
1.576     raeburn  9870:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 9871:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  9872:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 9873:                     'exact'     => 'is',
                   9874:                     'contains'  => 'contains',
1.569     raeburn  9875:                     'begins'    => 'begins with',
1.1075.2.98  raeburn  9876:                                        );
                   9877:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  9878:                     'youm'      => "You must include some text to search for.",
                   9879:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   9880:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   9881:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   9882:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   9883:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   9884:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   9885:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  9886:                                        );
1.1075.2.98  raeburn  9887:     &html_escape(\%html_lt);
                   9888:     &js_escape(\%js_lt);
1.1075.2.115  raeburn  9889:     my $domform;
1.1075.2.126  raeburn  9890:     my $allow_blank = 1;
1.1075.2.115  raeburn  9891:     if ($fixeddom) {
1.1075.2.126  raeburn  9892:         $allow_blank = 0;
                   9893:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1075.2.115  raeburn  9894:     } else {
1.1075.2.126  raeburn  9895:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1);
1.1075.2.115  raeburn  9896:     }
1.563     raeburn  9897:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  9898: 
                   9899:     my @srchins = ('crs','dom','alc','instd');
                   9900: 
                   9901:     foreach my $option (@srchins) {
                   9902:         # FIXME 'alc' option unavailable until 
                   9903:         #       loncreateuser::print_user_query_page()
                   9904:         #       has been completed.
                   9905:         next if ($option eq 'alc');
1.880     raeburn  9906:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  9907:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1075.2.127  raeburn  9908:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  9909:         if ($curr_selected{'srchin'} eq $option) {
                   9910:             $srchinsel .= ' 
1.1075.2.98  raeburn  9911:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  9912:         } else {
                   9913:             $srchinsel .= '
1.1075.2.98  raeburn  9914:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  9915:         }
1.555     raeburn  9916:     }
1.563     raeburn  9917:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  9918: 
                   9919:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  9920:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  9921:         if ($curr_selected{'srchby'} eq $option) {
                   9922:             $srchbysel .= '
1.1075.2.98  raeburn  9923:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  9924:         } else {
                   9925:             $srchbysel .= '
1.1075.2.98  raeburn  9926:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  9927:          }
                   9928:     }
                   9929:     $srchbysel .= "\n  </select>\n";
                   9930: 
                   9931:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  9932:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  9933:         if ($curr_selected{'srchtype'} eq $option) {
                   9934:             $srchtypesel .= '
1.1075.2.98  raeburn  9935:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  9936:         } else {
                   9937:             $srchtypesel .= '
1.1075.2.98  raeburn  9938:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  9939:         }
                   9940:     }
                   9941:     $srchtypesel .= "\n  </select>\n";
                   9942: 
1.558     albertel 9943:     my ($newuserscript,$new_user_create);
1.994     raeburn  9944:     my $context_dom = $env{'request.role.domain'};
                   9945:     if ($context eq 'requestcrs') {
                   9946:         if ($env{'form.coursedom'} ne '') { 
                   9947:             $context_dom = $env{'form.coursedom'};
                   9948:         }
                   9949:     }
1.556     raeburn  9950:     if ($forcenewuser) {
1.576     raeburn  9951:         if (ref($srch) eq 'HASH') {
1.994     raeburn  9952:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  9953:                 if ($cancreate) {
                   9954:                     $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>';
                   9955:                 } else {
1.799     bisitz   9956:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  9957:                     my %usertypetext = (
                   9958:                         official   => 'institutional',
                   9959:                         unofficial => 'non-institutional',
                   9960:                     );
1.799     bisitz   9961:                     $new_user_create = '<p class="LC_warning">'
                   9962:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   9963:                                       .' '
                   9964:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   9965:                                           ,'<a href="'.$helplink.'">','</a>')
                   9966:                                       .'</p><br />';
1.627     raeburn  9967:                 }
1.576     raeburn  9968:             }
                   9969:         }
                   9970: 
1.556     raeburn  9971:         $newuserscript = <<"ENDSCRIPT";
                   9972: 
1.570     raeburn  9973: function setSearch(createnew,callingForm) {
1.556     raeburn  9974:     if (createnew == 1) {
1.570     raeburn  9975:         for (var i=0; i<callingForm.srchby.length; i++) {
                   9976:             if (callingForm.srchby.options[i].value == 'uname') {
                   9977:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  9978:             }
                   9979:         }
1.570     raeburn  9980:         for (var i=0; i<callingForm.srchin.length; i++) {
                   9981:             if ( callingForm.srchin.options[i].value == 'dom') {
                   9982: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  9983:             }
                   9984:         }
1.570     raeburn  9985:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   9986:             if (callingForm.srchtype.options[i].value == 'exact') {
                   9987:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  9988:             }
                   9989:         }
1.570     raeburn  9990:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  9991:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  9992:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  9993:             }
                   9994:         }
                   9995:     }
                   9996: }
                   9997: ENDSCRIPT
1.558     albertel 9998: 
1.556     raeburn  9999:     }
                   10000: 
1.555     raeburn  10001:     my $output = <<"END_BLOCK";
1.556     raeburn  10002: <script type="text/javascript">
1.824     bisitz   10003: // <![CDATA[
1.570     raeburn  10004: function validateEntry(callingForm) {
1.558     albertel 10005: 
1.556     raeburn  10006:     var checkok = 1;
1.558     albertel 10007:     var srchin;
1.570     raeburn  10008:     for (var i=0; i<callingForm.srchin.length; i++) {
                   10009: 	if ( callingForm.srchin[i].checked ) {
                   10010: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 10011: 	}
                   10012:     }
                   10013: 
1.570     raeburn  10014:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   10015:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   10016:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   10017:     var srchterm =  callingForm.srchterm.value;
                   10018:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  10019:     var msg = "";
                   10020: 
                   10021:     if (srchterm == "") {
                   10022:         checkok = 0;
1.1075.2.98  raeburn  10023:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  10024:     }
                   10025: 
1.569     raeburn  10026:     if (srchtype== 'begins') {
                   10027:         if (srchterm.length < 2) {
                   10028:             checkok = 0;
1.1075.2.98  raeburn  10029:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  10030:         }
                   10031:     }
                   10032: 
1.556     raeburn  10033:     if (srchtype== 'contains') {
                   10034:         if (srchterm.length < 3) {
                   10035:             checkok = 0;
1.1075.2.98  raeburn  10036:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  10037:         }
                   10038:     }
                   10039:     if (srchin == 'instd') {
                   10040:         if (srchdomain == '') {
                   10041:             checkok = 0;
1.1075.2.98  raeburn  10042:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  10043:         }
                   10044:     }
                   10045:     if (srchin == 'dom') {
                   10046:         if (srchdomain == '') {
                   10047:             checkok = 0;
1.1075.2.98  raeburn  10048:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  10049:         }
                   10050:     }
                   10051:     if (srchby == 'lastfirst') {
                   10052:         if (srchterm.indexOf(",") == -1) {
                   10053:             checkok = 0;
1.1075.2.98  raeburn  10054:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  10055:         }
                   10056:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   10057:             checkok = 0;
1.1075.2.98  raeburn  10058:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  10059:         }
                   10060:     }
                   10061:     if (checkok == 0) {
1.1075.2.98  raeburn  10062:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  10063:         return;
                   10064:     }
                   10065:     if (checkok == 1) {
1.570     raeburn  10066:         callingForm.submit();
1.556     raeburn  10067:     }
                   10068: }
                   10069: 
                   10070: $newuserscript
                   10071: 
1.824     bisitz   10072: // ]]>
1.556     raeburn  10073: </script>
1.558     albertel 10074: 
                   10075: $new_user_create
                   10076: 
1.555     raeburn  10077: END_BLOCK
1.558     albertel 10078: 
1.876     raeburn  10079:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1075.2.98  raeburn  10080:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  10081:                $domform.
                   10082:                &Apache::lonhtmlcommon::row_closure().
1.1075.2.98  raeburn  10083:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  10084:                $srchbysel.
                   10085:                $srchtypesel. 
                   10086:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   10087:                $srchinsel.
                   10088:                &Apache::lonhtmlcommon::row_closure(1). 
                   10089:                &Apache::lonhtmlcommon::end_pick_box().
                   10090:                '<br />';
1.1075.2.114  raeburn  10091:     return ($output,1);
1.555     raeburn  10092: }
                   10093: 
1.612     raeburn  10094: sub user_rule_check {
1.615     raeburn  10095:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1075.2.99  raeburn  10096:     my ($response,%inst_response);
1.612     raeburn  10097:     if (ref($usershash) eq 'HASH') {
1.1075.2.99  raeburn  10098:         if (keys(%{$usershash}) > 1) {
                   10099:             my (%by_username,%by_id,%userdoms);
                   10100:             my $checkid;
1.612     raeburn  10101:             if (ref($checks) eq 'HASH') {
1.1075.2.99  raeburn  10102:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   10103:                     $checkid = 1;
                   10104:                 }
                   10105:             }
                   10106:             foreach my $user (keys(%{$usershash})) {
                   10107:                 my ($uname,$udom) = split(/:/,$user);
                   10108:                 if ($checkid) {
                   10109:                     if (ref($usershash->{$user}) eq 'HASH') {
                   10110:                         if ($usershash->{$user}->{'id'} ne '') {
                   10111:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
                   10112:                             $userdoms{$udom} = 1;
                   10113:                             if (ref($inst_results) eq 'HASH') {
                   10114:                                 $inst_results->{$uname.':'.$udom} = {};
                   10115:                             }
                   10116:                         }
                   10117:                     }
                   10118:                 } else {
                   10119:                     $by_username{$udom}{$uname} = 1;
                   10120:                     $userdoms{$udom} = 1;
                   10121:                     if (ref($inst_results) eq 'HASH') {
                   10122:                         $inst_results->{$uname.':'.$udom} = {};
                   10123:                     }
                   10124:                 }
                   10125:             }
                   10126:             foreach my $udom (keys(%userdoms)) {
                   10127:                 if (!$got_rules->{$udom}) {
                   10128:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10129:                                                              ['usercreation'],$udom);
                   10130:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10131:                         foreach my $item ('username','id') {
                   10132:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10133:                                 $$curr_rules{$udom}{$item} =
                   10134:                                     $domconfig{'usercreation'}{$item.'_rule'};
                   10135:                             }
                   10136:                         }
                   10137:                     }
                   10138:                     $got_rules->{$udom} = 1;
                   10139:                 }
                   10140:             }
                   10141:             if ($checkid) {
                   10142:                 foreach my $udom (keys(%by_id)) {
                   10143:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   10144:                     if ($outcome eq 'ok') {
                   10145:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   10146:                             my $uname = $by_id{$udom}{$id};
                   10147:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10148:                         }
                   10149:                         if (ref($results) eq 'HASH') {
                   10150:                             foreach my $uname (keys(%{$results})) {
                   10151:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   10152:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   10153:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10154:                                 }
                   10155:                             }
                   10156:                         }
                   10157:                     }
1.612     raeburn  10158:                 }
1.615     raeburn  10159:             } else {
1.1075.2.99  raeburn  10160:                 foreach my $udom (keys(%by_username)) {
                   10161:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   10162:                     if ($outcome eq 'ok') {
                   10163:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   10164:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10165:                         }
                   10166:                         if (ref($results) eq 'HASH') {
                   10167:                             foreach my $uname (keys(%{$results})) {
                   10168:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10169:                             }
                   10170:                         }
                   10171:                     }
                   10172:                 }
1.612     raeburn  10173:             }
1.1075.2.99  raeburn  10174:         } elsif (keys(%{$usershash}) == 1) {
                   10175:             my $user = (keys(%{$usershash}))[0];
                   10176:             my ($uname,$udom) = split(/:/,$user);
                   10177:             if (($udom ne '') && ($uname ne '')) {
                   10178:                 if (ref($usershash->{$user}) eq 'HASH') {
                   10179:                     if (ref($checks) eq 'HASH') {
                   10180:                         if (defined($checks->{'username'})) {
                   10181:                             ($inst_response{$user},%{$inst_results->{$user}}) =
                   10182:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   10183:                         } elsif (defined($checks->{'id'})) {
                   10184:                             if ($usershash->{$user}->{'id'} ne '') {
                   10185:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10186:                                     &Apache::lonnet::get_instuser($udom,undef,
                   10187:                                                                   $usershash->{$user}->{'id'});
                   10188:                             } else {
                   10189:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10190:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   10191:                             }
                   10192:                         }
                   10193:                     } else {
                   10194:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   10195:                             &Apache::lonnet::get_instuser($udom,$uname);
                   10196:                        return;
                   10197:                     }
                   10198:                     if (!$got_rules->{$udom}) {
                   10199:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10200:                                                                  ['usercreation'],$udom);
                   10201:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10202:                             foreach my $item ('username','id') {
                   10203:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10204:                                    $$curr_rules{$udom}{$item} =
                   10205:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   10206:                                 }
                   10207:                             }
1.585     raeburn  10208:                         }
1.1075.2.99  raeburn  10209:                         $got_rules->{$udom} = 1;
1.585     raeburn  10210:                     }
                   10211:                 }
1.1075.2.99  raeburn  10212:             } else {
                   10213:                 return;
                   10214:             }
                   10215:         } else {
                   10216:             return;
                   10217:         }
                   10218:         foreach my $user (keys(%{$usershash})) {
                   10219:             my ($uname,$udom) = split(/:/,$user);
                   10220:             next if (($udom eq '') || ($uname eq ''));
                   10221:             my $id;
                   10222:             if (ref($inst_results) eq 'HASH') {
                   10223:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   10224:                     $id = $inst_results->{$user}->{'id'};
                   10225:                 }
                   10226:             }
                   10227:             if ($id eq '') {
                   10228:                 if (ref($usershash->{$user})) {
                   10229:                     $id = $usershash->{$user}->{'id'};
                   10230:                 }
1.585     raeburn  10231:             }
1.612     raeburn  10232:             foreach my $item (keys(%{$checks})) {
                   10233:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   10234:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   10235:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1075.2.99  raeburn  10236:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   10237:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  10238:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   10239:                                 if ($rule_check{$rule}) {
                   10240:                                     $$rulematch{$user}{$item} = $rule;
1.1075.2.99  raeburn  10241:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  10242:                                         if (ref($inst_results) eq 'HASH') {
                   10243:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   10244:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   10245:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1075.2.99  raeburn  10246:                                                 } elsif ($item eq 'id') {
                   10247:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   10248:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   10249:                                                     }
1.615     raeburn  10250:                                                 }
1.612     raeburn  10251:                                             }
                   10252:                                         }
1.615     raeburn  10253:                                     }
                   10254:                                     last;
1.585     raeburn  10255:                                 }
                   10256:                             }
                   10257:                         }
                   10258:                     }
                   10259:                 }
                   10260:             }
                   10261:         }
                   10262:     }
1.612     raeburn  10263:     return;
                   10264: }
                   10265: 
                   10266: sub user_rule_formats {
                   10267:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   10268:     my %text = ( 
                   10269:                  'username' => 'Usernames',
                   10270:                  'id'       => 'IDs',
                   10271:                );
                   10272:     my $output;
                   10273:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   10274:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   10275:         if (@{$ruleorder} > 0) {
1.1075.2.20  raeburn  10276:             $output = '<br />'.
                   10277:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   10278:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   10279:                       ' <ul>';
1.612     raeburn  10280:             foreach my $rule (@{$ruleorder}) {
                   10281:                 if (ref($curr_rules) eq 'ARRAY') {
                   10282:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   10283:                         if (ref($rules->{$rule}) eq 'HASH') {
                   10284:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   10285:                                         $rules->{$rule}{'desc'}.'</li>';
                   10286:                         }
                   10287:                     }
                   10288:                 }
                   10289:             }
                   10290:             $output .= '</ul>';
                   10291:         }
                   10292:     }
                   10293:     return $output;
                   10294: }
                   10295: 
                   10296: sub instrule_disallow_msg {
1.615     raeburn  10297:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  10298:     my $response;
                   10299:     my %text = (
                   10300:                   item   => 'username',
                   10301:                   items  => 'usernames',
                   10302:                   match  => 'matches',
                   10303:                   do     => 'does',
                   10304:                   action => 'a username',
                   10305:                   one    => 'one',
                   10306:                );
                   10307:     if ($count > 1) {
                   10308:         $text{'item'} = 'usernames';
                   10309:         $text{'match'} ='match';
                   10310:         $text{'do'} = 'do';
                   10311:         $text{'action'} = 'usernames',
                   10312:         $text{'one'} = 'ones';
                   10313:     }
                   10314:     if ($checkitem eq 'id') {
                   10315:         $text{'items'} = 'IDs';
                   10316:         $text{'item'} = 'ID';
                   10317:         $text{'action'} = 'an ID';
1.615     raeburn  10318:         if ($count > 1) {
                   10319:             $text{'item'} = 'IDs';
                   10320:             $text{'action'} = 'IDs';
                   10321:         }
1.612     raeburn  10322:     }
1.674     bisitz   10323:     $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  10324:     if ($mode eq 'upload') {
                   10325:         if ($checkitem eq 'username') {
                   10326:             $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'}.");
                   10327:         } elsif ($checkitem eq 'id') {
1.674     bisitz   10328:             $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  10329:         }
1.669     raeburn  10330:     } elsif ($mode eq 'selfcreate') {
                   10331:         if ($checkitem eq 'id') {
                   10332:             $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.");
                   10333:         }
1.615     raeburn  10334:     } else {
                   10335:         if ($checkitem eq 'username') {
                   10336:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   10337:         } elsif ($checkitem eq 'id') {
                   10338:             $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.");
                   10339:         }
1.612     raeburn  10340:     }
                   10341:     return $response;
1.585     raeburn  10342: }
                   10343: 
1.624     raeburn  10344: sub personal_data_fieldtitles {
                   10345:     my %fieldtitles = &Apache::lonlocal::texthash (
                   10346:                         id => 'Student/Employee ID',
                   10347:                         permanentemail => 'E-mail address',
                   10348:                         lastname => 'Last Name',
                   10349:                         firstname => 'First Name',
                   10350:                         middlename => 'Middle Name',
                   10351:                         generation => 'Generation',
                   10352:                         gen => 'Generation',
1.765     raeburn  10353:                         inststatus => 'Affiliation',
1.624     raeburn  10354:                    );
                   10355:     return %fieldtitles;
                   10356: }
                   10357: 
1.642     raeburn  10358: sub sorted_inst_types {
                   10359:     my ($dom) = @_;
1.1075.2.70  raeburn  10360:     my ($usertypes,$order);
                   10361:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   10362:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   10363:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   10364:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   10365:     } else {
                   10366:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   10367:     }
1.642     raeburn  10368:     my $othertitle = &mt('All users');
                   10369:     if ($env{'request.course.id'}) {
1.668     raeburn  10370:         $othertitle  = &mt('Any users');
1.642     raeburn  10371:     }
                   10372:     my @types;
                   10373:     if (ref($order) eq 'ARRAY') {
                   10374:         @types = @{$order};
                   10375:     }
                   10376:     if (@types == 0) {
                   10377:         if (ref($usertypes) eq 'HASH') {
                   10378:             @types = sort(keys(%{$usertypes}));
                   10379:         }
                   10380:     }
                   10381:     if (keys(%{$usertypes}) > 0) {
                   10382:         $othertitle = &mt('Other users');
                   10383:     }
                   10384:     return ($othertitle,$usertypes,\@types);
                   10385: }
                   10386: 
1.645     raeburn  10387: sub get_institutional_codes {
                   10388:     my ($settings,$allcourses,$LC_code) = @_;
                   10389: # Get complete list of course sections to update
                   10390:     my @currsections = ();
                   10391:     my @currxlists = ();
                   10392:     my $coursecode = $$settings{'internal.coursecode'};
                   10393: 
                   10394:     if ($$settings{'internal.sectionnums'} ne '') {
                   10395:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   10396:     }
                   10397: 
                   10398:     if ($$settings{'internal.crosslistings'} ne '') {
                   10399:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   10400:     }
                   10401: 
                   10402:     if (@currxlists > 0) {
                   10403:         foreach (@currxlists) {
                   10404:             if (m/^([^:]+):(\w*)$/) {
                   10405:                 unless (grep/^$1$/,@{$allcourses}) {
1.1075.2.119  raeburn  10406:                     push(@{$allcourses},$1);
1.645     raeburn  10407:                     $$LC_code{$1} = $2;
                   10408:                 }
                   10409:             }
                   10410:         }
                   10411:     }
                   10412:  
                   10413:     if (@currsections > 0) {
                   10414:         foreach (@currsections) {
                   10415:             if (m/^(\w+):(\w*)$/) {
                   10416:                 my $sec = $coursecode.$1;
                   10417:                 my $lc_sec = $2;
                   10418:                 unless (grep/^$sec$/,@{$allcourses}) {
1.1075.2.119  raeburn  10419:                     push(@{$allcourses},$sec);
1.645     raeburn  10420:                     $$LC_code{$sec} = $lc_sec;
                   10421:                 }
                   10422:             }
                   10423:         }
                   10424:     }
                   10425:     return;
                   10426: }
                   10427: 
1.971     raeburn  10428: sub get_standard_codeitems {
                   10429:     return ('Year','Semester','Department','Number','Section');
                   10430: }
                   10431: 
1.112     bowersj2 10432: =pod
                   10433: 
1.780     raeburn  10434: =head1 Slot Helpers
                   10435: 
                   10436: =over 4
                   10437: 
                   10438: =item * sorted_slots()
                   10439: 
1.1040    raeburn  10440: Sorts an array of slot names in order of an optional sort key,
                   10441: default sort is by slot start time (earliest first). 
1.780     raeburn  10442: 
                   10443: Inputs:
                   10444: 
                   10445: =over 4
                   10446: 
                   10447: slotsarr  - Reference to array of unsorted slot names.
                   10448: 
                   10449: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   10450: 
1.1040    raeburn  10451: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   10452: 
1.549     albertel 10453: =back
                   10454: 
1.780     raeburn  10455: Returns:
                   10456: 
                   10457: =over 4
                   10458: 
1.1040    raeburn  10459: sorted   - An array of slot names sorted by a specified sort key 
                   10460:            (default sort key is start time of the slot).
1.780     raeburn  10461: 
                   10462: =back
                   10463: 
                   10464: =cut
                   10465: 
                   10466: 
                   10467: sub sorted_slots {
1.1040    raeburn  10468:     my ($slotsarr,$slots,$sortkey) = @_;
                   10469:     if ($sortkey eq '') {
                   10470:         $sortkey = 'starttime';
                   10471:     }
1.780     raeburn  10472:     my @sorted;
                   10473:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   10474:         @sorted =
                   10475:             sort {
                   10476:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  10477:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  10478:                      }
                   10479:                      if (ref($slots->{$a})) { return -1;}
                   10480:                      if (ref($slots->{$b})) { return 1;}
                   10481:                      return 0;
                   10482:                  } @{$slotsarr};
                   10483:     }
                   10484:     return @sorted;
                   10485: }
                   10486: 
1.1040    raeburn  10487: =pod
                   10488: 
                   10489: =item * get_future_slots()
                   10490: 
                   10491: Inputs:
                   10492: 
                   10493: =over 4
                   10494: 
                   10495: cnum - course number
                   10496: 
                   10497: cdom - course domain
                   10498: 
                   10499: now - current UNIX time
                   10500: 
                   10501: symb - optional symb
                   10502: 
                   10503: =back
                   10504: 
                   10505: Returns:
                   10506: 
                   10507: =over 4
                   10508: 
                   10509: sorted_reservable - ref to array of student_schedulable slots currently 
                   10510:                     reservable, ordered by end date of reservation period.
                   10511: 
                   10512: reservable_now - ref to hash of student_schedulable slots currently
                   10513:                  reservable.
                   10514: 
                   10515:     Keys in inner hash are:
                   10516:     (a) symb: either blank or symb to which slot use is restricted.
1.1075.2.104  raeburn  10517:     (b) endreserve: end date of reservation period.
                   10518:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10519:         selected.
1.1040    raeburn  10520: 
                   10521: sorted_future - ref to array of student_schedulable slots reservable in
                   10522:                 the future, ordered by start date of reservation period.
                   10523: 
                   10524: future_reservable - ref to hash of student_schedulable slots reservable
                   10525:                     in the future.
                   10526: 
                   10527:     Keys in inner hash are:
                   10528:     (a) symb: either blank or symb to which slot use is restricted.
                   10529:     (b) startreserve:  start date of reservation period.
1.1075.2.104  raeburn  10530:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10531:         selected.
1.1040    raeburn  10532: 
                   10533: =back
                   10534: 
                   10535: =cut
                   10536: 
                   10537: sub get_future_slots {
                   10538:     my ($cnum,$cdom,$now,$symb) = @_;
                   10539:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   10540:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   10541:     foreach my $slot (keys(%slots)) {
                   10542:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   10543:         if ($symb) {
                   10544:             next if (($slots{$slot}->{'symb'} ne '') && 
                   10545:                      ($slots{$slot}->{'symb'} ne $symb));
                   10546:         }
                   10547:         if (($slots{$slot}->{'starttime'} > $now) &&
                   10548:             ($slots{$slot}->{'endtime'} > $now)) {
                   10549:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   10550:                 my $userallowed = 0;
                   10551:                 if ($slots{$slot}->{'allowedsections'}) {
                   10552:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   10553:                     if (!defined($env{'request.role.sec'})
                   10554:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   10555:                         $userallowed=1;
                   10556:                     } else {
                   10557:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   10558:                             $userallowed=1;
                   10559:                         }
                   10560:                     }
                   10561:                     unless ($userallowed) {
                   10562:                         if (defined($env{'request.course.groups'})) {
                   10563:                             my @groups = split(/:/,$env{'request.course.groups'});
                   10564:                             foreach my $group (@groups) {
                   10565:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   10566:                                     $userallowed=1;
                   10567:                                     last;
                   10568:                                 }
                   10569:                             }
                   10570:                         }
                   10571:                     }
                   10572:                 }
                   10573:                 if ($slots{$slot}->{'allowedusers'}) {
                   10574:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   10575:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   10576:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   10577:                         $userallowed = 1;
                   10578:                     }
                   10579:                 }
                   10580:                 next unless($userallowed);
                   10581:             }
                   10582:             my $startreserve = $slots{$slot}->{'startreserve'};
                   10583:             my $endreserve = $slots{$slot}->{'endreserve'};
                   10584:             my $symb = $slots{$slot}->{'symb'};
1.1075.2.104  raeburn  10585:             my $uniqueperiod;
                   10586:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   10587:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   10588:             }
1.1040    raeburn  10589:             if (($startreserve < $now) &&
                   10590:                 (!$endreserve || $endreserve > $now)) {
                   10591:                 my $lastres = $endreserve;
                   10592:                 if (!$lastres) {
                   10593:                     $lastres = $slots{$slot}->{'starttime'};
                   10594:                 }
                   10595:                 $reservable_now{$slot} = {
                   10596:                                            symb       => $symb,
1.1075.2.104  raeburn  10597:                                            endreserve => $lastres,
                   10598:                                            uniqueperiod => $uniqueperiod,   
1.1040    raeburn  10599:                                          };
                   10600:             } elsif (($startreserve > $now) &&
                   10601:                      (!$endreserve || $endreserve > $startreserve)) {
                   10602:                 $future_reservable{$slot} = {
                   10603:                                               symb         => $symb,
1.1075.2.104  raeburn  10604:                                               startreserve => $startreserve,
                   10605:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  10606:                                             };
                   10607:             }
                   10608:         }
                   10609:     }
                   10610:     my @unsorted_reservable = keys(%reservable_now);
                   10611:     if (@unsorted_reservable > 0) {
                   10612:         @sorted_reservable = 
                   10613:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   10614:     }
                   10615:     my @unsorted_future = keys(%future_reservable);
                   10616:     if (@unsorted_future > 0) {
                   10617:         @sorted_future =
                   10618:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   10619:     }
                   10620:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   10621: }
1.780     raeburn  10622: 
                   10623: =pod
                   10624: 
1.1057    foxr     10625: =back
                   10626: 
1.549     albertel 10627: =head1 HTTP Helpers
                   10628: 
                   10629: =over 4
                   10630: 
1.648     raeburn  10631: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 10632: 
1.258     albertel 10633: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 10634: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 10635: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 10636: 
                   10637: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   10638: $possible_names is an ref to an array of form element names.  As an example:
                   10639: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 10640: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 10641: 
                   10642: =cut
1.1       albertel 10643: 
1.6       albertel 10644: sub get_unprocessed_cgi {
1.25      albertel 10645:   my ($query,$possible_names)= @_;
1.26      matthew  10646:   # $Apache::lonxml::debug=1;
1.356     albertel 10647:   foreach my $pair (split(/&/,$query)) {
                   10648:     my ($name, $value) = split(/=/,$pair);
1.369     www      10649:     $name = &unescape($name);
1.25      albertel 10650:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   10651:       $value =~ tr/+/ /;
                   10652:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 10653:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 10654:     }
1.16      harris41 10655:   }
1.6       albertel 10656: }
                   10657: 
1.112     bowersj2 10658: =pod
                   10659: 
1.648     raeburn  10660: =item * &cacheheader() 
1.112     bowersj2 10661: 
                   10662: returns cache-controlling header code
                   10663: 
                   10664: =cut
                   10665: 
1.7       albertel 10666: sub cacheheader {
1.258     albertel 10667:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 10668:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   10669:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 10670:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   10671:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 10672:     return $output;
1.7       albertel 10673: }
                   10674: 
1.112     bowersj2 10675: =pod
                   10676: 
1.648     raeburn  10677: =item * &no_cache($r) 
1.112     bowersj2 10678: 
                   10679: specifies header code to not have cache
                   10680: 
                   10681: =cut
                   10682: 
1.9       albertel 10683: sub no_cache {
1.216     albertel 10684:     my ($r) = @_;
                   10685:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 10686: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 10687:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   10688:     $r->no_cache(1);
                   10689:     $r->header_out("Expires" => $date);
                   10690:     $r->header_out("Pragma" => "no-cache");
1.123     www      10691: }
                   10692: 
                   10693: sub content_type {
1.181     albertel 10694:     my ($r,$type,$charset) = @_;
1.299     foxr     10695:     if ($r) {
                   10696: 	#  Note that printout.pl calls this with undef for $r.
                   10697: 	&no_cache($r);
                   10698:     }
1.258     albertel 10699:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 10700:     unless ($charset) {
                   10701: 	$charset=&Apache::lonlocal::current_encoding;
                   10702:     }
                   10703:     if ($charset) { $type.='; charset='.$charset; }
                   10704:     if ($r) {
                   10705: 	$r->content_type($type);
                   10706:     } else {
                   10707: 	print("Content-type: $type\n\n");
                   10708:     }
1.9       albertel 10709: }
1.25      albertel 10710: 
1.112     bowersj2 10711: =pod
                   10712: 
1.648     raeburn  10713: =item * &add_to_env($name,$value) 
1.112     bowersj2 10714: 
1.258     albertel 10715: adds $name to the %env hash with value
1.112     bowersj2 10716: $value, if $name already exists, the entry is converted to an array
                   10717: reference and $value is added to the array.
                   10718: 
                   10719: =cut
                   10720: 
1.25      albertel 10721: sub add_to_env {
                   10722:   my ($name,$value)=@_;
1.258     albertel 10723:   if (defined($env{$name})) {
                   10724:     if (ref($env{$name})) {
1.25      albertel 10725:       #already have multiple values
1.258     albertel 10726:       push(@{ $env{$name} },$value);
1.25      albertel 10727:     } else {
                   10728:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 10729:       my $first=$env{$name};
                   10730:       undef($env{$name});
                   10731:       push(@{ $env{$name} },$first,$value);
1.25      albertel 10732:     }
                   10733:   } else {
1.258     albertel 10734:     $env{$name}=$value;
1.25      albertel 10735:   }
1.31      albertel 10736: }
1.149     albertel 10737: 
                   10738: =pod
                   10739: 
1.648     raeburn  10740: =item * &get_env_multiple($name) 
1.149     albertel 10741: 
1.258     albertel 10742: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 10743: values may be defined and end up as an array ref.
                   10744: 
                   10745: returns an array of values
                   10746: 
                   10747: =cut
                   10748: 
                   10749: sub get_env_multiple {
                   10750:     my ($name) = @_;
                   10751:     my @values;
1.258     albertel 10752:     if (defined($env{$name})) {
1.149     albertel 10753:         # exists is it an array
1.258     albertel 10754:         if (ref($env{$name})) {
                   10755:             @values=@{ $env{$name} };
1.149     albertel 10756:         } else {
1.258     albertel 10757:             $values[0]=$env{$name};
1.149     albertel 10758:         }
                   10759:     }
                   10760:     return(@values);
                   10761: }
                   10762: 
1.660     raeburn  10763: sub ask_for_embedded_content {
                   10764:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  10765:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11  raeburn  10766:         %currsubfile,%unused,$rem);
1.1071    raeburn  10767:     my $counter = 0;
                   10768:     my $numnew = 0;
1.987     raeburn  10769:     my $numremref = 0;
                   10770:     my $numinvalid = 0;
                   10771:     my $numpathchg = 0;
                   10772:     my $numexisting = 0;
1.1071    raeburn  10773:     my $numunused = 0;
                   10774:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1075.2.53  raeburn  10775:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  10776:     my $heading = &mt('Upload embedded files');
                   10777:     my $buttontext = &mt('Upload');
                   10778: 
1.1075.2.11  raeburn  10779:     if ($env{'request.course.id'}) {
1.1075.2.35  raeburn  10780:         if ($actionurl eq '/adm/dependencies') {
                   10781:             $navmap = Apache::lonnavmaps::navmap->new();
                   10782:         }
                   10783:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10784:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11  raeburn  10785:     }
1.1075.2.35  raeburn  10786:     if (($actionurl eq '/adm/portfolio') ||
                   10787:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  10788:         my $current_path='/';
                   10789:         if ($env{'form.currentpath'}) {
                   10790:             $current_path = $env{'form.currentpath'};
                   10791:         }
                   10792:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35  raeburn  10793:             $udom = $cdom;
                   10794:             $uname = $cnum;
1.984     raeburn  10795:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   10796:         } else {
                   10797:             $udom = $env{'user.domain'};
                   10798:             $uname = $env{'user.name'};
                   10799:             $url = '/userfiles/portfolio';
                   10800:         }
1.987     raeburn  10801:         $toplevel = $url.'/';
1.984     raeburn  10802:         $url .= $current_path;
                   10803:         $getpropath = 1;
1.987     raeburn  10804:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   10805:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      10806:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  10807:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  10808:         $toplevel = $url;
1.984     raeburn  10809:         if ($rest ne '') {
1.987     raeburn  10810:             $url .= $rest;
                   10811:         }
                   10812:     } elsif ($actionurl eq '/adm/coursedocs') {
                   10813:         if (ref($args) eq 'HASH') {
1.1071    raeburn  10814:             $url = $args->{'docs_url'};
                   10815:             $toplevel = $url;
1.1075.2.11  raeburn  10816:             if ($args->{'context'} eq 'paste') {
                   10817:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   10818:                 ($path) =
                   10819:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   10820:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   10821:                 $fileloc =~ s{^/}{};
                   10822:             }
1.1071    raeburn  10823:         }
                   10824:     } elsif ($actionurl eq '/adm/dependencies') {
                   10825:         if ($env{'request.course.id'} ne '') {
                   10826:             if (ref($args) eq 'HASH') {
                   10827:                 $url = $args->{'docs_url'};
                   10828:                 $title = $args->{'docs_title'};
1.1075.2.35  raeburn  10829:                 $toplevel = $url;
                   10830:                 unless ($toplevel =~ m{^/}) {
                   10831:                     $toplevel = "/$url";
                   10832:                 }
1.1075.2.11  raeburn  10833:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35  raeburn  10834:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   10835:                     $path = $1;
                   10836:                 } else {
                   10837:                     ($path) =
                   10838:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   10839:                 }
1.1075.2.79  raeburn  10840:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   10841:                     $fileloc = $toplevel;
                   10842:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   10843:                     my ($udom,$uname,$fname) =
                   10844:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   10845:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   10846:                 } else {
                   10847:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   10848:                 }
1.1071    raeburn  10849:                 $fileloc =~ s{^/}{};
                   10850:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   10851:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   10852:             }
1.987     raeburn  10853:         }
1.1075.2.35  raeburn  10854:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   10855:         $udom = $cdom;
                   10856:         $uname = $cnum;
                   10857:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   10858:         $toplevel = $url;
                   10859:         $path = $url;
                   10860:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   10861:         $fileloc =~ s{^/}{};
                   10862:     }
                   10863:     foreach my $file (keys(%{$allfiles})) {
                   10864:         my $embed_file;
                   10865:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   10866:             $embed_file = $1;
                   10867:         } else {
                   10868:             $embed_file = $file;
                   10869:         }
1.1075.2.55  raeburn  10870:         my ($absolutepath,$cleaned_file);
                   10871:         if ($embed_file =~ m{^\w+://}) {
                   10872:             $cleaned_file = $embed_file;
1.1075.2.47  raeburn  10873:             $newfiles{$cleaned_file} = 1;
                   10874:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  10875:         } else {
1.1075.2.55  raeburn  10876:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  10877:             if ($embed_file =~ m{^/}) {
                   10878:                 $absolutepath = $embed_file;
                   10879:             }
1.1075.2.47  raeburn  10880:             if ($cleaned_file =~ m{/}) {
                   10881:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  10882:                 $path = &check_for_traversal($path,$url,$toplevel);
                   10883:                 my $item = $fname;
                   10884:                 if ($path ne '') {
                   10885:                     $item = $path.'/'.$fname;
                   10886:                     $subdependencies{$path}{$fname} = 1;
                   10887:                 } else {
                   10888:                     $dependencies{$item} = 1;
                   10889:                 }
                   10890:                 if ($absolutepath) {
                   10891:                     $mapping{$item} = $absolutepath;
                   10892:                 } else {
                   10893:                     $mapping{$item} = $embed_file;
                   10894:                 }
                   10895:             } else {
                   10896:                 $dependencies{$embed_file} = 1;
                   10897:                 if ($absolutepath) {
1.1075.2.47  raeburn  10898:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  10899:                 } else {
1.1075.2.47  raeburn  10900:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  10901:                 }
                   10902:             }
1.984     raeburn  10903:         }
                   10904:     }
1.1071    raeburn  10905:     my $dirptr = 16384;
1.984     raeburn  10906:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  10907:         $currsubfile{$path} = {};
1.1075.2.35  raeburn  10908:         if (($actionurl eq '/adm/portfolio') ||
                   10909:             ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  10910:             my ($sublistref,$listerror) =
                   10911:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   10912:             if (ref($sublistref) eq 'ARRAY') {
                   10913:                 foreach my $line (@{$sublistref}) {
                   10914:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  10915:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  10916:                 }
1.984     raeburn  10917:             }
1.987     raeburn  10918:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  10919:             if (opendir(my $dir,$url.'/'.$path)) {
                   10920:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  10921:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   10922:             }
1.1075.2.11  raeburn  10923:         } elsif (($actionurl eq '/adm/dependencies') ||
                   10924:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  10925:                   ($args->{'context'} eq 'paste')) ||
                   10926:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  10927:             if ($env{'request.course.id'} ne '') {
1.1075.2.35  raeburn  10928:                 my $dir;
                   10929:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   10930:                     $dir = $fileloc;
                   10931:                 } else {
                   10932:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   10933:                 }
1.1071    raeburn  10934:                 if ($dir ne '') {
                   10935:                     my ($sublistref,$listerror) =
                   10936:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   10937:                     if (ref($sublistref) eq 'ARRAY') {
                   10938:                         foreach my $line (@{$sublistref}) {
                   10939:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   10940:                                 undef,$mtime)=split(/\&/,$line,12);
                   10941:                             unless (($testdir&$dirptr) ||
                   10942:                                     ($file_name =~ /^\.\.?$/)) {
                   10943:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   10944:                             }
                   10945:                         }
                   10946:                     }
                   10947:                 }
1.984     raeburn  10948:             }
                   10949:         }
                   10950:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  10951:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  10952:                 my $item = $path.'/'.$file;
                   10953:                 unless ($mapping{$item} eq $item) {
                   10954:                     $pathchanges{$item} = 1;
                   10955:                 }
                   10956:                 $existing{$item} = 1;
                   10957:                 $numexisting ++;
                   10958:             } else {
                   10959:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  10960:             }
                   10961:         }
1.1071    raeburn  10962:         if ($actionurl eq '/adm/dependencies') {
                   10963:             foreach my $path (keys(%currsubfile)) {
                   10964:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   10965:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   10966:                          unless ($subdependencies{$path}{$file}) {
1.1075.2.11  raeburn  10967:                              next if (($rem ne '') &&
                   10968:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   10969:                                        (ref($navmap) &&
                   10970:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   10971:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   10972:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  10973:                              $unused{$path.'/'.$file} = 1; 
                   10974:                          }
                   10975:                     }
                   10976:                 }
                   10977:             }
                   10978:         }
1.984     raeburn  10979:     }
1.987     raeburn  10980:     my %currfile;
1.1075.2.35  raeburn  10981:     if (($actionurl eq '/adm/portfolio') ||
                   10982:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  10983:         my ($dirlistref,$listerror) =
                   10984:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   10985:         if (ref($dirlistref) eq 'ARRAY') {
                   10986:             foreach my $line (@{$dirlistref}) {
                   10987:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   10988:                 $currfile{$file_name} = 1;
                   10989:             }
1.984     raeburn  10990:         }
1.987     raeburn  10991:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  10992:         if (opendir(my $dir,$url)) {
1.987     raeburn  10993:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  10994:             map {$currfile{$_} = 1;} @dir_list;
                   10995:         }
1.1075.2.11  raeburn  10996:     } elsif (($actionurl eq '/adm/dependencies') ||
                   10997:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  10998:               ($args->{'context'} eq 'paste')) ||
                   10999:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11000:         if ($env{'request.course.id'} ne '') {
                   11001:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11002:             if ($dir ne '') {
                   11003:                 my ($dirlistref,$listerror) =
                   11004:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   11005:                 if (ref($dirlistref) eq 'ARRAY') {
                   11006:                     foreach my $line (@{$dirlistref}) {
                   11007:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   11008:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   11009:                         unless (($testdir&$dirptr) ||
                   11010:                                 ($file_name =~ /^\.\.?$/)) {
                   11011:                             $currfile{$file_name} = [$size,$mtime];
                   11012:                         }
                   11013:                     }
                   11014:                 }
                   11015:             }
                   11016:         }
1.984     raeburn  11017:     }
                   11018:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  11019:         if (exists($currfile{$file})) {
1.987     raeburn  11020:             unless ($mapping{$file} eq $file) {
                   11021:                 $pathchanges{$file} = 1;
                   11022:             }
                   11023:             $existing{$file} = 1;
                   11024:             $numexisting ++;
                   11025:         } else {
1.984     raeburn  11026:             $newfiles{$file} = 1;
                   11027:         }
                   11028:     }
1.1071    raeburn  11029:     foreach my $file (keys(%currfile)) {
                   11030:         unless (($file eq $filename) ||
                   11031:                 ($file eq $filename.'.bak') ||
                   11032:                 ($dependencies{$file})) {
1.1075.2.11  raeburn  11033:             if ($actionurl eq '/adm/dependencies') {
1.1075.2.35  raeburn  11034:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   11035:                     next if (($rem ne '') &&
                   11036:                              (($env{"httpref.$rem".$file} ne '') ||
                   11037:                               (ref($navmap) &&
                   11038:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   11039:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11040:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   11041:                 }
1.1075.2.11  raeburn  11042:             }
1.1071    raeburn  11043:             $unused{$file} = 1;
                   11044:         }
                   11045:     }
1.1075.2.11  raeburn  11046:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   11047:         ($args->{'context'} eq 'paste')) {
                   11048:         $counter = scalar(keys(%existing));
                   11049:         $numpathchg = scalar(keys(%pathchanges));
                   11050:         return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35  raeburn  11051:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
                   11052:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   11053:         $counter = scalar(keys(%existing));
                   11054:         $numpathchg = scalar(keys(%pathchanges));
                   11055:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11  raeburn  11056:     }
1.984     raeburn  11057:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  11058:         if ($actionurl eq '/adm/dependencies') {
                   11059:             next if ($embed_file =~ m{^\w+://});
                   11060:         }
1.660     raeburn  11061:         $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11062:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  11063:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  11064:         unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35  raeburn  11065:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   11066:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  11067:         }
1.1075.2.35  raeburn  11068:         $upload_output .= '</td>';
1.1071    raeburn  11069:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1075.2.35  raeburn  11070:             $upload_output.='<td align="right">'.
                   11071:                             '<span class="LC_info LC_fontsize_medium">'.
                   11072:                             &mt("URL points to web address").'</span>';
1.987     raeburn  11073:             $numremref++;
1.660     raeburn  11074:         } elsif ($args->{'error_on_invalid_names'}
                   11075:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35  raeburn  11076:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   11077:                             &mt('Invalid characters').'</span>';
1.987     raeburn  11078:             $numinvalid++;
1.660     raeburn  11079:         } else {
1.1075.2.35  raeburn  11080:             $upload_output .= '<td>'.
                   11081:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  11082:                                                      $embed_file,\%mapping,
1.1071    raeburn  11083:                                                      $allfiles,$codebase,'upload');
                   11084:             $counter ++;
                   11085:             $numnew ++;
1.987     raeburn  11086:         }
                   11087:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   11088:     }
                   11089:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  11090:         if ($actionurl eq '/adm/dependencies') {
                   11091:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   11092:             $modify_output .= &start_data_table_row().
                   11093:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   11094:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   11095:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   11096:                               '<td>'.$size.'</td>'.
                   11097:                               '<td>'.$mtime.'</td>'.
                   11098:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   11099:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   11100:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   11101:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   11102:                               &embedded_file_element('upload_embedded',$counter,
                   11103:                                                      $embed_file,\%mapping,
                   11104:                                                      $allfiles,$codebase,'modify').
                   11105:                               '</div></td>'.
                   11106:                               &end_data_table_row()."\n";
                   11107:             $counter ++;
                   11108:         } else {
                   11109:             $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11110:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   11111:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   11112:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  11113:                               &Apache::loncommon::end_data_table_row()."\n";
                   11114:         }
                   11115:     }
                   11116:     my $delidx = $counter;
                   11117:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   11118:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   11119:         $delete_output .= &start_data_table_row().
                   11120:                           '<td><img src="'.&icon($oldfile).'" />'.
                   11121:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   11122:                           '<td>'.$size.'</td>'.
                   11123:                           '<td>'.$mtime.'</td>'.
                   11124:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   11125:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   11126:                           &embedded_file_element('upload_embedded',$delidx,
                   11127:                                                  $oldfile,\%mapping,$allfiles,
                   11128:                                                  $codebase,'delete').'</td>'.
                   11129:                           &end_data_table_row()."\n"; 
                   11130:         $numunused ++;
                   11131:         $delidx ++;
1.987     raeburn  11132:     }
                   11133:     if ($upload_output) {
                   11134:         $upload_output = &start_data_table().
                   11135:                          $upload_output.
                   11136:                          &end_data_table()."\n";
                   11137:     }
1.1071    raeburn  11138:     if ($modify_output) {
                   11139:         $modify_output = &start_data_table().
                   11140:                          &start_data_table_header_row().
                   11141:                          '<th>'.&mt('File').'</th>'.
                   11142:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11143:                          '<th>'.&mt('Modified').'</th>'.
                   11144:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   11145:                          &end_data_table_header_row().
                   11146:                          $modify_output.
                   11147:                          &end_data_table()."\n";
                   11148:     }
                   11149:     if ($delete_output) {
                   11150:         $delete_output = &start_data_table().
                   11151:                          &start_data_table_header_row().
                   11152:                          '<th>'.&mt('File').'</th>'.
                   11153:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11154:                          '<th>'.&mt('Modified').'</th>'.
                   11155:                          '<th>'.&mt('Delete?').'</th>'.
                   11156:                          &end_data_table_header_row().
                   11157:                          $delete_output.
                   11158:                          &end_data_table()."\n";
                   11159:     }
1.987     raeburn  11160:     my $applies = 0;
                   11161:     if ($numremref) {
                   11162:         $applies ++;
                   11163:     }
                   11164:     if ($numinvalid) {
                   11165:         $applies ++;
                   11166:     }
                   11167:     if ($numexisting) {
                   11168:         $applies ++;
                   11169:     }
1.1071    raeburn  11170:     if ($counter || $numunused) {
1.987     raeburn  11171:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   11172:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  11173:                   $state.'<h3>'.$heading.'</h3>'; 
                   11174:         if ($actionurl eq '/adm/dependencies') {
                   11175:             if ($numnew) {
                   11176:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   11177:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   11178:                            $upload_output.'<br />'."\n";
                   11179:             }
                   11180:             if ($numexisting) {
                   11181:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   11182:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   11183:                            $modify_output.'<br />'."\n";
                   11184:                            $buttontext = &mt('Save changes');
                   11185:             }
                   11186:             if ($numunused) {
                   11187:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   11188:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   11189:                            $delete_output.'<br />'."\n";
                   11190:                            $buttontext = &mt('Save changes');
                   11191:             }
                   11192:         } else {
                   11193:             $output .= $upload_output.'<br />'."\n";
                   11194:         }
                   11195:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   11196:                    $counter.'" />'."\n";
                   11197:         if ($actionurl eq '/adm/dependencies') { 
                   11198:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   11199:                        $numnew.'" />'."\n";
                   11200:         } elsif ($actionurl eq '') {
1.987     raeburn  11201:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   11202:         }
                   11203:     } elsif ($applies) {
                   11204:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   11205:         if ($applies > 1) {
                   11206:             $output .=  
1.1075.2.35  raeburn  11207:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  11208:             if ($numremref) {
                   11209:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   11210:             }
                   11211:             if ($numinvalid) {
                   11212:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   11213:             }
                   11214:             if ($numexisting) {
                   11215:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   11216:             }
                   11217:             $output .= '</ul><br />';
                   11218:         } elsif ($numremref) {
                   11219:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   11220:         } elsif ($numinvalid) {
                   11221:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   11222:         } elsif ($numexisting) {
                   11223:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   11224:         }
                   11225:         $output .= $upload_output.'<br />';
                   11226:     }
                   11227:     my ($pathchange_output,$chgcount);
1.1071    raeburn  11228:     $chgcount = $counter;
1.987     raeburn  11229:     if (keys(%pathchanges) > 0) {
                   11230:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  11231:             if ($counter) {
1.987     raeburn  11232:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   11233:                                                   $embed_file,\%mapping,
1.1071    raeburn  11234:                                                   $allfiles,$codebase,'change');
1.987     raeburn  11235:             } else {
                   11236:                 $pathchange_output .= 
                   11237:                     &start_data_table_row().
                   11238:                     '<td><input type ="checkbox" name="namechange" value="'.
                   11239:                     $chgcount.'" checked="checked" /></td>'.
                   11240:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   11241:                     '<td>'.$embed_file.
                   11242:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  11243:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  11244:                     '</td>'.&end_data_table_row();
1.660     raeburn  11245:             }
1.987     raeburn  11246:             $numpathchg ++;
                   11247:             $chgcount ++;
1.660     raeburn  11248:         }
                   11249:     }
1.1075.2.35  raeburn  11250:     if (($counter) || ($numunused)) {
1.987     raeburn  11251:         if ($numpathchg) {
                   11252:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   11253:                        $numpathchg.'" />'."\n";
                   11254:         }
                   11255:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   11256:             ($actionurl eq '/adm/imsimport')) {
                   11257:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   11258:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   11259:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  11260:         } elsif ($actionurl eq '/adm/dependencies') {
                   11261:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  11262:         }
1.1075.2.35  raeburn  11263:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  11264:     } elsif ($numpathchg) {
                   11265:         my %pathchange = ();
                   11266:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   11267:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11268:             $output .= '<p>'.&mt('or').'</p>'; 
1.1075.2.35  raeburn  11269:         }
1.987     raeburn  11270:     }
1.1071    raeburn  11271:     return ($output,$counter,$numpathchg);
1.987     raeburn  11272: }
                   11273: 
1.1075.2.47  raeburn  11274: =pod
                   11275: 
                   11276: =item * clean_path($name)
                   11277: 
                   11278: Performs clean-up of directories, subdirectories and filename in an
                   11279: embedded object, referenced in an HTML file which is being uploaded
                   11280: to a course or portfolio, where
                   11281: "Upload embedded images/multimedia files if HTML file" checkbox was
                   11282: checked.
                   11283: 
                   11284: Clean-up is similar to replacements in lonnet::clean_filename()
                   11285: except each / between sub-directory and next level is preserved.
                   11286: 
                   11287: =cut
                   11288: 
                   11289: sub clean_path {
                   11290:     my ($embed_file) = @_;
                   11291:     $embed_file =~s{^/+}{};
                   11292:     my @contents;
                   11293:     if ($embed_file =~ m{/}) {
                   11294:         @contents = split(/\//,$embed_file);
                   11295:     } else {
                   11296:         @contents = ($embed_file);
                   11297:     }
                   11298:     my $lastidx = scalar(@contents)-1;
                   11299:     for (my $i=0; $i<=$lastidx; $i++) {
                   11300:         $contents[$i]=~s{\\}{/}g;
                   11301:         $contents[$i]=~s/\s+/\_/g;
                   11302:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   11303:         if ($i == $lastidx) {
                   11304:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   11305:         }
                   11306:     }
                   11307:     if ($lastidx > 0) {
                   11308:         return join('/',@contents);
                   11309:     } else {
                   11310:         return $contents[0];
                   11311:     }
                   11312: }
                   11313: 
1.987     raeburn  11314: sub embedded_file_element {
1.1071    raeburn  11315:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  11316:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   11317:                    (ref($codebase) eq 'HASH'));
                   11318:     my $output;
1.1071    raeburn  11319:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  11320:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   11321:     }
                   11322:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   11323:                &escape($embed_file).'" />';
                   11324:     unless (($context eq 'upload_embedded') && 
                   11325:             ($mapping->{$embed_file} eq $embed_file)) {
                   11326:         $output .='
                   11327:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   11328:     }
                   11329:     my $attrib;
                   11330:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   11331:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   11332:     }
                   11333:     $output .=
                   11334:         "\n\t\t".
                   11335:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   11336:         $attrib.'" />';
                   11337:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   11338:         $output .=
                   11339:             "\n\t\t".
                   11340:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   11341:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  11342:     }
1.987     raeburn  11343:     return $output;
1.660     raeburn  11344: }
                   11345: 
1.1071    raeburn  11346: sub get_dependency_details {
                   11347:     my ($currfile,$currsubfile,$embed_file) = @_;
                   11348:     my ($size,$mtime,$showsize,$showmtime);
                   11349:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   11350:         if ($embed_file =~ m{/}) {
                   11351:             my ($path,$fname) = split(/\//,$embed_file);
                   11352:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   11353:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   11354:             }
                   11355:         } else {
                   11356:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   11357:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   11358:             }
                   11359:         }
                   11360:         $showsize = $size/1024.0;
                   11361:         $showsize = sprintf("%.1f",$showsize);
                   11362:         if ($mtime > 0) {
                   11363:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   11364:         }
                   11365:     }
                   11366:     return ($showsize,$showmtime);
                   11367: }
                   11368: 
                   11369: sub ask_embedded_js {
                   11370:     return <<"END";
                   11371: <script type="text/javascript"">
                   11372: // <![CDATA[
                   11373: function toggleBrowse(counter) {
                   11374:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   11375:     var fileid = document.getElementById('embedded_item_'+counter);
                   11376:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   11377:     if (chkboxid.checked == true) {
                   11378:         uploaddivid.style.display='block';
                   11379:     } else {
                   11380:         uploaddivid.style.display='none';
                   11381:         fileid.value = '';
                   11382:     }
                   11383: }
                   11384: // ]]>
                   11385: </script>
                   11386: 
                   11387: END
                   11388: }
                   11389: 
1.661     raeburn  11390: sub upload_embedded {
                   11391:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  11392:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   11393:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  11394:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   11395:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   11396:         my $orig_uploaded_filename =
                   11397:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  11398:         foreach my $type ('orig','ref','attrib','codebase') {
                   11399:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   11400:                 $env{'form.embedded_'.$type.'_'.$i} =
                   11401:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   11402:             }
                   11403:         }
1.661     raeburn  11404:         my ($path,$fname) =
                   11405:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   11406:         # no path, whole string is fname
                   11407:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   11408:         $fname = &Apache::lonnet::clean_filename($fname);
                   11409:         # See if there is anything left
                   11410:         next if ($fname eq '');
                   11411: 
                   11412:         # Check if file already exists as a file or directory.
                   11413:         my ($state,$msg);
                   11414:         if ($context eq 'portfolio') {
                   11415:             my $port_path = $dirpath;
                   11416:             if ($group ne '') {
                   11417:                 $port_path = "groups/$group/$port_path";
                   11418:             }
1.987     raeburn  11419:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   11420:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  11421:                                               $dir_root,$port_path,$disk_quota,
                   11422:                                               $current_disk_usage,$uname,$udom);
                   11423:             if ($state eq 'will_exceed_quota'
1.984     raeburn  11424:                 || $state eq 'file_locked') {
1.661     raeburn  11425:                 $output .= $msg;
                   11426:                 next;
                   11427:             }
                   11428:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   11429:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   11430:             if ($state eq 'exists') {
                   11431:                 $output .= $msg;
                   11432:                 next;
                   11433:             }
                   11434:         }
                   11435:         # Check if extension is valid
                   11436:         if (($fname =~ /\.(\w+)$/) &&
                   11437:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1075.2.53  raeburn  11438:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   11439:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  11440:             next;
                   11441:         } elsif (($fname =~ /\.(\w+)$/) &&
                   11442:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  11443:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  11444:             next;
                   11445:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34  raeburn  11446:             $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  11447:             next;
                   11448:         }
                   11449:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35  raeburn  11450:         my $subdir = $path;
                   11451:         $subdir =~ s{/+$}{};
1.661     raeburn  11452:         if ($context eq 'portfolio') {
1.984     raeburn  11453:             my $result;
                   11454:             if ($state eq 'existingfile') {
                   11455:                 $result=
                   11456:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35  raeburn  11457:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  11458:             } else {
1.984     raeburn  11459:                 $result=
                   11460:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  11461:                                                     $dirpath.
1.1075.2.35  raeburn  11462:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  11463:                 if ($result !~ m|^/uploaded/|) {
                   11464:                     $output .= '<span class="LC_error">'
                   11465:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11466:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11467:                                .'</span><br />';
                   11468:                     next;
                   11469:                 } else {
1.987     raeburn  11470:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11471:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  11472:                 }
1.661     raeburn  11473:             }
1.1075.2.35  raeburn  11474:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
                   11475:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   11476:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  11477:             my $result =
1.1075.2.35  raeburn  11478:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  11479:             if ($result !~ m|^/uploaded/|) {
                   11480:                 $output .= '<span class="LC_error">'
                   11481:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11482:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11483:                            .'</span><br />';
                   11484:                     next;
                   11485:             } else {
                   11486:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11487:                            $path.$fname.'</span>').'<br />';
1.1075.2.35  raeburn  11488:                 if ($context eq 'syllabus') {
                   11489:                     &Apache::lonnet::make_public_indefinitely($result);
                   11490:                 }
1.987     raeburn  11491:             }
1.661     raeburn  11492:         } else {
                   11493: # Save the file
                   11494:             my $target = $env{'form.embedded_item_'.$i};
                   11495:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   11496:             my $dest = $fullpath.$fname;
                   11497:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  11498:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  11499:             my $count;
                   11500:             my $filepath = $dir_root;
1.1027    raeburn  11501:             foreach my $subdir (@parts) {
                   11502:                 $filepath .= "/$subdir";
                   11503:                 if (!-e $filepath) {
1.661     raeburn  11504:                     mkdir($filepath,0770);
                   11505:                 }
                   11506:             }
                   11507:             my $fh;
                   11508:             if (!open($fh,'>'.$dest)) {
                   11509:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   11510:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  11511:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   11512:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11513:                            '</span><br />';
                   11514:             } else {
                   11515:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   11516:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   11517:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  11518:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   11519:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11520:                               '</span><br />';
                   11521:                 } else {
1.987     raeburn  11522:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11523:                                $url.'</span>').'<br />';
                   11524:                     unless ($context eq 'testbank') {
                   11525:                         $footer .= &mt('View embedded file: [_1]',
                   11526:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   11527:                     }
                   11528:                 }
                   11529:                 close($fh);
                   11530:             }
                   11531:         }
                   11532:         if ($env{'form.embedded_ref_'.$i}) {
                   11533:             $pathchange{$i} = 1;
                   11534:         }
                   11535:     }
                   11536:     if ($output) {
                   11537:         $output = '<p>'.$output.'</p>';
                   11538:     }
                   11539:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   11540:     $returnflag = 'ok';
1.1071    raeburn  11541:     my $numpathchgs = scalar(keys(%pathchange));
                   11542:     if ($numpathchgs > 0) {
1.987     raeburn  11543:         if ($context eq 'portfolio') {
                   11544:             $output .= '<p>'.&mt('or').'</p>';
                   11545:         } elsif ($context eq 'testbank') {
1.1071    raeburn  11546:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   11547:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  11548:             $returnflag = 'modify_orightml';
                   11549:         }
                   11550:     }
1.1071    raeburn  11551:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  11552: }
                   11553: 
                   11554: sub modify_html_form {
                   11555:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   11556:     my $end = 0;
                   11557:     my $modifyform;
                   11558:     if ($context eq 'upload_embedded') {
                   11559:         return unless (ref($pathchange) eq 'HASH');
                   11560:         if ($env{'form.number_embedded_items'}) {
                   11561:             $end += $env{'form.number_embedded_items'};
                   11562:         }
                   11563:         if ($env{'form.number_pathchange_items'}) {
                   11564:             $end += $env{'form.number_pathchange_items'};
                   11565:         }
                   11566:         if ($end) {
                   11567:             for (my $i=0; $i<$end; $i++) {
                   11568:                 if ($i < $env{'form.number_embedded_items'}) {
                   11569:                     next unless($pathchange->{$i});
                   11570:                 }
                   11571:                 $modifyform .=
                   11572:                     &start_data_table_row().
                   11573:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   11574:                     'checked="checked" /></td>'.
                   11575:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   11576:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   11577:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   11578:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   11579:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   11580:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   11581:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   11582:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   11583:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   11584:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   11585:                     &end_data_table_row();
1.1071    raeburn  11586:             }
1.987     raeburn  11587:         }
                   11588:     } else {
                   11589:         $modifyform = $pathchgtable;
                   11590:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   11591:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   11592:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11593:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   11594:         }
                   11595:     }
                   11596:     if ($modifyform) {
1.1071    raeburn  11597:         if ($actionurl eq '/adm/dependencies') {
                   11598:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   11599:         }
1.987     raeburn  11600:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   11601:                '<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".
                   11602:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   11603:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   11604:                '</ol></p>'."\n".'<p>'.
                   11605:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   11606:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   11607:                &start_data_table()."\n".
                   11608:                &start_data_table_header_row().
                   11609:                '<th>'.&mt('Change?').'</th>'.
                   11610:                '<th>'.&mt('Current reference').'</th>'.
                   11611:                '<th>'.&mt('Required reference').'</th>'.
                   11612:                &end_data_table_header_row()."\n".
                   11613:                $modifyform.
                   11614:                &end_data_table().'<br />'."\n".$hiddenstate.
                   11615:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   11616:                '</form>'."\n";
                   11617:     }
                   11618:     return;
                   11619: }
                   11620: 
                   11621: sub modify_html_refs {
1.1075.2.35  raeburn  11622:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  11623:     my $container;
                   11624:     if ($context eq 'portfolio') {
                   11625:         $container = $env{'form.container'};
                   11626:     } elsif ($context eq 'coursedoc') {
                   11627:         $container = $env{'form.primaryurl'};
1.1071    raeburn  11628:     } elsif ($context eq 'manage_dependencies') {
                   11629:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   11630:         $container = "/$container";
1.1075.2.35  raeburn  11631:     } elsif ($context eq 'syllabus') {
                   11632:         $container = $url;
1.987     raeburn  11633:     } else {
1.1027    raeburn  11634:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  11635:     }
                   11636:     my (%allfiles,%codebase,$output,$content);
                   11637:     my @changes = &get_env_multiple('form.namechange');
1.1075.2.35  raeburn  11638:     unless ((@changes > 0)  || ($context eq 'syllabus')) {
1.1071    raeburn  11639:         if (wantarray) {
                   11640:             return ('',0,0); 
                   11641:         } else {
                   11642:             return;
                   11643:         }
                   11644:     }
                   11645:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11646:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  11647:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   11648:             if (wantarray) {
                   11649:                 return ('',0,0);
                   11650:             } else {
                   11651:                 return;
                   11652:             }
                   11653:         } 
1.987     raeburn  11654:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  11655:         if ($content eq '-1') {
                   11656:             if (wantarray) {
                   11657:                 return ('',0,0);
                   11658:             } else {
                   11659:                 return;
                   11660:             }
                   11661:         }
1.987     raeburn  11662:     } else {
1.1071    raeburn  11663:         unless ($container =~ /^\Q$dir_root\E/) {
                   11664:             if (wantarray) {
                   11665:                 return ('',0,0);
                   11666:             } else {
                   11667:                 return;
                   11668:             }
                   11669:         } 
1.1075.2.128  raeburn  11670:         if (open(my $fh,'<',$container)) {
1.987     raeburn  11671:             $content = join('', <$fh>);
                   11672:             close($fh);
                   11673:         } else {
1.1071    raeburn  11674:             if (wantarray) {
                   11675:                 return ('',0,0);
                   11676:             } else {
                   11677:                 return;
                   11678:             }
1.987     raeburn  11679:         }
                   11680:     }
                   11681:     my ($count,$codebasecount) = (0,0);
                   11682:     my $mm = new File::MMagic;
                   11683:     my $mime_type = $mm->checktype_contents($content);
                   11684:     if ($mime_type eq 'text/html') {
                   11685:         my $parse_result = 
                   11686:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   11687:                                                     \%codebase,\$content);
                   11688:         if ($parse_result eq 'ok') {
                   11689:             foreach my $i (@changes) {
                   11690:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   11691:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   11692:                 if ($allfiles{$ref}) {
                   11693:                     my $newname =  $orig;
                   11694:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  11695:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  11696:                     if ($attrib_regexp =~ /:/) {
                   11697:                         $attrib_regexp =~ s/\:/|/g;
                   11698:                     }
                   11699:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11700:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11701:                         $count += $numchg;
1.1075.2.35  raeburn  11702:                         $allfiles{$newname} = $allfiles{$ref};
1.1075.2.48  raeburn  11703:                         delete($allfiles{$ref});
1.987     raeburn  11704:                     }
                   11705:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  11706:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  11707:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   11708:                         $codebasecount ++;
                   11709:                     }
                   11710:                 }
                   11711:             }
1.1075.2.35  raeburn  11712:             my $skiprewrites;
1.987     raeburn  11713:             if ($count || $codebasecount) {
                   11714:                 my $saveresult;
1.1071    raeburn  11715:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11716:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  11717:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11718:                     if ($url eq $container) {
                   11719:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   11720:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11721:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  11722:                                             $fname.'</span>').'</p>';
1.987     raeburn  11723:                     } else {
                   11724:                          $output = '<p class="LC_error">'.
                   11725:                                    &mt('Error: update failed for: [_1].',
                   11726:                                    '<span class="LC_filename">'.
                   11727:                                    $container.'</span>').'</p>';
                   11728:                     }
1.1075.2.35  raeburn  11729:                     if ($context eq 'syllabus') {
                   11730:                         unless ($saveresult eq 'ok') {
                   11731:                             $skiprewrites = 1;
                   11732:                         }
                   11733:                     }
1.987     raeburn  11734:                 } else {
1.1075.2.128  raeburn  11735:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  11736:                         print $fh $content;
                   11737:                         close($fh);
                   11738:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11739:                                   $count,'<span class="LC_filename">'.
                   11740:                                   $container.'</span>').'</p>';
1.661     raeburn  11741:                     } else {
1.987     raeburn  11742:                          $output = '<p class="LC_error">'.
                   11743:                                    &mt('Error: could not update [_1].',
                   11744:                                    '<span class="LC_filename">'.
                   11745:                                    $container.'</span>').'</p>';
1.661     raeburn  11746:                     }
                   11747:                 }
                   11748:             }
1.1075.2.35  raeburn  11749:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   11750:                 my ($actionurl,$state);
                   11751:                 $actionurl = "/public/$udom/$uname/syllabus";
                   11752:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   11753:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   11754:                                               \%codebase,
                   11755:                                               {'context' => 'rewrites',
                   11756:                                                'ignore_remote_references' => 1,});
                   11757:                 if (ref($mapping) eq 'HASH') {
                   11758:                     my $rewrites = 0;
                   11759:                     foreach my $key (keys(%{$mapping})) {
                   11760:                         next if ($key =~ m{^https?://});
                   11761:                         my $ref = $mapping->{$key};
                   11762:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   11763:                         my $attrib;
                   11764:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   11765:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   11766:                         }
                   11767:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11768:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11769:                             $rewrites += $numchg;
                   11770:                         }
                   11771:                     }
                   11772:                     if ($rewrites) {
                   11773:                         my $saveresult;
                   11774:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11775:                         if ($url eq $container) {
                   11776:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   11777:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   11778:                                             $count,'<span class="LC_filename">'.
                   11779:                                             $fname.'</span>').'</p>';
                   11780:                         } else {
                   11781:                             $output .= '<p class="LC_error">'.
                   11782:                                        &mt('Error: could not update links in [_1].',
                   11783:                                        '<span class="LC_filename">'.
                   11784:                                        $container.'</span>').'</p>';
                   11785: 
                   11786:                         }
                   11787:                     }
                   11788:                 }
                   11789:             }
1.987     raeburn  11790:         } else {
                   11791:             &logthis('Failed to parse '.$container.
                   11792:                      ' to modify references: '.$parse_result);
1.661     raeburn  11793:         }
                   11794:     }
1.1071    raeburn  11795:     if (wantarray) {
                   11796:         return ($output,$count,$codebasecount);
                   11797:     } else {
                   11798:         return $output;
                   11799:     }
1.661     raeburn  11800: }
                   11801: 
                   11802: sub check_for_existing {
                   11803:     my ($path,$fname,$element) = @_;
                   11804:     my ($state,$msg);
                   11805:     if (-d $path.'/'.$fname) {
                   11806:         $state = 'exists';
                   11807:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   11808:     } elsif (-e $path.'/'.$fname) {
                   11809:         $state = 'exists';
                   11810:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   11811:     }
                   11812:     if ($state eq 'exists') {
                   11813:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   11814:     }
                   11815:     return ($state,$msg);
                   11816: }
                   11817: 
                   11818: sub check_for_upload {
                   11819:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   11820:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  11821:     my $filesize = length($env{'form.'.$element});
                   11822:     if (!$filesize) {
                   11823:         my $msg = '<span class="LC_error">'.
                   11824:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   11825:                       '<span class="LC_filename">'.$fname.'</span>',
                   11826:                       $filesize).'<br />'.
1.1007    raeburn  11827:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  11828:                   '</span>';
                   11829:         return ('zero_bytes',$msg);
                   11830:     }
                   11831:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  11832:     my $getpropath = 1;
1.1021    raeburn  11833:     my ($dirlistref,$listerror) =
                   11834:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  11835:     my $found_file = 0;
                   11836:     my $locked_file = 0;
1.991     raeburn  11837:     my @lockers;
                   11838:     my $navmap;
                   11839:     if ($env{'request.course.id'}) {
                   11840:         $navmap = Apache::lonnavmaps::navmap->new();
                   11841:     }
1.1021    raeburn  11842:     if (ref($dirlistref) eq 'ARRAY') {
                   11843:         foreach my $line (@{$dirlistref}) {
                   11844:             my ($file_name,$rest)=split(/\&/,$line,2);
                   11845:             if ($file_name eq $fname){
                   11846:                 $file_name = $path.$file_name;
                   11847:                 if ($group ne '') {
                   11848:                     $file_name = $group.$file_name;
                   11849:                 }
                   11850:                 $found_file = 1;
                   11851:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   11852:                     foreach my $lock (@lockers) {
                   11853:                         if (ref($lock) eq 'ARRAY') {
                   11854:                             my ($symb,$crsid) = @{$lock};
                   11855:                             if ($crsid eq $env{'request.course.id'}) {
                   11856:                                 if (ref($navmap)) {
                   11857:                                     my $res = $navmap->getBySymb($symb);
                   11858:                                     foreach my $part (@{$res->parts()}) { 
                   11859:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   11860:                                         unless (($slot_status == $res->RESERVED) ||
                   11861:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   11862:                                             $locked_file = 1;
                   11863:                                         }
1.991     raeburn  11864:                                     }
1.1021    raeburn  11865:                                 } else {
                   11866:                                     $locked_file = 1;
1.991     raeburn  11867:                                 }
                   11868:                             } else {
                   11869:                                 $locked_file = 1;
                   11870:                             }
                   11871:                         }
1.1021    raeburn  11872:                    }
                   11873:                 } else {
                   11874:                     my @info = split(/\&/,$rest);
                   11875:                     my $currsize = $info[6]/1000;
                   11876:                     if ($currsize < $filesize) {
                   11877:                         my $extra = $filesize - $currsize;
                   11878:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1075.2.69  raeburn  11879:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  11880:                                       &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  11881:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   11882:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   11883:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  11884:                             return ('will_exceed_quota',$msg);
                   11885:                         }
1.984     raeburn  11886:                     }
                   11887:                 }
1.661     raeburn  11888:             }
                   11889:         }
                   11890:     }
                   11891:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1075.2.69  raeburn  11892:         my $msg = '<p class="LC_warning">'.
                   11893:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
                   11894:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  11895:         return ('will_exceed_quota',$msg);
                   11896:     } elsif ($found_file) {
                   11897:         if ($locked_file) {
1.1075.2.69  raeburn  11898:             my $msg = '<p class="LC_warning">';
1.661     raeburn  11899:             $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  11900:             $msg .= '</p>';
1.661     raeburn  11901:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   11902:             return ('file_locked',$msg);
                   11903:         } else {
1.1075.2.69  raeburn  11904:             my $msg = '<p class="LC_error">';
1.984     raeburn  11905:             $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  11906:             $msg .= '</p>';
1.984     raeburn  11907:             return ('existingfile',$msg);
1.661     raeburn  11908:         }
                   11909:     }
                   11910: }
                   11911: 
1.987     raeburn  11912: sub check_for_traversal {
                   11913:     my ($path,$url,$toplevel) = @_;
                   11914:     my @parts=split(/\//,$path);
                   11915:     my $cleanpath;
                   11916:     my $fullpath = $url;
                   11917:     for (my $i=0;$i<@parts;$i++) {
                   11918:         next if ($parts[$i] eq '.');
                   11919:         if ($parts[$i] eq '..') {
                   11920:             $fullpath =~ s{([^/]+/)$}{};
                   11921:         } else {
                   11922:             $fullpath .= $parts[$i].'/';
                   11923:         }
                   11924:     }
                   11925:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   11926:         $cleanpath = $1;
                   11927:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   11928:         my $curr_toprel = $1;
                   11929:         my @parts = split(/\//,$curr_toprel);
                   11930:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   11931:         my @urlparts = split(/\//,$url_toprel);
                   11932:         my $doubledots;
                   11933:         my $startdiff = -1;
                   11934:         for (my $i=0; $i<@urlparts; $i++) {
                   11935:             if ($startdiff == -1) {
                   11936:                 unless ($urlparts[$i] eq $parts[$i]) {
                   11937:                     $startdiff = $i;
                   11938:                     $doubledots .= '../';
                   11939:                 }
                   11940:             } else {
                   11941:                 $doubledots .= '../';
                   11942:             }
                   11943:         }
                   11944:         if ($startdiff > -1) {
                   11945:             $cleanpath = $doubledots;
                   11946:             for (my $i=$startdiff; $i<@parts; $i++) {
                   11947:                 $cleanpath .= $parts[$i].'/';
                   11948:             }
                   11949:         }
                   11950:     }
                   11951:     $cleanpath =~ s{(/)$}{};
                   11952:     return $cleanpath;
                   11953: }
1.31      albertel 11954: 
1.1053    raeburn  11955: sub is_archive_file {
                   11956:     my ($mimetype) = @_;
                   11957:     if (($mimetype eq 'application/octet-stream') ||
                   11958:         ($mimetype eq 'application/x-stuffit') ||
                   11959:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   11960:         return 1;
                   11961:     }
                   11962:     return;
                   11963: }
                   11964: 
                   11965: sub decompress_form {
1.1065    raeburn  11966:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  11967:     my %lt = &Apache::lonlocal::texthash (
                   11968:         this => 'This file is an archive file.',
1.1067    raeburn  11969:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  11970:         itsc => 'Its contents are as follows:',
1.1053    raeburn  11971:         youm => 'You may wish to extract its contents.',
                   11972:         extr => 'Extract contents',
1.1067    raeburn  11973:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   11974:         proa => 'Process automatically?',
1.1053    raeburn  11975:         yes  => 'Yes',
                   11976:         no   => 'No',
1.1067    raeburn  11977:         fold => 'Title for folder containing movie',
                   11978:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  11979:     );
1.1065    raeburn  11980:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  11981:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  11982:     my $info = &list_archive_contents($fileloc,\@paths);
                   11983:     if (@paths) {
                   11984:         foreach my $path (@paths) {
                   11985:             $path =~ s{^/}{};
1.1067    raeburn  11986:             if ($path =~ m{^([^/]+)/$}) {
                   11987:                 $topdir = $1;
                   11988:             }
1.1065    raeburn  11989:             if ($path =~ m{^([^/]+)/}) {
                   11990:                 $toplevel{$1} = $path;
                   11991:             } else {
                   11992:                 $toplevel{$path} = $path;
                   11993:             }
                   11994:         }
                   11995:     }
1.1067    raeburn  11996:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1075.2.59  raeburn  11997:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  11998:                         "$topdir/media/",
                   11999:                         "$topdir/media/$topdir.mp4",
                   12000:                         "$topdir/media/FirstFrame.png",
                   12001:                         "$topdir/media/player.swf",
                   12002:                         "$topdir/media/swfobject.js",
                   12003:                         "$topdir/media/expressInstall.swf");
1.1075.2.81  raeburn  12004:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1075.2.59  raeburn  12005:                          "$topdir/$topdir.mp4",
                   12006:                          "$topdir/$topdir\_config.xml",
                   12007:                          "$topdir/$topdir\_controller.swf",
                   12008:                          "$topdir/$topdir\_embed.css",
                   12009:                          "$topdir/$topdir\_First_Frame.png",
                   12010:                          "$topdir/$topdir\_player.html",
                   12011:                          "$topdir/$topdir\_Thumbnails.png",
                   12012:                          "$topdir/playerProductInstall.swf",
                   12013:                          "$topdir/scripts/",
                   12014:                          "$topdir/scripts/config_xml.js",
                   12015:                          "$topdir/scripts/handlebars.js",
                   12016:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   12017:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   12018:                          "$topdir/scripts/modernizr.js",
                   12019:                          "$topdir/scripts/player-min.js",
                   12020:                          "$topdir/scripts/swfobject.js",
                   12021:                          "$topdir/skins/",
                   12022:                          "$topdir/skins/configuration_express.xml",
                   12023:                          "$topdir/skins/express_show/",
                   12024:                          "$topdir/skins/express_show/player-min.css",
                   12025:                          "$topdir/skins/express_show/spritesheet.png");
1.1075.2.81  raeburn  12026:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   12027:                          "$topdir/$topdir.mp4",
                   12028:                          "$topdir/$topdir\_config.xml",
                   12029:                          "$topdir/$topdir\_controller.swf",
                   12030:                          "$topdir/$topdir\_embed.css",
                   12031:                          "$topdir/$topdir\_First_Frame.png",
                   12032:                          "$topdir/$topdir\_player.html",
                   12033:                          "$topdir/$topdir\_Thumbnails.png",
                   12034:                          "$topdir/playerProductInstall.swf",
                   12035:                          "$topdir/scripts/",
                   12036:                          "$topdir/scripts/config_xml.js",
                   12037:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   12038:                          "$topdir/skins/",
                   12039:                          "$topdir/skins/configuration_express.xml",
                   12040:                          "$topdir/skins/express_show/",
                   12041:                          "$topdir/skins/express_show/spritesheet.min.css",
                   12042:                          "$topdir/skins/express_show/spritesheet.png",
                   12043:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1075.2.59  raeburn  12044:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  12045:         if (@diffs == 0) {
1.1075.2.59  raeburn  12046:             $is_camtasia = 6;
                   12047:         } else {
1.1075.2.81  raeburn  12048:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1075.2.59  raeburn  12049:             if (@diffs == 0) {
                   12050:                 $is_camtasia = 8;
1.1075.2.81  raeburn  12051:             } else {
                   12052:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   12053:                 if (@diffs == 0) {
                   12054:                     $is_camtasia = 8;
                   12055:                 }
1.1075.2.59  raeburn  12056:             }
1.1067    raeburn  12057:         }
                   12058:     }
                   12059:     my $output;
                   12060:     if ($is_camtasia) {
                   12061:         $output = <<"ENDCAM";
                   12062: <script type="text/javascript" language="Javascript">
                   12063: // <![CDATA[
                   12064: 
                   12065: function camtasiaToggle() {
                   12066:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   12067:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1075.2.59  raeburn  12068:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  12069:                 document.getElementById('camtasia_titles').style.display='block';
                   12070:             } else {
                   12071:                 document.getElementById('camtasia_titles').style.display='none';
                   12072:             }
                   12073:         }
                   12074:     }
                   12075:     return;
                   12076: }
                   12077: 
                   12078: // ]]>
                   12079: </script>
                   12080: <p>$lt{'camt'}</p>
                   12081: ENDCAM
1.1065    raeburn  12082:     } else {
1.1067    raeburn  12083:         $output = '<p>'.$lt{'this'};
                   12084:         if ($info eq '') {
                   12085:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   12086:         } else {
                   12087:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   12088:                        '<div><pre>'.$info.'</pre></div>';
                   12089:         }
1.1065    raeburn  12090:     }
1.1067    raeburn  12091:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  12092:     my $duplicates;
                   12093:     my $num = 0;
                   12094:     if (ref($dirlist) eq 'ARRAY') {
                   12095:         foreach my $item (@{$dirlist}) {
                   12096:             if (ref($item) eq 'ARRAY') {
                   12097:                 if (exists($toplevel{$item->[0]})) {
                   12098:                     $duplicates .= 
                   12099:                         &start_data_table_row().
                   12100:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12101:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   12102:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12103:                         'value="1" />'.&mt('Yes').'</label>'.
                   12104:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   12105:                         '<td>'.$item->[0].'</td>';
                   12106:                     if ($item->[2]) {
                   12107:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   12108:                     } else {
                   12109:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   12110:                     }
                   12111:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   12112:                                    '<td>'.
                   12113:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   12114:                                    '</td>'.
                   12115:                                    &end_data_table_row();
                   12116:                     $num ++;
                   12117:                 }
                   12118:             }
                   12119:         }
                   12120:     }
                   12121:     my $itemcount;
                   12122:     if (@paths > 0) {
                   12123:         $itemcount = scalar(@paths);
                   12124:     } else {
                   12125:         $itemcount = 1;
                   12126:     }
1.1067    raeburn  12127:     if ($is_camtasia) {
                   12128:         $output .= $lt{'auto'}.'<br />'.
                   12129:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1075.2.59  raeburn  12130:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  12131:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   12132:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   12133:                    $lt{'no'}.'</label></span><br />'.
                   12134:                    '<div id="camtasia_titles" style="display:block">'.
                   12135:                    &Apache::lonhtmlcommon::start_pick_box().
                   12136:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   12137:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   12138:                    &Apache::lonhtmlcommon::row_closure().
                   12139:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   12140:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   12141:                    &Apache::lonhtmlcommon::row_closure(1).
                   12142:                    &Apache::lonhtmlcommon::end_pick_box().
                   12143:                    '</div>';
                   12144:     }
1.1065    raeburn  12145:     $output .= 
                   12146:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  12147:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   12148:         "\n";
1.1065    raeburn  12149:     if ($duplicates ne '') {
                   12150:         $output .= '<p><span class="LC_warning">'.
                   12151:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   12152:                    &start_data_table().
                   12153:                    &start_data_table_header_row().
                   12154:                    '<th>'.&mt('Overwrite?').'</th>'.
                   12155:                    '<th>'.&mt('Name').'</th>'.
                   12156:                    '<th>'.&mt('Type').'</th>'.
                   12157:                    '<th>'.&mt('Size').'</th>'.
                   12158:                    '<th>'.&mt('Last modified').'</th>'.
                   12159:                    &end_data_table_header_row().
                   12160:                    $duplicates.
                   12161:                    &end_data_table().
                   12162:                    '</p>';
                   12163:     }
1.1067    raeburn  12164:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  12165:     if (ref($hiddenelements) eq 'HASH') {
                   12166:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   12167:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   12168:         }
                   12169:     }
                   12170:     $output .= <<"END";
1.1067    raeburn  12171: <br />
1.1053    raeburn  12172: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   12173: </form>
                   12174: $noextract
                   12175: END
                   12176:     return $output;
                   12177: }
                   12178: 
1.1065    raeburn  12179: sub decompression_utility {
                   12180:     my ($program) = @_;
                   12181:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   12182:     my $location;
                   12183:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   12184:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   12185:                          '/usr/sbin/') {
                   12186:             if (-x $dir.$program) {
                   12187:                 $location = $dir.$program;
                   12188:                 last;
                   12189:             }
                   12190:         }
                   12191:     }
                   12192:     return $location;
                   12193: }
                   12194: 
                   12195: sub list_archive_contents {
                   12196:     my ($file,$pathsref) = @_;
                   12197:     my (@cmd,$output);
                   12198:     my $needsregexp;
                   12199:     if ($file =~ /\.zip$/) {
                   12200:         @cmd = (&decompression_utility('unzip'),"-l");
                   12201:         $needsregexp = 1;
                   12202:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   12203:              ($file =~ /\.tgz$/)) {
                   12204:         @cmd = (&decompression_utility('tar'),"-ztf");
                   12205:     } elsif ($file =~ /\.tar\.bz2$/) {
                   12206:         @cmd = (&decompression_utility('tar'),"-jtf");
                   12207:     } elsif ($file =~ m|\.tar$|) {
                   12208:         @cmd = (&decompression_utility('tar'),"-tf");
                   12209:     }
                   12210:     if (@cmd) {
                   12211:         undef($!);
                   12212:         undef($@);
                   12213:         if (open(my $fh,"-|", @cmd, $file)) {
                   12214:             while (my $line = <$fh>) {
                   12215:                 $output .= $line;
                   12216:                 chomp($line);
                   12217:                 my $item;
                   12218:                 if ($needsregexp) {
                   12219:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   12220:                 } else {
                   12221:                     $item = $line;
                   12222:                 }
                   12223:                 if ($item ne '') {
                   12224:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   12225:                         push(@{$pathsref},$item);
                   12226:                     } 
                   12227:                 }
                   12228:             }
                   12229:             close($fh);
                   12230:         }
                   12231:     }
                   12232:     return $output;
                   12233: }
                   12234: 
1.1053    raeburn  12235: sub decompress_uploaded_file {
                   12236:     my ($file,$dir) = @_;
                   12237:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   12238:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   12239:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   12240:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   12241:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   12242:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   12243:     my $decompressed = $env{'cgi.decompressed'};
                   12244:     &Apache::lonnet::delenv('cgi.file');
                   12245:     &Apache::lonnet::delenv('cgi.dir');
                   12246:     &Apache::lonnet::delenv('cgi.decompressed');
                   12247:     return ($decompressed,$result);
                   12248: }
                   12249: 
1.1055    raeburn  12250: sub process_decompression {
                   12251:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1075.2.128  raeburn  12252:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   12253:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12254:                &mt('Unexpected file path.').'</p>'."\n";
                   12255:     }
                   12256:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   12257:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12258:                &mt('Unexpected course context.').'</p>'."\n";
                   12259:     }
                   12260:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
                   12261:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12262:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   12263:     }
1.1055    raeburn  12264:     my ($dir,$error,$warning,$output);
1.1075.2.69  raeburn  12265:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1075.2.34  raeburn  12266:         $error = &mt('Filename not a supported archive file type.').
                   12267:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  12268:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   12269:     } else {
                   12270:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12271:         if ($docuhome eq 'no_host') {
                   12272:             $error = &mt('Could not determine home server for course.');
                   12273:         } else {
                   12274:             my @ids=&Apache::lonnet::current_machine_ids();
                   12275:             my $currdir = "$dir_root/$destination";
                   12276:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12277:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   12278:                        "$dir_root/$destination";
                   12279:             } else {
                   12280:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   12281:                        "$dir_root/$docudom/$docuname/$destination";
                   12282:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   12283:                     $error = &mt('Archive file not found.');
                   12284:                 }
                   12285:             }
1.1065    raeburn  12286:             my (@to_overwrite,@to_skip);
                   12287:             if ($env{'form.archive_overwrite_total'} > 0) {
                   12288:                 my $total = $env{'form.archive_overwrite_total'};
                   12289:                 for (my $i=0; $i<$total; $i++) {
                   12290:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   12291:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   12292:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   12293:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   12294:                     }
                   12295:                 }
                   12296:             }
                   12297:             my $numskip = scalar(@to_skip);
1.1075.2.128  raeburn  12298:             my $numoverwrite = scalar(@to_overwrite);
                   12299:             if (($numskip) && (!$numoverwrite)) {
1.1065    raeburn  12300:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   12301:             } elsif ($dir eq '') {
1.1055    raeburn  12302:                 $error = &mt('Directory containing archive file unavailable.');
                   12303:             } elsif (!$error) {
1.1065    raeburn  12304:                 my ($decompressed,$display);
1.1075.2.128  raeburn  12305:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  12306:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   12307:                     mkdir("$dir/$tempdir",0755);
1.1075.2.128  raeburn  12308:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   12309:                         ($decompressed,$display) =
                   12310:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   12311:                         foreach my $item (@to_skip) {
                   12312:                             if (($item ne '') && ($item !~ /\.\./)) {
                   12313:                                 if (-f "$dir/$tempdir/$item") {
                   12314:                                     unlink("$dir/$tempdir/$item");
                   12315:                                 } elsif (-d "$dir/$tempdir/$item") {
                   12316:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
                   12317:                                 }
                   12318:                             }
                   12319:                         }
                   12320:                         foreach my $item (@to_overwrite) {
                   12321:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   12322:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   12323:                                     if (-f "$dir/$item") {
                   12324:                                         unlink("$dir/$item");
                   12325:                                     } elsif (-d "$dir/$item") {
                   12326:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
                   12327:                                     }
                   12328:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   12329:                                 }
1.1065    raeburn  12330:                             }
                   12331:                         }
1.1075.2.128  raeburn  12332:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
                   12333:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
                   12334:                         }
1.1065    raeburn  12335:                     }
                   12336:                 } else {
                   12337:                     ($decompressed,$display) = 
                   12338:                         &decompress_uploaded_file($file,$dir);
                   12339:                 }
1.1055    raeburn  12340:                 if ($decompressed eq 'ok') {
1.1065    raeburn  12341:                     $output = '<p class="LC_info">'.
                   12342:                               &mt('Files extracted successfully from archive.').
                   12343:                               '</p>'."\n";
1.1055    raeburn  12344:                     my ($warning,$result,@contents);
                   12345:                     my ($newdirlistref,$newlisterror) =
                   12346:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   12347:                                                  $docuname,1);
                   12348:                     my (%is_dir,%changes,@newitems);
                   12349:                     my $dirptr = 16384;
1.1065    raeburn  12350:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  12351:                         foreach my $dir_line (@{$newdirlistref}) {
                   12352:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1075.2.128  raeburn  12353:                             unless (($item =~ /^\.+$/) || ($item eq $file)) { 
1.1055    raeburn  12354:                                 push(@newitems,$item);
                   12355:                                 if ($dirptr&$testdir) {
                   12356:                                     $is_dir{$item} = 1;
                   12357:                                 }
                   12358:                                 $changes{$item} = 1;
                   12359:                             }
                   12360:                         }
                   12361:                     }
                   12362:                     if (keys(%changes) > 0) {
                   12363:                         foreach my $item (sort(@newitems)) {
                   12364:                             if ($changes{$item}) {
                   12365:                                 push(@contents,$item);
                   12366:                             }
                   12367:                         }
                   12368:                     }
                   12369:                     if (@contents > 0) {
1.1067    raeburn  12370:                         my $wantform;
                   12371:                         unless ($env{'form.autoextract_camtasia'}) {
                   12372:                             $wantform = 1;
                   12373:                         }
1.1056    raeburn  12374:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  12375:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   12376:                                                                 $currdir,\%is_dir,
                   12377:                                                                 \%children,\%parent,
1.1056    raeburn  12378:                                                                 \@contents,\%dirorder,
                   12379:                                                                 \%titles,$wantform);
1.1055    raeburn  12380:                         if ($datatable ne '') {
                   12381:                             $output .= &archive_options_form('decompressed',$datatable,
                   12382:                                                              $count,$hiddenelem);
1.1065    raeburn  12383:                             my $startcount = 6;
1.1055    raeburn  12384:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  12385:                                                            \%titles,\%children);
1.1055    raeburn  12386:                         }
1.1067    raeburn  12387:                         if ($env{'form.autoextract_camtasia'}) {
1.1075.2.59  raeburn  12388:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  12389:                             my %displayed;
                   12390:                             my $total = 1;
                   12391:                             $env{'form.archive_directory'} = [];
                   12392:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   12393:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   12394:                                 $path =~ s{/$}{};
                   12395:                                 my $item;
                   12396:                                 if ($path ne '') {
                   12397:                                     $item = "$path/$titles{$i}";
                   12398:                                 } else {
                   12399:                                     $item = $titles{$i};
                   12400:                                 }
                   12401:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   12402:                                 if ($item eq $contents[0]) {
                   12403:                                     push(@{$env{'form.archive_directory'}},$i);
                   12404:                                     $env{'form.archive_'.$i} = 'display';
                   12405:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   12406:                                     $displayed{'folder'} = $i;
1.1075.2.59  raeburn  12407:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   12408:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067    raeburn  12409:                                     $env{'form.archive_'.$i} = 'display';
                   12410:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   12411:                                     $displayed{'web'} = $i;
                   12412:                                 } else {
1.1075.2.59  raeburn  12413:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   12414:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   12415:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  12416:                                         push(@{$env{'form.archive_directory'}},$i);
                   12417:                                     }
                   12418:                                     $env{'form.archive_'.$i} = 'dependency';
                   12419:                                 }
                   12420:                                 $total ++;
                   12421:                             }
                   12422:                             for (my $i=1; $i<$total; $i++) {
                   12423:                                 next if ($i == $displayed{'web'});
                   12424:                                 next if ($i == $displayed{'folder'});
                   12425:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   12426:                             }
                   12427:                             $env{'form.phase'} = 'decompress_cleanup';
                   12428:                             $env{'form.archivedelete'} = 1;
                   12429:                             $env{'form.archive_count'} = $total-1;
                   12430:                             $output .=
                   12431:                                 &process_extracted_files('coursedocs',$docudom,
                   12432:                                                          $docuname,$destination,
                   12433:                                                          $dir_root,$hiddenelem);
                   12434:                         }
1.1055    raeburn  12435:                     } else {
                   12436:                         $warning = &mt('No new items extracted from archive file.');
                   12437:                     }
                   12438:                 } else {
                   12439:                     $output = $display;
                   12440:                     $error = &mt('An error occurred during extraction from the archive file.');
                   12441:                 }
                   12442:             }
                   12443:         }
                   12444:     }
                   12445:     if ($error) {
                   12446:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12447:                    $error.'</p>'."\n";
                   12448:     }
                   12449:     if ($warning) {
                   12450:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   12451:     }
                   12452:     return $output;
                   12453: }
                   12454: 
                   12455: sub get_extracted {
1.1056    raeburn  12456:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   12457:         $titles,$wantform) = @_;
1.1055    raeburn  12458:     my $count = 0;
                   12459:     my $depth = 0;
                   12460:     my $datatable;
1.1056    raeburn  12461:     my @hierarchy;
1.1055    raeburn  12462:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  12463:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   12464:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  12465:     foreach my $item (@{$contents}) {
                   12466:         $count ++;
1.1056    raeburn  12467:         @{$dirorder->{$count}} = @hierarchy;
                   12468:         $titles->{$count} = $item;
1.1055    raeburn  12469:         &archive_hierarchy($depth,$count,$parent,$children);
                   12470:         if ($wantform) {
                   12471:             $datatable .= &archive_row($is_dir->{$item},$item,
                   12472:                                        $currdir,$depth,$count);
                   12473:         }
                   12474:         if ($is_dir->{$item}) {
                   12475:             $depth ++;
1.1056    raeburn  12476:             push(@hierarchy,$count);
                   12477:             $parent->{$depth} = $count;
1.1055    raeburn  12478:             $datatable .=
                   12479:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  12480:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   12481:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  12482:             $depth --;
1.1056    raeburn  12483:             pop(@hierarchy);
1.1055    raeburn  12484:         }
                   12485:     }
                   12486:     return ($count,$datatable);
                   12487: }
                   12488: 
                   12489: sub recurse_extracted_archive {
1.1056    raeburn  12490:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   12491:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  12492:     my $result='';
1.1056    raeburn  12493:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   12494:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   12495:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  12496:         return $result;
                   12497:     }
                   12498:     my $dirptr = 16384;
                   12499:     my ($newdirlistref,$newlisterror) =
                   12500:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   12501:     if (ref($newdirlistref) eq 'ARRAY') {
                   12502:         foreach my $dir_line (@{$newdirlistref}) {
                   12503:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   12504:             unless ($item =~ /^\.+$/) {
                   12505:                 $$count ++;
1.1056    raeburn  12506:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   12507:                 $titles->{$$count} = $item;
1.1055    raeburn  12508:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  12509: 
1.1055    raeburn  12510:                 my $is_dir;
                   12511:                 if ($dirptr&$testdir) {
                   12512:                     $is_dir = 1;
                   12513:                 }
                   12514:                 if ($wantform) {
                   12515:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   12516:                 }
                   12517:                 if ($is_dir) {
                   12518:                     $$depth ++;
1.1056    raeburn  12519:                     push(@{$hierarchy},$$count);
                   12520:                     $parent->{$$depth} = $$count;
1.1055    raeburn  12521:                     $result .=
                   12522:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   12523:                                                    $docuname,$depth,$count,
1.1056    raeburn  12524:                                                    $hierarchy,$dirorder,$children,
                   12525:                                                    $parent,$titles,$wantform);
1.1055    raeburn  12526:                     $$depth --;
1.1056    raeburn  12527:                     pop(@{$hierarchy});
1.1055    raeburn  12528:                 }
                   12529:             }
                   12530:         }
                   12531:     }
                   12532:     return $result;
                   12533: }
                   12534: 
                   12535: sub archive_hierarchy {
                   12536:     my ($depth,$count,$parent,$children) =@_;
                   12537:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   12538:         if (exists($parent->{$depth})) {
                   12539:              $children->{$parent->{$depth}} .= $count.':';
                   12540:         }
                   12541:     }
                   12542:     return;
                   12543: }
                   12544: 
                   12545: sub archive_row {
                   12546:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   12547:     my ($name) = ($item =~ m{([^/]+)$});
                   12548:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  12549:                                        'display'    => 'Add as file',
1.1055    raeburn  12550:                                        'dependency' => 'Include as dependency',
                   12551:                                        'discard'    => 'Discard',
                   12552:                                       );
                   12553:     if ($is_dir) {
1.1059    raeburn  12554:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  12555:     }
1.1056    raeburn  12556:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   12557:     my $offset = 0;
1.1055    raeburn  12558:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  12559:         $offset ++;
1.1065    raeburn  12560:         if ($action ne 'display') {
                   12561:             $offset ++;
                   12562:         }  
1.1055    raeburn  12563:         $output .= '<td><span class="LC_nobreak">'.
                   12564:                    '<label><input type="radio" name="archive_'.$count.
                   12565:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   12566:         my $text = $choices{$action};
                   12567:         if ($is_dir) {
                   12568:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   12569:             if ($action eq 'display') {
1.1059    raeburn  12570:                 $text = &mt('Add as folder');
1.1055    raeburn  12571:             }
1.1056    raeburn  12572:         } else {
                   12573:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   12574: 
                   12575:         }
                   12576:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   12577:         if ($action eq 'dependency') {
                   12578:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   12579:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   12580:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   12581:                        '<option value=""></option>'."\n".
                   12582:                        '</select>'."\n".
                   12583:                        '</div>';
1.1059    raeburn  12584:         } elsif ($action eq 'display') {
                   12585:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   12586:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   12587:                        '</div>';
1.1055    raeburn  12588:         }
1.1056    raeburn  12589:         $output .= '</td>';
1.1055    raeburn  12590:     }
                   12591:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   12592:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   12593:     for (my $i=0; $i<$depth; $i++) {
                   12594:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   12595:     }
                   12596:     if ($is_dir) {
                   12597:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   12598:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   12599:     } else {
                   12600:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   12601:     }
                   12602:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   12603:                &end_data_table_row();
                   12604:     return $output;
                   12605: }
                   12606: 
                   12607: sub archive_options_form {
1.1065    raeburn  12608:     my ($form,$display,$count,$hiddenelem) = @_;
                   12609:     my %lt = &Apache::lonlocal::texthash(
                   12610:                perm => 'Permanently remove archive file?',
                   12611:                hows => 'How should each extracted item be incorporated in the course?',
                   12612:                cont => 'Content actions for all',
                   12613:                addf => 'Add as folder/file',
                   12614:                incd => 'Include as dependency for a displayed file',
                   12615:                disc => 'Discard',
                   12616:                no   => 'No',
                   12617:                yes  => 'Yes',
                   12618:                save => 'Save',
                   12619:     );
                   12620:     my $output = <<"END";
                   12621: <form name="$form" method="post" action="">
                   12622: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   12623: <label>
                   12624:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   12625: </label>
                   12626: &nbsp;
                   12627: <label>
                   12628:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   12629: </span>
                   12630: </p>
                   12631: <input type="hidden" name="phase" value="decompress_cleanup" />
                   12632: <br />$lt{'hows'}
                   12633: <div class="LC_columnSection">
                   12634:   <fieldset>
                   12635:     <legend>$lt{'cont'}</legend>
                   12636:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   12637:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   12638:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   12639:   </fieldset>
                   12640: </div>
                   12641: END
                   12642:     return $output.
1.1055    raeburn  12643:            &start_data_table()."\n".
1.1065    raeburn  12644:            $display."\n".
1.1055    raeburn  12645:            &end_data_table()."\n".
                   12646:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   12647:            $hiddenelem.
1.1065    raeburn  12648:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  12649:            '</form>';
                   12650: }
                   12651: 
                   12652: sub archive_javascript {
1.1056    raeburn  12653:     my ($startcount,$numitems,$titles,$children) = @_;
                   12654:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  12655:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  12656:     my $scripttag = <<START;
                   12657: <script type="text/javascript">
                   12658: // <![CDATA[
                   12659: 
                   12660: function checkAll(form,prefix) {
                   12661:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   12662:     for (var i=0; i < form.elements.length; i++) {
                   12663:         var id = form.elements[i].id;
                   12664:         if ((id != '') && (id != undefined)) {
                   12665:             if (idstr.test(id)) {
                   12666:                 if (form.elements[i].type == 'radio') {
                   12667:                     form.elements[i].checked = true;
1.1056    raeburn  12668:                     var nostart = i-$startcount;
1.1059    raeburn  12669:                     var offset = nostart%7;
                   12670:                     var count = (nostart-offset)/7;    
1.1056    raeburn  12671:                     dependencyCheck(form,count,offset);
1.1055    raeburn  12672:                 }
                   12673:             }
                   12674:         }
                   12675:     }
                   12676: }
                   12677: 
                   12678: function propagateCheck(form,count) {
                   12679:     if (count > 0) {
1.1059    raeburn  12680:         var startelement = $startcount + ((count-1) * 7);
                   12681:         for (var j=1; j<6; j++) {
                   12682:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  12683:                 var item = startelement + j; 
                   12684:                 if (form.elements[item].type == 'radio') {
                   12685:                     if (form.elements[item].checked) {
                   12686:                         containerCheck(form,count,j);
                   12687:                         break;
                   12688:                     }
1.1055    raeburn  12689:                 }
                   12690:             }
                   12691:         }
                   12692:     }
                   12693: }
                   12694: 
                   12695: numitems = $numitems
1.1056    raeburn  12696: var titles = new Array(numitems);
                   12697: var parents = new Array(numitems);
1.1055    raeburn  12698: for (var i=0; i<numitems; i++) {
1.1056    raeburn  12699:     parents[i] = new Array;
1.1055    raeburn  12700: }
1.1059    raeburn  12701: var maintitle = '$maintitle';
1.1055    raeburn  12702: 
                   12703: START
                   12704: 
1.1056    raeburn  12705:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   12706:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  12707:         for (my $i=0; $i<@contents; $i ++) {
                   12708:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   12709:         }
                   12710:     }
                   12711: 
1.1056    raeburn  12712:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   12713:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   12714:     }
                   12715: 
1.1055    raeburn  12716:     $scripttag .= <<END;
                   12717: 
                   12718: function containerCheck(form,count,offset) {
                   12719:     if (count > 0) {
1.1056    raeburn  12720:         dependencyCheck(form,count,offset);
1.1059    raeburn  12721:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  12722:         form.elements[item].checked = true;
                   12723:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12724:             if (parents[count].length > 0) {
                   12725:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  12726:                     containerCheck(form,parents[count][j],offset);
                   12727:                 }
                   12728:             }
                   12729:         }
                   12730:     }
                   12731: }
                   12732: 
                   12733: function dependencyCheck(form,count,offset) {
                   12734:     if (count > 0) {
1.1059    raeburn  12735:         var chosen = (offset+$startcount)+7*(count-1);
                   12736:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  12737:         var currtype = form.elements[depitem].type;
                   12738:         if (form.elements[chosen].value == 'dependency') {
                   12739:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   12740:             form.elements[depitem].options.length = 0;
                   12741:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11  raeburn  12742:             for (var i=1; i<=numitems; i++) {
                   12743:                 if (i == count) {
                   12744:                     continue;
                   12745:                 }
1.1059    raeburn  12746:                 var startelement = $startcount + (i-1) * 7;
                   12747:                 for (var j=1; j<6; j++) {
                   12748:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  12749:                         var item = startelement + j;
                   12750:                         if (form.elements[item].type == 'radio') {
                   12751:                             if (form.elements[item].checked) {
                   12752:                                 if (form.elements[item].value == 'display') {
                   12753:                                     var n = form.elements[depitem].options.length;
                   12754:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   12755:                                 }
                   12756:                             }
                   12757:                         }
                   12758:                     }
                   12759:                 }
                   12760:             }
                   12761:         } else {
                   12762:             document.getElementById('arc_depon_'+count).style.display='none';
                   12763:             form.elements[depitem].options.length = 0;
                   12764:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   12765:         }
1.1059    raeburn  12766:         titleCheck(form,count,offset);
1.1056    raeburn  12767:     }
                   12768: }
                   12769: 
                   12770: function propagateSelect(form,count,offset) {
                   12771:     if (count > 0) {
1.1065    raeburn  12772:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  12773:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   12774:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12775:             if (parents[count].length > 0) {
                   12776:                 for (var j=0; j<parents[count].length; j++) {
                   12777:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  12778:                 }
                   12779:             }
                   12780:         }
                   12781:     }
                   12782: }
1.1056    raeburn  12783: 
                   12784: function containerSelect(form,count,offset,picked) {
                   12785:     if (count > 0) {
1.1065    raeburn  12786:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  12787:         if (form.elements[item].type == 'radio') {
                   12788:             if (form.elements[item].value == 'dependency') {
                   12789:                 if (form.elements[item+1].type == 'select-one') {
                   12790:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   12791:                         if (form.elements[item+1].options[i].value == picked) {
                   12792:                             form.elements[item+1].selectedIndex = i;
                   12793:                             break;
                   12794:                         }
                   12795:                     }
                   12796:                 }
                   12797:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12798:                     if (parents[count].length > 0) {
                   12799:                         for (var j=0; j<parents[count].length; j++) {
                   12800:                             containerSelect(form,parents[count][j],offset,picked);
                   12801:                         }
                   12802:                     }
                   12803:                 }
                   12804:             }
                   12805:         }
                   12806:     }
                   12807: }
                   12808: 
1.1059    raeburn  12809: function titleCheck(form,count,offset) {
                   12810:     if (count > 0) {
                   12811:         var chosen = (offset+$startcount)+7*(count-1);
                   12812:         var depitem = $startcount + ((count-1) * 7) + 2;
                   12813:         var currtype = form.elements[depitem].type;
                   12814:         if (form.elements[chosen].value == 'display') {
                   12815:             document.getElementById('arc_title_'+count).style.display='block';
                   12816:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   12817:                 document.getElementById('archive_title_'+count).value=maintitle;
                   12818:             }
                   12819:         } else {
                   12820:             document.getElementById('arc_title_'+count).style.display='none';
                   12821:             if (currtype == 'text') { 
                   12822:                 document.getElementById('archive_title_'+count).value='';
                   12823:             }
                   12824:         }
                   12825:     }
                   12826:     return;
                   12827: }
                   12828: 
1.1055    raeburn  12829: // ]]>
                   12830: </script>
                   12831: END
                   12832:     return $scripttag;
                   12833: }
                   12834: 
                   12835: sub process_extracted_files {
1.1067    raeburn  12836:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  12837:     my $numitems = $env{'form.archive_count'};
1.1075.2.128  raeburn  12838:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  12839:     my @ids=&Apache::lonnet::current_machine_ids();
                   12840:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  12841:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  12842:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12843:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12844:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   12845:         $pathtocheck = "$dir_root/$destination";
                   12846:         $dir = $dir_root;
                   12847:         $ishome = 1;
                   12848:     } else {
                   12849:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   12850:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1075.2.128  raeburn  12851:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  12852:     }
                   12853:     my $currdir = "$dir_root/$destination";
                   12854:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   12855:     if ($env{'form.folderpath'}) {
                   12856:         my @items = split('&',$env{'form.folderpath'});
                   12857:         $folders{'0'} = $items[-2];
1.1075.2.17  raeburn  12858:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   12859:             $containers{'0'}='page';
                   12860:         } else {
                   12861:             $containers{'0'}='sequence';
                   12862:         }
1.1055    raeburn  12863:     }
                   12864:     my @archdirs = &get_env_multiple('form.archive_directory');
                   12865:     if ($numitems) {
                   12866:         for (my $i=1; $i<=$numitems; $i++) {
                   12867:             my $path = $env{'form.archive_content_'.$i};
                   12868:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   12869:                 my $item = $1;
                   12870:                 $toplevelitems{$item} = $i;
                   12871:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   12872:                     $is_dir{$item} = 1;
                   12873:                 }
                   12874:             }
                   12875:         }
                   12876:     }
1.1067    raeburn  12877:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  12878:     if (keys(%toplevelitems) > 0) {
                   12879:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  12880:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   12881:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  12882:     }
1.1066    raeburn  12883:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  12884:     if ($numitems) {
                   12885:         for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11  raeburn  12886:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  12887:             my $path = $env{'form.archive_content_'.$i};
                   12888:             if ($path =~ /^\Q$pathtocheck\E/) {
                   12889:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   12890:                     if ($prefix ne '' && $path ne '') {
                   12891:                         if (-e $prefix.$path) {
1.1066    raeburn  12892:                             if ((@archdirs > 0) && 
                   12893:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   12894:                                 $todeletedir{$prefix.$path} = 1;
                   12895:                             } else {
                   12896:                                 $todelete{$prefix.$path} = 1;
                   12897:                             }
1.1055    raeburn  12898:                         }
                   12899:                     }
                   12900:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  12901:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  12902:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  12903:                     $docstitle = $env{'form.archive_title_'.$i};
                   12904:                     if ($docstitle eq '') {
                   12905:                         $docstitle = $title;
                   12906:                     }
1.1055    raeburn  12907:                     $outer = 0;
1.1056    raeburn  12908:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   12909:                         if (@{$dirorder{$i}} > 0) {
                   12910:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  12911:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   12912:                                     $outer = $item;
                   12913:                                     last;
                   12914:                                 }
                   12915:                             }
                   12916:                         }
                   12917:                     }
                   12918:                     my ($errtext,$fatal) = 
                   12919:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   12920:                                                '/'.$folders{$outer}.'.'.
                   12921:                                                $containers{$outer});
                   12922:                     next if ($fatal);
                   12923:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   12924:                         if ($context eq 'coursedocs') {
1.1056    raeburn  12925:                             $mapinner{$i} = time;
1.1055    raeburn  12926:                             $folders{$i} = 'default_'.$mapinner{$i};
                   12927:                             $containers{$i} = 'sequence';
                   12928:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   12929:                                       $folders{$i}.'.'.$containers{$i};
                   12930:                             my $newidx = &LONCAPA::map::getresidx();
                   12931:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  12932:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  12933:                             push(@LONCAPA::map::order,$newidx);
                   12934:                             my ($outtext,$errtext) =
                   12935:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   12936:                                                         $docuname.'/'.$folders{$outer}.
1.1075.2.11  raeburn  12937:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  12938:                             $newseqid{$i} = $newidx;
1.1067    raeburn  12939:                             unless ($errtext) {
1.1075.2.128  raeburn  12940:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   12941:                                                        &HTML::Entities::encode($docstitle,'<>&"'))..
                   12942:                                             '</li>'."\n";
1.1067    raeburn  12943:                             }
1.1055    raeburn  12944:                         }
                   12945:                     } else {
                   12946:                         if ($context eq 'coursedocs') {
                   12947:                             my $newidx=&LONCAPA::map::getresidx();
                   12948:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   12949:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   12950:                                       $title;
1.1075.2.128  raeburn  12951:                             if (($outer !~ /\D/) && ($mapinner{$outer} !~ /\D/) && ($newidx !~ /\D/)) {
                   12952:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   12953:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
1.1067    raeburn  12954:                                 }
1.1075.2.128  raeburn  12955:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   12956:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   12957:                                 }
                   12958:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   12959:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   12960:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   12961:                                         unless ($ishome) {
                   12962:                                             my $fetch = "$newdest{$i}/$title";
                   12963:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   12964:                                             $prompttofetch{$fetch} = 1;
                   12965:                                         }
                   12966:                                    }
                   12967:                                 }
                   12968:                                 $LONCAPA::map::resources[$newidx]=
                   12969:                                     $docstitle.':'.$url.':false:normal:res';
                   12970:                                 push(@LONCAPA::map::order, $newidx);
                   12971:                                 my ($outtext,$errtext)=
                   12972:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   12973:                                                             $docuname.'/'.$folders{$outer}.
                   12974:                                                             '.'.$containers{$outer},1,1);
                   12975:                                 unless ($errtext) {
                   12976:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   12977:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   12978:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   12979:                                                    '</li>'."\n";
                   12980:                                     }
1.1067    raeburn  12981:                                 }
1.1075.2.128  raeburn  12982:                             } else {
                   12983:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   12984:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1067    raeburn  12985:                             }
1.1055    raeburn  12986:                         }
                   12987:                     }
1.1075.2.11  raeburn  12988:                 }
                   12989:             } else {
1.1075.2.128  raeburn  12990:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   12991:                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1075.2.11  raeburn  12992:             }
                   12993:         }
                   12994:         for (my $i=1; $i<=$numitems; $i++) {
                   12995:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   12996:             my $path = $env{'form.archive_content_'.$i};
                   12997:             if ($path =~ /^\Q$pathtocheck\E/) {
                   12998:                 my ($title) = ($path =~ m{/([^/]+)$});
                   12999:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   13000:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   13001:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13002:                         my ($itemidx,$fullpath,$relpath);
                   13003:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   13004:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  13005:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11  raeburn  13006:                                 if ($dirorder{$i}->[$j] eq $container) {
                   13007:                                     $itemidx = $j;
1.1056    raeburn  13008:                                 }
                   13009:                             }
1.1075.2.11  raeburn  13010:                         }
                   13011:                         if ($itemidx eq '') {
                   13012:                             $itemidx =  0;
                   13013:                         }
                   13014:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   13015:                             if ($mapinner{$referrer{$i}}) {
                   13016:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   13017:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13018:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13019:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13020:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13021:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13022:                                             if (!-e $fullpath) {
                   13023:                                                 mkdir($fullpath,0755);
1.1056    raeburn  13024:                                             }
                   13025:                                         }
1.1075.2.11  raeburn  13026:                                     } else {
                   13027:                                         last;
1.1056    raeburn  13028:                                     }
1.1075.2.11  raeburn  13029:                                 }
                   13030:                             }
                   13031:                         } elsif ($newdest{$referrer{$i}}) {
                   13032:                             $fullpath = $newdest{$referrer{$i}};
                   13033:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13034:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   13035:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   13036:                                     last;
                   13037:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13038:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13039:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13040:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13041:                                         if (!-e $fullpath) {
                   13042:                                             mkdir($fullpath,0755);
1.1056    raeburn  13043:                                         }
                   13044:                                     }
1.1075.2.11  raeburn  13045:                                 } else {
                   13046:                                     last;
1.1056    raeburn  13047:                                 }
1.1075.2.11  raeburn  13048:                             }
                   13049:                         }
                   13050:                         if ($fullpath ne '') {
                   13051:                             if (-e "$prefix$path") {
1.1075.2.128  raeburn  13052:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   13053:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   13054:                                 }
1.1075.2.11  raeburn  13055:                             }
                   13056:                             if (-e "$fullpath/$title") {
                   13057:                                 my $showpath;
                   13058:                                 if ($relpath ne '') {
                   13059:                                     $showpath = "$relpath/$title";
                   13060:                                 } else {
                   13061:                                     $showpath = "/$title";
1.1056    raeburn  13062:                                 }
1.1075.2.128  raeburn  13063:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   13064:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   13065:                                            '</li>'."\n";
                   13066:                                 unless ($ishome) {
                   13067:                                     my $fetch = "$fullpath/$title";
                   13068:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   13069:                                     $prompttofetch{$fetch} = 1;
                   13070:                                 }
1.1055    raeburn  13071:                             }
                   13072:                         }
                   13073:                     }
1.1075.2.11  raeburn  13074:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   13075:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1075.2.128  raeburn  13076:                                     &HTML::Entities::encode($path,'<>&"'),
                   13077:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   13078:                                 '<br />';
1.1055    raeburn  13079:                 }
                   13080:             } else {
1.1075.2.128  raeburn  13081:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13082:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  13083:             }
                   13084:         }
                   13085:         if (keys(%todelete)) {
                   13086:             foreach my $key (keys(%todelete)) {
                   13087:                 unlink($key);
1.1066    raeburn  13088:             }
                   13089:         }
                   13090:         if (keys(%todeletedir)) {
                   13091:             foreach my $key (keys(%todeletedir)) {
                   13092:                 rmdir($key);
                   13093:             }
                   13094:         }
                   13095:         foreach my $dir (sort(keys(%is_dir))) {
                   13096:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   13097:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  13098:             }
                   13099:         }
1.1067    raeburn  13100:         if ($result ne '') {
                   13101:             $output .= '<ul>'."\n".
                   13102:                        $result."\n".
                   13103:                        '</ul>';
                   13104:         }
                   13105:         unless ($ishome) {
                   13106:             my $replicationfail;
                   13107:             foreach my $item (keys(%prompttofetch)) {
                   13108:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   13109:                 unless ($fetchresult eq 'ok') {
                   13110:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   13111:                 }
                   13112:             }
                   13113:             if ($replicationfail) {
                   13114:                 $output .= '<p class="LC_error">'.
                   13115:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   13116:                            $replicationfail.
                   13117:                            '</ul></p>';
                   13118:             }
                   13119:         }
1.1055    raeburn  13120:     } else {
                   13121:         $warning = &mt('No items found in archive.');
                   13122:     }
                   13123:     if ($error) {
                   13124:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   13125:                    $error.'</p>'."\n";
                   13126:     }
                   13127:     if ($warning) {
                   13128:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   13129:     }
                   13130:     return $output;
                   13131: }
                   13132: 
1.1066    raeburn  13133: sub cleanup_empty_dirs {
                   13134:     my ($path) = @_;
                   13135:     if (($path ne '') && (-d $path)) {
                   13136:         if (opendir(my $dirh,$path)) {
                   13137:             my @dircontents = grep(!/^\./,readdir($dirh));
                   13138:             my $numitems = 0;
                   13139:             foreach my $item (@dircontents) {
                   13140:                 if (-d "$path/$item") {
1.1075.2.28  raeburn  13141:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  13142:                     if (-e "$path/$item") {
                   13143:                         $numitems ++;
                   13144:                     }
                   13145:                 } else {
                   13146:                     $numitems ++;
                   13147:                 }
                   13148:             }
                   13149:             if ($numitems == 0) {
                   13150:                 rmdir($path);
                   13151:             }
                   13152:             closedir($dirh);
                   13153:         }
                   13154:     }
                   13155:     return;
                   13156: }
                   13157: 
1.41      ng       13158: =pod
1.45      matthew  13159: 
1.1075.2.56  raeburn  13160: =item * &get_folder_hierarchy()
1.1068    raeburn  13161: 
                   13162: Provides hierarchy of names of folders/sub-folders containing the current
                   13163: item,
                   13164: 
                   13165: Inputs: 3
                   13166:      - $navmap - navmaps object
                   13167: 
                   13168:      - $map - url for map (either the trigger itself, or map containing
                   13169:                            the resource, which is the trigger).
                   13170: 
                   13171:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   13172: 
                   13173: Outputs: 1 @pathitems - array of folder/subfolder names.
                   13174: 
                   13175: =cut
                   13176: 
                   13177: sub get_folder_hierarchy {
                   13178:     my ($navmap,$map,$showitem) = @_;
                   13179:     my @pathitems;
                   13180:     if (ref($navmap)) {
                   13181:         my $mapres = $navmap->getResourceByUrl($map);
                   13182:         if (ref($mapres)) {
                   13183:             my $pcslist = $mapres->map_hierarchy();
                   13184:             if ($pcslist ne '') {
                   13185:                 my @pcs = split(/,/,$pcslist);
                   13186:                 foreach my $pc (@pcs) {
                   13187:                     if ($pc == 1) {
1.1075.2.38  raeburn  13188:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  13189:                     } else {
                   13190:                         my $res = $navmap->getByMapPc($pc);
                   13191:                         if (ref($res)) {
                   13192:                             my $title = $res->compTitle();
                   13193:                             $title =~ s/\W+/_/g;
                   13194:                             if ($title ne '') {
                   13195:                                 push(@pathitems,$title);
                   13196:                             }
                   13197:                         }
                   13198:                     }
                   13199:                 }
                   13200:             }
1.1071    raeburn  13201:             if ($showitem) {
                   13202:                 if ($mapres->{ID} eq '0.0') {
1.1075.2.38  raeburn  13203:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  13204:                 } else {
                   13205:                     my $maptitle = $mapres->compTitle();
                   13206:                     $maptitle =~ s/\W+/_/g;
                   13207:                     if ($maptitle ne '') {
                   13208:                         push(@pathitems,$maptitle);
                   13209:                     }
1.1068    raeburn  13210:                 }
                   13211:             }
                   13212:         }
                   13213:     }
                   13214:     return @pathitems;
                   13215: }
                   13216: 
                   13217: =pod
                   13218: 
1.1015    raeburn  13219: =item * &get_turnedin_filepath()
                   13220: 
                   13221: Determines path in a user's portfolio file for storage of files uploaded
                   13222: to a specific essayresponse or dropbox item.
                   13223: 
                   13224: Inputs: 3 required + 1 optional.
                   13225: $symb is symb for resource, $uname and $udom are for current user (required).
                   13226: $caller is optional (can be "submission", if routine is called when storing
                   13227: an upoaded file when "Submit Answer" button was pressed).
                   13228: 
                   13229: Returns array containing $path and $multiresp. 
                   13230: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   13231: than one file upload item.  Callers of routine should append partid as a 
                   13232: subdirectory to $path in cases where $multiresp is 1.
                   13233: 
                   13234: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   13235: 
                   13236: =cut
                   13237: 
                   13238: sub get_turnedin_filepath {
                   13239:     my ($symb,$uname,$udom,$caller) = @_;
                   13240:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   13241:     my $turnindir;
                   13242:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   13243:     $turnindir = $userhash{'turnindir'};
                   13244:     my ($path,$multiresp);
                   13245:     if ($turnindir eq '') {
                   13246:         if ($caller eq 'submission') {
                   13247:             $turnindir = &mt('turned in');
                   13248:             $turnindir =~ s/\W+/_/g;
                   13249:             my %newhash = (
                   13250:                             'turnindir' => $turnindir,
                   13251:                           );
                   13252:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   13253:         }
                   13254:     }
                   13255:     if ($turnindir ne '') {
                   13256:         $path = '/'.$turnindir.'/';
                   13257:         my ($multipart,$turnin,@pathitems);
                   13258:         my $navmap = Apache::lonnavmaps::navmap->new();
                   13259:         if (defined($navmap)) {
                   13260:             my $mapres = $navmap->getResourceByUrl($map);
                   13261:             if (ref($mapres)) {
                   13262:                 my $pcslist = $mapres->map_hierarchy();
                   13263:                 if ($pcslist ne '') {
                   13264:                     foreach my $pc (split(/,/,$pcslist)) {
                   13265:                         my $res = $navmap->getByMapPc($pc);
                   13266:                         if (ref($res)) {
                   13267:                             my $title = $res->compTitle();
                   13268:                             $title =~ s/\W+/_/g;
                   13269:                             if ($title ne '') {
1.1075.2.48  raeburn  13270:                                 if (($pc > 1) && (length($title) > 12)) {
                   13271:                                     $title = substr($title,0,12);
                   13272:                                 }
1.1015    raeburn  13273:                                 push(@pathitems,$title);
                   13274:                             }
                   13275:                         }
                   13276:                     }
                   13277:                 }
                   13278:                 my $maptitle = $mapres->compTitle();
                   13279:                 $maptitle =~ s/\W+/_/g;
                   13280:                 if ($maptitle ne '') {
1.1075.2.48  raeburn  13281:                     if (length($maptitle) > 12) {
                   13282:                         $maptitle = substr($maptitle,0,12);
                   13283:                     }
1.1015    raeburn  13284:                     push(@pathitems,$maptitle);
                   13285:                 }
                   13286:                 unless ($env{'request.state'} eq 'construct') {
                   13287:                     my $res = $navmap->getBySymb($symb);
                   13288:                     if (ref($res)) {
                   13289:                         my $partlist = $res->parts();
                   13290:                         my $totaluploads = 0;
                   13291:                         if (ref($partlist) eq 'ARRAY') {
                   13292:                             foreach my $part (@{$partlist}) {
                   13293:                                 my @types = $res->responseType($part);
                   13294:                                 my @ids = $res->responseIds($part);
                   13295:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   13296:                                     if ($types[$i] eq 'essay') {
                   13297:                                         my $partid = $part.'_'.$ids[$i];
                   13298:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   13299:                                             $totaluploads ++;
                   13300:                                         }
                   13301:                                     }
                   13302:                                 }
                   13303:                             }
                   13304:                             if ($totaluploads > 1) {
                   13305:                                 $multiresp = 1;
                   13306:                             }
                   13307:                         }
                   13308:                     }
                   13309:                 }
                   13310:             } else {
                   13311:                 return;
                   13312:             }
                   13313:         } else {
                   13314:             return;
                   13315:         }
                   13316:         my $restitle=&Apache::lonnet::gettitle($symb);
                   13317:         $restitle =~ s/\W+/_/g;
                   13318:         if ($restitle eq '') {
                   13319:             $restitle = ($resurl =~ m{/[^/]+$});
                   13320:             if ($restitle eq '') {
                   13321:                 $restitle = time;
                   13322:             }
                   13323:         }
1.1075.2.48  raeburn  13324:         if (length($restitle) > 12) {
                   13325:             $restitle = substr($restitle,0,12);
                   13326:         }
1.1015    raeburn  13327:         push(@pathitems,$restitle);
                   13328:         $path .= join('/',@pathitems);
                   13329:     }
                   13330:     return ($path,$multiresp);
                   13331: }
                   13332: 
                   13333: =pod
                   13334: 
1.464     albertel 13335: =back
1.41      ng       13336: 
1.112     bowersj2 13337: =head1 CSV Upload/Handling functions
1.38      albertel 13338: 
1.41      ng       13339: =over 4
                   13340: 
1.648     raeburn  13341: =item * &upfile_store($r)
1.41      ng       13342: 
                   13343: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 13344: needs $env{'form.upfile'}
1.41      ng       13345: returns $datatoken to be put into hidden field
                   13346: 
                   13347: =cut
1.31      albertel 13348: 
                   13349: sub upfile_store {
                   13350:     my $r=shift;
1.258     albertel 13351:     $env{'form.upfile'}=~s/\r/\n/gs;
                   13352:     $env{'form.upfile'}=~s/\f/\n/gs;
                   13353:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   13354:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 13355: 
1.1075.2.128  raeburn  13356:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   13357:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   13358:                                      time.'_'.$$);
                   13359:     return if ($datatoken eq '');
                   13360: 
1.31      albertel 13361:     {
1.158     raeburn  13362:         my $datafile = $r->dir_config('lonDaemons').
                   13363:                            '/tmp/'.$datatoken.'.tmp';
1.1075.2.128  raeburn  13364:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 13365:             print $fh $env{'form.upfile'};
1.158     raeburn  13366:             close($fh);
                   13367:         }
1.31      albertel 13368:     }
                   13369:     return $datatoken;
                   13370: }
                   13371: 
1.56      matthew  13372: =pod
                   13373: 
1.1075.2.128  raeburn  13374: =item * &load_tmp_file($r,$datatoken)
1.41      ng       13375: 
                   13376: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1075.2.128  raeburn  13377: $datatoken is the name to assign to the temporary file.
1.258     albertel 13378: sets $env{'form.upfile'} to the contents of the file
1.41      ng       13379: 
                   13380: =cut
1.31      albertel 13381: 
                   13382: sub load_tmp_file {
1.1075.2.128  raeburn  13383:     my ($r,$datatoken) = @_;
                   13384:     return if ($datatoken eq '');
1.31      albertel 13385:     my @studentdata=();
                   13386:     {
1.158     raeburn  13387:         my $studentfile = $r->dir_config('lonDaemons').
1.1075.2.128  raeburn  13388:                               '/tmp/'.$datatoken.'.tmp';
                   13389:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  13390:             @studentdata=<$fh>;
                   13391:             close($fh);
                   13392:         }
1.31      albertel 13393:     }
1.258     albertel 13394:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 13395: }
                   13396: 
1.1075.2.128  raeburn  13397: sub valid_datatoken {
                   13398:     my ($datatoken) = @_;
1.1075.2.131  raeburn  13399:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1075.2.128  raeburn  13400:         return $datatoken;
                   13401:     }
                   13402:     return;
                   13403: }
                   13404: 
1.56      matthew  13405: =pod
                   13406: 
1.648     raeburn  13407: =item * &upfile_record_sep()
1.41      ng       13408: 
                   13409: Separate uploaded file into records
                   13410: returns array of records,
1.258     albertel 13411: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       13412: 
                   13413: =cut
1.31      albertel 13414: 
                   13415: sub upfile_record_sep {
1.258     albertel 13416:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 13417:     } else {
1.248     albertel 13418: 	my @records;
1.258     albertel 13419: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 13420: 	    if ($line=~/^\s*$/) { next; }
                   13421: 	    push(@records,$line);
                   13422: 	}
                   13423: 	return @records;
1.31      albertel 13424:     }
                   13425: }
                   13426: 
1.56      matthew  13427: =pod
                   13428: 
1.648     raeburn  13429: =item * &record_sep($record)
1.41      ng       13430: 
1.258     albertel 13431: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       13432: 
                   13433: =cut
                   13434: 
1.263     www      13435: sub takeleft {
                   13436:     my $index=shift;
                   13437:     return substr('0000'.$index,-4,4);
                   13438: }
                   13439: 
1.31      albertel 13440: sub record_sep {
                   13441:     my $record=shift;
                   13442:     my %components=();
1.258     albertel 13443:     if ($env{'form.upfiletype'} eq 'xml') {
                   13444:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 13445:         my $i=0;
1.356     albertel 13446:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 13447:             $field=~s/^(\"|\')//;
                   13448:             $field=~s/(\"|\')$//;
1.263     www      13449:             $components{&takeleft($i)}=$field;
1.31      albertel 13450:             $i++;
                   13451:         }
1.258     albertel 13452:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 13453:         my $i=0;
1.356     albertel 13454:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 13455:             $field=~s/^(\"|\')//;
                   13456:             $field=~s/(\"|\')$//;
1.263     www      13457:             $components{&takeleft($i)}=$field;
1.31      albertel 13458:             $i++;
                   13459:         }
                   13460:     } else {
1.561     www      13461:         my $separator=',';
1.480     banghart 13462:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      13463:             $separator=';';
1.480     banghart 13464:         }
1.31      albertel 13465:         my $i=0;
1.561     www      13466: # the character we are looking for to indicate the end of a quote or a record 
                   13467:         my $looking_for=$separator;
                   13468: # do not add the characters to the fields
                   13469:         my $ignore=0;
                   13470: # we just encountered a separator (or the beginning of the record)
                   13471:         my $just_found_separator=1;
                   13472: # store the field we are working on here
                   13473:         my $field='';
                   13474: # work our way through all characters in record
                   13475:         foreach my $character ($record=~/(.)/g) {
                   13476:             if ($character eq $looking_for) {
                   13477:                if ($character ne $separator) {
                   13478: # Found the end of a quote, again looking for separator
                   13479:                   $looking_for=$separator;
                   13480:                   $ignore=1;
                   13481:                } else {
                   13482: # Found a separator, store away what we got
                   13483:                   $components{&takeleft($i)}=$field;
                   13484: 	          $i++;
                   13485:                   $just_found_separator=1;
                   13486:                   $ignore=0;
                   13487:                   $field='';
                   13488:                }
                   13489:                next;
                   13490:             }
                   13491: # single or double quotation marks after a separator indicate beginning of a quote
                   13492: # we are now looking for the end of the quote and need to ignore separators
                   13493:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   13494:                $looking_for=$character;
                   13495:                next;
                   13496:             }
                   13497: # ignore would be true after we reached the end of a quote
                   13498:             if ($ignore) { next; }
                   13499:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   13500:             $field.=$character;
                   13501:             $just_found_separator=0; 
1.31      albertel 13502:         }
1.561     www      13503: # catch the very last entry, since we never encountered the separator
                   13504:         $components{&takeleft($i)}=$field;
1.31      albertel 13505:     }
                   13506:     return %components;
                   13507: }
                   13508: 
1.144     matthew  13509: ######################################################
                   13510: ######################################################
                   13511: 
1.56      matthew  13512: =pod
                   13513: 
1.648     raeburn  13514: =item * &upfile_select_html()
1.41      ng       13515: 
1.144     matthew  13516: Return HTML code to select a file from the users machine and specify 
                   13517: the file type.
1.41      ng       13518: 
                   13519: =cut
                   13520: 
1.144     matthew  13521: ######################################################
                   13522: ######################################################
1.31      albertel 13523: sub upfile_select_html {
1.144     matthew  13524:     my %Types = (
                   13525:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 13526:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  13527:                  space => &mt('Space separated'),
                   13528:                  tab   => &mt('Tabulator separated'),
                   13529: #                 xml   => &mt('HTML/XML'),
                   13530:                  );
                   13531:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  13532:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  13533:     foreach my $type (sort(keys(%Types))) {
                   13534:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   13535:     }
                   13536:     $Str .= "</select>\n";
                   13537:     return $Str;
1.31      albertel 13538: }
                   13539: 
1.301     albertel 13540: sub get_samples {
                   13541:     my ($records,$toget) = @_;
                   13542:     my @samples=({});
                   13543:     my $got=0;
                   13544:     foreach my $rec (@$records) {
                   13545: 	my %temp = &record_sep($rec);
                   13546: 	if (! grep(/\S/, values(%temp))) { next; }
                   13547: 	if (%temp) {
                   13548: 	    $samples[$got]=\%temp;
                   13549: 	    $got++;
                   13550: 	    if ($got == $toget) { last; }
                   13551: 	}
                   13552:     }
                   13553:     return \@samples;
                   13554: }
                   13555: 
1.144     matthew  13556: ######################################################
                   13557: ######################################################
                   13558: 
1.56      matthew  13559: =pod
                   13560: 
1.648     raeburn  13561: =item * &csv_print_samples($r,$records)
1.41      ng       13562: 
                   13563: Prints a table of sample values from each column uploaded $r is an
                   13564: Apache Request ref, $records is an arrayref from
                   13565: &Apache::loncommon::upfile_record_sep
                   13566: 
                   13567: =cut
                   13568: 
1.144     matthew  13569: ######################################################
                   13570: ######################################################
1.31      albertel 13571: sub csv_print_samples {
                   13572:     my ($r,$records) = @_;
1.662     bisitz   13573:     my $samples = &get_samples($records,5);
1.301     albertel 13574: 
1.594     raeburn  13575:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   13576:               &start_data_table_header_row());
1.356     albertel 13577:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   13578:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  13579:     $r->print(&end_data_table_header_row());
1.301     albertel 13580:     foreach my $hash (@$samples) {
1.594     raeburn  13581: 	$r->print(&start_data_table_row());
1.356     albertel 13582: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 13583: 	    $r->print('<td>');
1.356     albertel 13584: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 13585: 	    $r->print('</td>');
                   13586: 	}
1.594     raeburn  13587: 	$r->print(&end_data_table_row());
1.31      albertel 13588:     }
1.594     raeburn  13589:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 13590: }
                   13591: 
1.144     matthew  13592: ######################################################
                   13593: ######################################################
                   13594: 
1.56      matthew  13595: =pod
                   13596: 
1.648     raeburn  13597: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       13598: 
                   13599: Prints a table to create associations between values and table columns.
1.144     matthew  13600: 
1.41      ng       13601: $r is an Apache Request ref,
                   13602: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  13603: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       13604: 
                   13605: =cut
                   13606: 
1.144     matthew  13607: ######################################################
                   13608: ######################################################
1.31      albertel 13609: sub csv_print_select_table {
                   13610:     my ($r,$records,$d) = @_;
1.301     albertel 13611:     my $i=0;
                   13612:     my $samples = &get_samples($records,1);
1.144     matthew  13613:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  13614: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  13615:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  13616:               '<th>'.&mt('Column').'</th>'.
                   13617:               &end_data_table_header_row()."\n");
1.356     albertel 13618:     foreach my $array_ref (@$d) {
                   13619: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  13620: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 13621: 
1.875     bisitz   13622: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  13623: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 13624: 	$r->print('<option value="none"></option>');
1.356     albertel 13625: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   13626: 	    $r->print('<option value="'.$sample.'"'.
                   13627:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   13628:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 13629: 	}
1.594     raeburn  13630: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 13631: 	$i++;
                   13632:     }
1.594     raeburn  13633:     $r->print(&end_data_table());
1.31      albertel 13634:     $i--;
                   13635:     return $i;
                   13636: }
1.56      matthew  13637: 
1.144     matthew  13638: ######################################################
                   13639: ######################################################
                   13640: 
1.56      matthew  13641: =pod
1.31      albertel 13642: 
1.648     raeburn  13643: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       13644: 
                   13645: Prints a table of sample values from the upload and can make associate samples to internal names.
                   13646: 
                   13647: $r is an Apache Request ref,
                   13648: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   13649: $d is an array of 2 element arrays (internal name, displayed name)
                   13650: 
                   13651: =cut
                   13652: 
1.144     matthew  13653: ######################################################
                   13654: ######################################################
1.31      albertel 13655: sub csv_samples_select_table {
                   13656:     my ($r,$records,$d) = @_;
                   13657:     my $i=0;
1.144     matthew  13658:     #
1.662     bisitz   13659:     my $max_samples = 5;
                   13660:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  13661:     $r->print(&start_data_table().
                   13662:               &start_data_table_header_row().'<th>'.
                   13663:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   13664:               &end_data_table_header_row());
1.301     albertel 13665: 
                   13666:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  13667: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  13668: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 13669: 	foreach my $option (@$d) {
                   13670: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  13671: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 13672:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  13673:                       $display.'</option>');
1.31      albertel 13674: 	}
                   13675: 	$r->print('</select></td><td>');
1.662     bisitz   13676: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 13677: 	    if (defined($samples->[$line]{$key})) { 
                   13678: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   13679: 	    }
                   13680: 	}
1.594     raeburn  13681: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 13682: 	$i++;
                   13683:     }
1.594     raeburn  13684:     $r->print(&end_data_table());
1.31      albertel 13685:     $i--;
                   13686:     return($i);
1.115     matthew  13687: }
                   13688: 
1.144     matthew  13689: ######################################################
                   13690: ######################################################
                   13691: 
1.115     matthew  13692: =pod
                   13693: 
1.648     raeburn  13694: =item * &clean_excel_name($name)
1.115     matthew  13695: 
                   13696: Returns a replacement for $name which does not contain any illegal characters.
                   13697: 
                   13698: =cut
                   13699: 
1.144     matthew  13700: ######################################################
                   13701: ######################################################
1.115     matthew  13702: sub clean_excel_name {
                   13703:     my ($name) = @_;
                   13704:     $name =~ s/[:\*\?\/\\]//g;
                   13705:     if (length($name) > 31) {
                   13706:         $name = substr($name,0,31);
                   13707:     }
                   13708:     return $name;
1.25      albertel 13709: }
1.84      albertel 13710: 
1.85      albertel 13711: =pod
                   13712: 
1.648     raeburn  13713: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 13714: 
                   13715: Returns either 1 or undef
                   13716: 
                   13717: 1 if the part is to be hidden, undef if it is to be shown
                   13718: 
                   13719: Arguments are:
                   13720: 
                   13721: $id the id of the part to be checked
                   13722: $symb, optional the symb of the resource to check
                   13723: $udom, optional the domain of the user to check for
                   13724: $uname, optional the username of the user to check for
                   13725: 
                   13726: =cut
1.84      albertel 13727: 
                   13728: sub check_if_partid_hidden {
                   13729:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 13730:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 13731: 					 $symb,$udom,$uname);
1.141     albertel 13732:     my $truth=1;
                   13733:     #if the string starts with !, then the list is the list to show not hide
                   13734:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 13735:     my @hiddenlist=split(/,/,$hiddenparts);
                   13736:     foreach my $checkid (@hiddenlist) {
1.141     albertel 13737: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 13738:     }
1.141     albertel 13739:     return !$truth;
1.84      albertel 13740: }
1.127     matthew  13741: 
1.138     matthew  13742: 
                   13743: ############################################################
                   13744: ############################################################
                   13745: 
                   13746: =pod
                   13747: 
1.157     matthew  13748: =back 
                   13749: 
1.138     matthew  13750: =head1 cgi-bin script and graphing routines
                   13751: 
1.157     matthew  13752: =over 4
                   13753: 
1.648     raeburn  13754: =item * &get_cgi_id()
1.138     matthew  13755: 
                   13756: Inputs: none
                   13757: 
                   13758: Returns an id which can be used to pass environment variables
                   13759: to various cgi-bin scripts.  These environment variables will
                   13760: be removed from the users environment after a given time by
                   13761: the routine &Apache::lonnet::transfer_profile_to_env.
                   13762: 
                   13763: =cut
                   13764: 
                   13765: ############################################################
                   13766: ############################################################
1.152     albertel 13767: my $uniq=0;
1.136     matthew  13768: sub get_cgi_id {
1.154     albertel 13769:     $uniq=($uniq+1)%100000;
1.280     albertel 13770:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  13771: }
                   13772: 
1.127     matthew  13773: ############################################################
                   13774: ############################################################
                   13775: 
                   13776: =pod
                   13777: 
1.648     raeburn  13778: =item * &DrawBarGraph()
1.127     matthew  13779: 
1.138     matthew  13780: Facilitates the plotting of data in a (stacked) bar graph.
                   13781: Puts plot definition data into the users environment in order for 
                   13782: graph.png to plot it.  Returns an <img> tag for the plot.
                   13783: The bars on the plot are labeled '1','2',...,'n'.
                   13784: 
                   13785: Inputs:
                   13786: 
                   13787: =over 4
                   13788: 
                   13789: =item $Title: string, the title of the plot
                   13790: 
                   13791: =item $xlabel: string, text describing the X-axis of the plot
                   13792: 
                   13793: =item $ylabel: string, text describing the Y-axis of the plot
                   13794: 
                   13795: =item $Max: scalar, the maximum Y value to use in the plot
                   13796: If $Max is < any data point, the graph will not be rendered.
                   13797: 
1.140     matthew  13798: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  13799: they are plotted.  If undefined, default values will be used.
                   13800: 
1.178     matthew  13801: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   13802: 
1.138     matthew  13803: =item @Values: An array of array references.  Each array reference holds data
                   13804: to be plotted in a stacked bar chart.
                   13805: 
1.239     matthew  13806: =item If the final element of @Values is a hash reference the key/value
                   13807: pairs will be added to the graph definition.
                   13808: 
1.138     matthew  13809: =back
                   13810: 
                   13811: Returns:
                   13812: 
                   13813: An <img> tag which references graph.png and the appropriate identifying
                   13814: information for the plot.
                   13815: 
1.127     matthew  13816: =cut
                   13817: 
                   13818: ############################################################
                   13819: ############################################################
1.134     matthew  13820: sub DrawBarGraph {
1.178     matthew  13821:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  13822:     #
                   13823:     if (! defined($colors)) {
                   13824:         $colors = ['#33ff00', 
                   13825:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   13826:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   13827:                   ]; 
                   13828:     }
1.228     matthew  13829:     my $extra_settings = {};
                   13830:     if (ref($Values[-1]) eq 'HASH') {
                   13831:         $extra_settings = pop(@Values);
                   13832:     }
1.127     matthew  13833:     #
1.136     matthew  13834:     my $identifier = &get_cgi_id();
                   13835:     my $id = 'cgi.'.$identifier;        
1.129     matthew  13836:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  13837:         return '';
                   13838:     }
1.225     matthew  13839:     #
                   13840:     my @Labels;
                   13841:     if (defined($labels)) {
                   13842:         @Labels = @$labels;
                   13843:     } else {
                   13844:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1075.2.119  raeburn  13845:             push(@Labels,$i+1);
1.225     matthew  13846:         }
                   13847:     }
                   13848:     #
1.129     matthew  13849:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  13850:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  13851:     my %ValuesHash;
                   13852:     my $NumSets=1;
                   13853:     foreach my $array (@Values) {
                   13854:         next if (! ref($array));
1.136     matthew  13855:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  13856:             join(',',@$array);
1.129     matthew  13857:     }
1.127     matthew  13858:     #
1.136     matthew  13859:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  13860:     if ($NumBars < 3) {
                   13861:         $width = 120+$NumBars*32;
1.220     matthew  13862:         $xskip = 1;
1.225     matthew  13863:         $bar_width = 30;
                   13864:     } elsif ($NumBars < 5) {
                   13865:         $width = 120+$NumBars*20;
                   13866:         $xskip = 1;
                   13867:         $bar_width = 20;
1.220     matthew  13868:     } elsif ($NumBars < 10) {
1.136     matthew  13869:         $width = 120+$NumBars*15;
                   13870:         $xskip = 1;
                   13871:         $bar_width = 15;
                   13872:     } elsif ($NumBars <= 25) {
                   13873:         $width = 120+$NumBars*11;
                   13874:         $xskip = 5;
                   13875:         $bar_width = 8;
                   13876:     } elsif ($NumBars <= 50) {
                   13877:         $width = 120+$NumBars*8;
                   13878:         $xskip = 5;
                   13879:         $bar_width = 4;
                   13880:     } else {
                   13881:         $width = 120+$NumBars*8;
                   13882:         $xskip = 5;
                   13883:         $bar_width = 4;
                   13884:     }
                   13885:     #
1.137     matthew  13886:     $Max = 1 if ($Max < 1);
                   13887:     if ( int($Max) < $Max ) {
                   13888:         $Max++;
                   13889:         $Max = int($Max);
                   13890:     }
1.127     matthew  13891:     $Title  = '' if (! defined($Title));
                   13892:     $xlabel = '' if (! defined($xlabel));
                   13893:     $ylabel = '' if (! defined($ylabel));
1.369     www      13894:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   13895:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   13896:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  13897:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  13898:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   13899:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   13900:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   13901:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   13902:     $ValuesHash{$id.'.height'}   = $height;
                   13903:     $ValuesHash{$id.'.width'}    = $width;
                   13904:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   13905:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   13906:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  13907:     #
1.228     matthew  13908:     # Deal with other parameters
                   13909:     while (my ($key,$value) = each(%$extra_settings)) {
                   13910:         $ValuesHash{$id.'.'.$key} = $value;
                   13911:     }
                   13912:     #
1.646     raeburn  13913:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  13914:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   13915: }
                   13916: 
                   13917: ############################################################
                   13918: ############################################################
                   13919: 
                   13920: =pod
                   13921: 
1.648     raeburn  13922: =item * &DrawXYGraph()
1.137     matthew  13923: 
1.138     matthew  13924: Facilitates the plotting of data in an XY graph.
                   13925: Puts plot definition data into the users environment in order for 
                   13926: graph.png to plot it.  Returns an <img> tag for the plot.
                   13927: 
                   13928: Inputs:
                   13929: 
                   13930: =over 4
                   13931: 
                   13932: =item $Title: string, the title of the plot
                   13933: 
                   13934: =item $xlabel: string, text describing the X-axis of the plot
                   13935: 
                   13936: =item $ylabel: string, text describing the Y-axis of the plot
                   13937: 
                   13938: =item $Max: scalar, the maximum Y value to use in the plot
                   13939: If $Max is < any data point, the graph will not be rendered.
                   13940: 
                   13941: =item $colors: Array ref containing the hex color codes for the data to be 
                   13942: plotted in.  If undefined, default values will be used.
                   13943: 
                   13944: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   13945: 
                   13946: =item $Ydata: Array ref containing Array refs.  
1.185     www      13947: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  13948: 
                   13949: =item %Values: hash indicating or overriding any default values which are 
                   13950: passed to graph.png.  
                   13951: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   13952: 
                   13953: =back
                   13954: 
                   13955: Returns:
                   13956: 
                   13957: An <img> tag which references graph.png and the appropriate identifying
                   13958: information for the plot.
                   13959: 
1.137     matthew  13960: =cut
                   13961: 
                   13962: ############################################################
                   13963: ############################################################
                   13964: sub DrawXYGraph {
                   13965:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   13966:     #
                   13967:     # Create the identifier for the graph
                   13968:     my $identifier = &get_cgi_id();
                   13969:     my $id = 'cgi.'.$identifier;
                   13970:     #
                   13971:     $Title  = '' if (! defined($Title));
                   13972:     $xlabel = '' if (! defined($xlabel));
                   13973:     $ylabel = '' if (! defined($ylabel));
                   13974:     my %ValuesHash = 
                   13975:         (
1.369     www      13976:          $id.'.title'  => &escape($Title),
                   13977:          $id.'.xlabel' => &escape($xlabel),
                   13978:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  13979:          $id.'.y_max_value'=> $Max,
                   13980:          $id.'.labels'     => join(',',@$Xlabels),
                   13981:          $id.'.PlotType'   => 'XY',
                   13982:          );
                   13983:     #
                   13984:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   13985:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   13986:     }
                   13987:     #
                   13988:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   13989:         return '';
                   13990:     }
                   13991:     my $NumSets=1;
1.138     matthew  13992:     foreach my $array (@{$Ydata}){
1.137     matthew  13993:         next if (! ref($array));
                   13994:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   13995:     }
1.138     matthew  13996:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  13997:     #
                   13998:     # Deal with other parameters
                   13999:     while (my ($key,$value) = each(%Values)) {
                   14000:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  14001:     }
                   14002:     #
1.646     raeburn  14003:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  14004:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14005: }
                   14006: 
                   14007: ############################################################
                   14008: ############################################################
                   14009: 
                   14010: =pod
                   14011: 
1.648     raeburn  14012: =item * &DrawXYYGraph()
1.138     matthew  14013: 
                   14014: Facilitates the plotting of data in an XY graph with two Y axes.
                   14015: Puts plot definition data into the users environment in order for 
                   14016: graph.png to plot it.  Returns an <img> tag for the plot.
                   14017: 
                   14018: Inputs:
                   14019: 
                   14020: =over 4
                   14021: 
                   14022: =item $Title: string, the title of the plot
                   14023: 
                   14024: =item $xlabel: string, text describing the X-axis of the plot
                   14025: 
                   14026: =item $ylabel: string, text describing the Y-axis of the plot
                   14027: 
                   14028: =item $colors: Array ref containing the hex color codes for the data to be 
                   14029: plotted in.  If undefined, default values will be used.
                   14030: 
                   14031: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14032: 
                   14033: =item $Ydata1: The first data set
                   14034: 
                   14035: =item $Min1: The minimum value of the left Y-axis
                   14036: 
                   14037: =item $Max1: The maximum value of the left Y-axis
                   14038: 
                   14039: =item $Ydata2: The second data set
                   14040: 
                   14041: =item $Min2: The minimum value of the right Y-axis
                   14042: 
                   14043: =item $Max2: The maximum value of the left Y-axis
                   14044: 
                   14045: =item %Values: hash indicating or overriding any default values which are 
                   14046: passed to graph.png.  
                   14047: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14048: 
                   14049: =back
                   14050: 
                   14051: Returns:
                   14052: 
                   14053: An <img> tag which references graph.png and the appropriate identifying
                   14054: information for the plot.
1.136     matthew  14055: 
                   14056: =cut
                   14057: 
                   14058: ############################################################
                   14059: ############################################################
1.137     matthew  14060: sub DrawXYYGraph {
                   14061:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   14062:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  14063:     #
                   14064:     # Create the identifier for the graph
                   14065:     my $identifier = &get_cgi_id();
                   14066:     my $id = 'cgi.'.$identifier;
                   14067:     #
                   14068:     $Title  = '' if (! defined($Title));
                   14069:     $xlabel = '' if (! defined($xlabel));
                   14070:     $ylabel = '' if (! defined($ylabel));
                   14071:     my %ValuesHash = 
                   14072:         (
1.369     www      14073:          $id.'.title'  => &escape($Title),
                   14074:          $id.'.xlabel' => &escape($xlabel),
                   14075:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  14076:          $id.'.labels' => join(',',@$Xlabels),
                   14077:          $id.'.PlotType' => 'XY',
                   14078:          $id.'.NumSets' => 2,
1.137     matthew  14079:          $id.'.two_axes' => 1,
                   14080:          $id.'.y1_max_value' => $Max1,
                   14081:          $id.'.y1_min_value' => $Min1,
                   14082:          $id.'.y2_max_value' => $Max2,
                   14083:          $id.'.y2_min_value' => $Min2,
1.136     matthew  14084:          );
                   14085:     #
1.137     matthew  14086:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14087:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14088:     }
                   14089:     #
                   14090:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   14091:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  14092:         return '';
                   14093:     }
                   14094:     my $NumSets=1;
1.137     matthew  14095:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  14096:         next if (! ref($array));
                   14097:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  14098:     }
                   14099:     #
                   14100:     # Deal with other parameters
                   14101:     while (my ($key,$value) = each(%Values)) {
                   14102:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  14103:     }
                   14104:     #
1.646     raeburn  14105:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 14106:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  14107: }
                   14108: 
                   14109: ############################################################
                   14110: ############################################################
                   14111: 
                   14112: =pod
                   14113: 
1.157     matthew  14114: =back 
                   14115: 
1.139     matthew  14116: =head1 Statistics helper routines?  
                   14117: 
                   14118: Bad place for them but what the hell.
                   14119: 
1.157     matthew  14120: =over 4
                   14121: 
1.648     raeburn  14122: =item * &chartlink()
1.139     matthew  14123: 
                   14124: Returns a link to the chart for a specific student.  
                   14125: 
                   14126: Inputs:
                   14127: 
                   14128: =over 4
                   14129: 
                   14130: =item $linktext: The text of the link
                   14131: 
                   14132: =item $sname: The students username
                   14133: 
                   14134: =item $sdomain: The students domain
                   14135: 
                   14136: =back
                   14137: 
1.157     matthew  14138: =back
                   14139: 
1.139     matthew  14140: =cut
                   14141: 
                   14142: ############################################################
                   14143: ############################################################
                   14144: sub chartlink {
                   14145:     my ($linktext, $sname, $sdomain) = @_;
                   14146:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      14147:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 14148:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  14149:        '">'.$linktext.'</a>';
1.153     matthew  14150: }
                   14151: 
                   14152: #######################################################
                   14153: #######################################################
                   14154: 
                   14155: =pod
                   14156: 
                   14157: =head1 Course Environment Routines
1.157     matthew  14158: 
                   14159: =over 4
1.153     matthew  14160: 
1.648     raeburn  14161: =item * &restore_course_settings()
1.153     matthew  14162: 
1.648     raeburn  14163: =item * &store_course_settings()
1.153     matthew  14164: 
                   14165: Restores/Store indicated form parameters from the course environment.
                   14166: Will not overwrite existing values of the form parameters.
                   14167: 
                   14168: Inputs: 
                   14169: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   14170: 
                   14171: a hash ref describing the data to be stored.  For example:
                   14172:    
                   14173: %Save_Parameters = ('Status' => 'scalar',
                   14174:     'chartoutputmode' => 'scalar',
                   14175:     'chartoutputdata' => 'scalar',
                   14176:     'Section' => 'array',
1.373     raeburn  14177:     'Group' => 'array',
1.153     matthew  14178:     'StudentData' => 'array',
                   14179:     'Maps' => 'array');
                   14180: 
                   14181: Returns: both routines return nothing
                   14182: 
1.631     raeburn  14183: =back
                   14184: 
1.153     matthew  14185: =cut
                   14186: 
                   14187: #######################################################
                   14188: #######################################################
                   14189: sub store_course_settings {
1.496     albertel 14190:     return &store_settings($env{'request.course.id'},@_);
                   14191: }
                   14192: 
                   14193: sub store_settings {
1.153     matthew  14194:     # save to the environment
                   14195:     # appenv the same items, just to be safe
1.300     albertel 14196:     my $udom  = $env{'user.domain'};
                   14197:     my $uname = $env{'user.name'};
1.496     albertel 14198:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14199:     my %SaveHash;
                   14200:     my %AppHash;
                   14201:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 14202:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 14203:         my $envname = 'environment.'.$basename;
1.258     albertel 14204:         if (exists($env{'form.'.$setting})) {
1.153     matthew  14205:             # Save this value away
                   14206:             if ($type eq 'scalar' &&
1.258     albertel 14207:                 (! exists($env{$envname}) || 
                   14208:                  $env{$envname} ne $env{'form.'.$setting})) {
                   14209:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   14210:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  14211:             } elsif ($type eq 'array') {
                   14212:                 my $stored_form;
1.258     albertel 14213:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  14214:                     $stored_form = join(',',
                   14215:                                         map {
1.369     www      14216:                                             &escape($_);
1.258     albertel 14217:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  14218:                 } else {
                   14219:                     $stored_form = 
1.369     www      14220:                         &escape($env{'form.'.$setting});
1.153     matthew  14221:                 }
                   14222:                 # Determine if the array contents are the same.
1.258     albertel 14223:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  14224:                     $SaveHash{$basename} = $stored_form;
                   14225:                     $AppHash{$envname}   = $stored_form;
                   14226:                 }
                   14227:             }
                   14228:         }
                   14229:     }
                   14230:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 14231:                                           $udom,$uname);
1.153     matthew  14232:     if ($put_result !~ /^(ok|delayed)/) {
                   14233:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   14234:                                  'got error:'.$put_result);
                   14235:     }
                   14236:     # Make sure these settings stick around in this session, too
1.646     raeburn  14237:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  14238:     return;
                   14239: }
                   14240: 
                   14241: sub restore_course_settings {
1.499     albertel 14242:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 14243: }
                   14244: 
                   14245: sub restore_settings {
                   14246:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14247:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 14248:         next if (exists($env{'form.'.$setting}));
1.496     albertel 14249:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  14250:             '.'.$setting;
1.258     albertel 14251:         if (exists($env{$envname})) {
1.153     matthew  14252:             if ($type eq 'scalar') {
1.258     albertel 14253:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  14254:             } elsif ($type eq 'array') {
1.258     albertel 14255:                 $env{'form.'.$setting} = [ 
1.153     matthew  14256:                                            map { 
1.369     www      14257:                                                &unescape($_); 
1.258     albertel 14258:                                            } split(',',$env{$envname})
1.153     matthew  14259:                                            ];
                   14260:             }
                   14261:         }
                   14262:     }
1.127     matthew  14263: }
                   14264: 
1.618     raeburn  14265: #######################################################
                   14266: #######################################################
                   14267: 
                   14268: =pod
                   14269: 
                   14270: =head1 Domain E-mail Routines  
                   14271: 
                   14272: =over 4
                   14273: 
1.648     raeburn  14274: =item * &build_recipient_list()
1.618     raeburn  14275: 
1.1075.2.44  raeburn  14276: Build recipient lists for following types of e-mail:
1.766     raeburn  14277: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1075.2.44  raeburn  14278: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   14279: module change checking, student/employee ID conflict checks, as
                   14280: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   14281: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  14282: 
                   14283: Inputs:
1.1075.2.44  raeburn  14284: defmail (scalar - email address of default recipient),
                   14285: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   14286: requestsmail, updatesmail, or idconflictsmail).
                   14287: 
1.619     raeburn  14288: defdom (domain for which to retrieve configuration settings),
1.1075.2.44  raeburn  14289: 
                   14290: origmail (scalar - email address of recipient from loncapa.conf,
                   14291: i.e., predates configuration by DC via domainprefs.pm
1.618     raeburn  14292: 
1.1075.2.139  raeburn  14293: $requname username of requester (if mailing type is helpdeskmail)
                   14294: 
                   14295: $requdom domain of requester (if mailing type is helpdeskmail)
                   14296: 
                   14297: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
                   14298: 
1.655     raeburn  14299: Returns: comma separated list of addresses to which to send e-mail.
                   14300: 
                   14301: =back
1.618     raeburn  14302: 
                   14303: =cut
                   14304: 
                   14305: ############################################################
                   14306: ############################################################
                   14307: sub build_recipient_list {
1.1075.2.139  raeburn  14308:     my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618     raeburn  14309:     my @recipients;
1.1075.2.122  raeburn  14310:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  14311:     my %domconfig =
1.1075.2.122  raeburn  14312:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  14313:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  14314:         if (exists($domconfig{'contacts'}{$mailing})) {
                   14315:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   14316:                 my @contacts = ('adminemail','supportemail');
                   14317:                 foreach my $item (@contacts) {
                   14318:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   14319:                         my $addr = $domconfig{'contacts'}{$item}; 
                   14320:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14321:                             push(@recipients,$addr);
                   14322:                         }
1.619     raeburn  14323:                     }
1.1075.2.122  raeburn  14324:                 }
                   14325:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   14326:                 if ($mailing eq 'helpdeskmail') {
                   14327:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   14328:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   14329:                         my @ok_bccs;
                   14330:                         foreach my $bcc (@bccs) {
                   14331:                             $bcc =~ s/^\s+//g;
                   14332:                             $bcc =~ s/\s+$//g;
                   14333:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14334:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14335:                                     push(@ok_bccs,$bcc);
                   14336:                                 }
                   14337:                             }
                   14338:                         }
                   14339:                         if (@ok_bccs > 0) {
                   14340:                             $allbcc = join(', ',@ok_bccs);
                   14341:                         }
                   14342:                     }
                   14343:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  14344:                 }
                   14345:             }
1.766     raeburn  14346:         } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14347:             $lastresort = $origmail;
1.618     raeburn  14348:         }
1.1075.2.139  raeburn  14349:         if ($mailing eq 'helpdeskmail') {
                   14350:             if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
                   14351:                 (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
                   14352:                 my ($inststatus,$inststatus_checked);
                   14353:                 if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
                   14354:                     ($env{'user.domain'} ne 'public')) {
                   14355:                     $inststatus_checked = 1;
                   14356:                     $inststatus = $env{'environment.inststatus'};
                   14357:                 }
                   14358:                 unless ($inststatus_checked) {
                   14359:                     if (($requname ne '') && ($requdom ne '')) {
                   14360:                         if (($requname =~ /^$match_username$/) &&
                   14361:                             ($requdom =~ /^$match_domain$/) &&
                   14362:                             (&Apache::lonnet::domain($requdom))) {
                   14363:                             my $requhome = &Apache::lonnet::homeserver($requname,
                   14364:                                                                       $requdom);
                   14365:                             unless ($requhome eq 'no_host') {
                   14366:                                 my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
                   14367:                                 $inststatus = $userenv{'inststatus'};
                   14368:                                 $inststatus_checked = 1;
                   14369:                             }
                   14370:                         }
                   14371:                     }
                   14372:                 }
                   14373:                 unless ($inststatus_checked) {
                   14374:                     if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
                   14375:                         my %srch = (srchby     => 'email',
                   14376:                                     srchdomain => $defdom,
                   14377:                                     srchterm   => $reqemail,
                   14378:                                     srchtype   => 'exact');
                   14379:                         my %srch_results = &Apache::lonnet::usersearch(\%srch);
                   14380:                         foreach my $uname (keys(%srch_results)) {
                   14381:                             if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14382:                                 $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14383:                                 $inststatus_checked = 1;
                   14384:                                 last;
                   14385:                             }
                   14386:                         }
                   14387:                         unless ($inststatus_checked) {
                   14388:                             my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
                   14389:                             if ($dirsrchres eq 'ok') {
                   14390:                                 foreach my $uname (keys(%srch_results)) {
                   14391:                                     if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14392:                                         $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14393:                                         $inststatus_checked = 1;
                   14394:                                         last;
                   14395:                                     }
                   14396:                                 }
                   14397:                             }
                   14398:                         }
                   14399:                     }
                   14400:                 }
                   14401:                 if ($inststatus ne '') {
                   14402:                     foreach my $status (split(/\:/,$inststatus)) {
                   14403:                         if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
                   14404:                             my @contacts = ('adminemail','supportemail');
                   14405:                             foreach my $item (@contacts) {
                   14406:                                 if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
                   14407:                                     my $addr = $domconfig{'contacts'}{'overrides'}{$status};
                   14408:                                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14409:                                         push(@recipients,$addr);
                   14410:                                     }
                   14411:                                 }
                   14412:                             }
                   14413:                             $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
                   14414:                             if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
                   14415:                                 my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
                   14416:                                 my @ok_bccs;
                   14417:                                 foreach my $bcc (@bccs) {
                   14418:                                     $bcc =~ s/^\s+//g;
                   14419:                                     $bcc =~ s/\s+$//g;
                   14420:                                     if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14421:                                         if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14422:                                             push(@ok_bccs,$bcc);
                   14423:                                         }
                   14424:                                     }
                   14425:                                 }
                   14426:                                 if (@ok_bccs > 0) {
                   14427:                                     $allbcc = join(', ',@ok_bccs);
                   14428:                                 }
                   14429:                             }
                   14430:                             $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
                   14431:                             last;
                   14432:                         }
                   14433:                     }
                   14434:                 }
                   14435:             }
                   14436:         }
1.619     raeburn  14437:     } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14438:         $lastresort = $origmail;
                   14439:     }
1.1075.2.128  raeburn  14440:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1075.2.122  raeburn  14441:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   14442:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   14443:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   14444:             my %what = (
                   14445:                           perlvar => 1,
                   14446:                        );
                   14447:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   14448:             if ($primary) {
                   14449:                 my $gotaddr;
                   14450:                 my ($result,$returnhash) =
                   14451:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   14452:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   14453:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   14454:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   14455:                         $gotaddr = 1;
                   14456:                     }
                   14457:                 }
                   14458:                 unless ($gotaddr) {
                   14459:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   14460:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   14461:                     unless ($uintdom eq $intdom) {
                   14462:                         my %domconfig =
                   14463:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   14464:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   14465:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   14466:                                 my @contacts = ('adminemail','supportemail');
                   14467:                                 foreach my $item (@contacts) {
                   14468:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   14469:                                         my $addr = $domconfig{'contacts'}{$item};
                   14470:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14471:                                             push(@recipients,$addr);
                   14472:                                         }
                   14473:                                     }
                   14474:                                 }
                   14475:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   14476:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   14477:                                 }
                   14478:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   14479:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   14480:                                     my @ok_bccs;
                   14481:                                     foreach my $bcc (@bccs) {
                   14482:                                         $bcc =~ s/^\s+//g;
                   14483:                                         $bcc =~ s/\s+$//g;
                   14484:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14485:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14486:                                                 push(@ok_bccs,$bcc);
                   14487:                                             }
                   14488:                                         }
                   14489:                                     }
                   14490:                                     if (@ok_bccs > 0) {
                   14491:                                         $allbcc = join(', ',@ok_bccs);
                   14492:                                     }
                   14493:                                 }
                   14494:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   14495:                             }
                   14496:                         }
                   14497:                     }
                   14498:                 }
                   14499:             }
                   14500:         }
1.618     raeburn  14501:     }
1.688     raeburn  14502:     if (defined($defmail)) {
                   14503:         if ($defmail ne '') {
                   14504:             push(@recipients,$defmail);
                   14505:         }
1.618     raeburn  14506:     }
                   14507:     if ($otheremails) {
1.619     raeburn  14508:         my @others;
                   14509:         if ($otheremails =~ /,/) {
                   14510:             @others = split(/,/,$otheremails);
1.618     raeburn  14511:         } else {
1.619     raeburn  14512:             push(@others,$otheremails);
                   14513:         }
                   14514:         foreach my $addr (@others) {
                   14515:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14516:                 push(@recipients,$addr);
                   14517:             }
1.618     raeburn  14518:         }
                   14519:     }
1.1075.2.128  raeburn  14520:     if ($mailing eq 'helpdeskmail') {
1.1075.2.122  raeburn  14521:         if ((!@recipients) && ($lastresort ne '')) {
                   14522:             push(@recipients,$lastresort);
                   14523:         }
                   14524:     } elsif ($lastresort ne '') {
                   14525:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   14526:             push(@recipients,$lastresort);
                   14527:         }
                   14528:     }
                   14529:     my $recipientlist = join(',',@recipients);
                   14530:     if (wantarray) {
                   14531:         return ($recipientlist,$allbcc,$addtext);
                   14532:     } else {
                   14533:         return $recipientlist;
                   14534:     }
1.618     raeburn  14535: }
                   14536: 
1.127     matthew  14537: ############################################################
                   14538: ############################################################
1.154     albertel 14539: 
1.655     raeburn  14540: =pod
                   14541: 
                   14542: =head1 Course Catalog Routines
                   14543: 
                   14544: =over 4
                   14545: 
                   14546: =item * &gather_categories()
                   14547: 
                   14548: Converts category definitions - keys of categories hash stored in  
                   14549: coursecategories in configuration.db on the primary library server in a 
                   14550: domain - to an array.  Also generates javascript and idx hash used to 
                   14551: generate Domain Coordinator interface for editing Course Categories.
                   14552: 
                   14553: Inputs:
1.663     raeburn  14554: 
1.655     raeburn  14555: categories (reference to hash of category definitions).
1.663     raeburn  14556: 
1.655     raeburn  14557: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14558:       categories and subcategories).
1.663     raeburn  14559: 
1.655     raeburn  14560: idx (reference to hash of counters used in Domain Coordinator interface for 
                   14561:       editing Course Categories).
1.663     raeburn  14562: 
1.655     raeburn  14563: jsarray (reference to array of categories used to create Javascript arrays for
                   14564:          Domain Coordinator interface for editing Course Categories).
                   14565: 
                   14566: Returns: nothing
                   14567: 
                   14568: Side effects: populates cats, idx and jsarray. 
                   14569: 
                   14570: =cut
                   14571: 
                   14572: sub gather_categories {
                   14573:     my ($categories,$cats,$idx,$jsarray) = @_;
                   14574:     my %counters;
                   14575:     my $num = 0;
                   14576:     foreach my $item (keys(%{$categories})) {
                   14577:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   14578:         if ($container eq '' && $depth == 0) {
                   14579:             $cats->[$depth][$categories->{$item}] = $cat;
                   14580:         } else {
                   14581:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   14582:         }
                   14583:         my ($escitem,$tail) = split(/:/,$item,2);
                   14584:         if ($counters{$tail} eq '') {
                   14585:             $counters{$tail} = $num;
                   14586:             $num ++;
                   14587:         }
                   14588:         if (ref($idx) eq 'HASH') {
                   14589:             $idx->{$item} = $counters{$tail};
                   14590:         }
                   14591:         if (ref($jsarray) eq 'ARRAY') {
                   14592:             push(@{$jsarray->[$counters{$tail}]},$item);
                   14593:         }
                   14594:     }
                   14595:     return;
                   14596: }
                   14597: 
                   14598: =pod
                   14599: 
                   14600: =item * &extract_categories()
                   14601: 
                   14602: Used to generate breadcrumb trails for course categories.
                   14603: 
                   14604: Inputs:
1.663     raeburn  14605: 
1.655     raeburn  14606: categories (reference to hash of category definitions).
1.663     raeburn  14607: 
1.655     raeburn  14608: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14609:       categories and subcategories).
1.663     raeburn  14610: 
1.655     raeburn  14611: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  14612: 
1.655     raeburn  14613: allitems (reference to hash - key is category key 
                   14614:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14615: 
1.655     raeburn  14616: idx (reference to hash of counters used in Domain Coordinator interface for
                   14617:       editing Course Categories).
1.663     raeburn  14618: 
1.655     raeburn  14619: jsarray (reference to array of categories used to create Javascript arrays for
                   14620:          Domain Coordinator interface for editing Course Categories).
                   14621: 
1.665     raeburn  14622: subcats (reference to hash of arrays containing all subcategories within each 
                   14623:          category, -recursive)
                   14624: 
1.1075.2.132  raeburn  14625: maxd (reference to hash used to hold max depth for all top-level categories).
                   14626: 
1.655     raeburn  14627: Returns: nothing
                   14628: 
                   14629: Side effects: populates trails and allitems hash references.
                   14630: 
                   14631: =cut
                   14632: 
                   14633: sub extract_categories {
1.1075.2.132  raeburn  14634:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655     raeburn  14635:     if (ref($categories) eq 'HASH') {
                   14636:         &gather_categories($categories,$cats,$idx,$jsarray);
                   14637:         if (ref($cats->[0]) eq 'ARRAY') {
                   14638:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   14639:                 my $name = $cats->[0][$i];
                   14640:                 my $item = &escape($name).'::0';
                   14641:                 my $trailstr;
                   14642:                 if ($name eq 'instcode') {
                   14643:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  14644:                 } elsif ($name eq 'communities') {
                   14645:                     $trailstr = &mt('Communities');
1.655     raeburn  14646:                 } else {
                   14647:                     $trailstr = $name;
                   14648:                 }
                   14649:                 if ($allitems->{$item} eq '') {
                   14650:                     push(@{$trails},$trailstr);
                   14651:                     $allitems->{$item} = scalar(@{$trails})-1;
                   14652:                 }
                   14653:                 my @parents = ($name);
                   14654:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   14655:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   14656:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  14657:                         if (ref($subcats) eq 'HASH') {
                   14658:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   14659:                         }
1.1075.2.132  raeburn  14660:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665     raeburn  14661:                     }
                   14662:                 } else {
                   14663:                     if (ref($subcats) eq 'HASH') {
                   14664:                         $subcats->{$item} = [];
1.655     raeburn  14665:                     }
1.1075.2.132  raeburn  14666:                     if (ref($maxd) eq 'HASH') {
                   14667:                         $maxd->{$name} = 1;
                   14668:                     }
1.655     raeburn  14669:                 }
                   14670:             }
                   14671:         }
                   14672:     }
                   14673:     return;
                   14674: }
                   14675: 
                   14676: =pod
                   14677: 
1.1075.2.56  raeburn  14678: =item * &recurse_categories()
1.655     raeburn  14679: 
                   14680: Recursively used to generate breadcrumb trails for course categories.
                   14681: 
                   14682: Inputs:
1.663     raeburn  14683: 
1.655     raeburn  14684: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14685:       categories and subcategories).
1.663     raeburn  14686: 
1.655     raeburn  14687: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  14688: 
                   14689: category (current course category, for which breadcrumb trail is being generated).
                   14690: 
                   14691: trails (reference to array of breadcrumb trails for each category).
                   14692: 
1.655     raeburn  14693: allitems (reference to hash - key is category key
                   14694:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14695: 
1.655     raeburn  14696: parents (array containing containers directories for current category, 
                   14697:          back to top level). 
                   14698: 
                   14699: Returns: nothing
                   14700: 
                   14701: Side effects: populates trails and allitems hash references
                   14702: 
                   14703: =cut
                   14704: 
                   14705: sub recurse_categories {
1.1075.2.132  raeburn  14706:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655     raeburn  14707:     my $shallower = $depth - 1;
                   14708:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   14709:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   14710:             my $name = $cats->[$depth]{$category}[$k];
                   14711:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   14712:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   14713:             if ($allitems->{$item} eq '') {
                   14714:                 push(@{$trails},$trailstr);
                   14715:                 $allitems->{$item} = scalar(@{$trails})-1;
                   14716:             }
                   14717:             my $deeper = $depth+1;
                   14718:             push(@{$parents},$category);
1.665     raeburn  14719:             if (ref($subcats) eq 'HASH') {
                   14720:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   14721:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   14722:                     my $higher;
                   14723:                     if ($j > 0) {
                   14724:                         $higher = &escape($parents->[$j]).':'.
                   14725:                                   &escape($parents->[$j-1]).':'.$j;
                   14726:                     } else {
                   14727:                         $higher = &escape($parents->[$j]).'::'.$j;
                   14728:                     }
                   14729:                     push(@{$subcats->{$higher}},$subcat);
                   14730:                 }
                   14731:             }
                   14732:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1075.2.132  raeburn  14733:                                 $subcats,$maxd);
1.655     raeburn  14734:             pop(@{$parents});
                   14735:         }
                   14736:     } else {
                   14737:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.132  raeburn  14738:         my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  14739:         if ($allitems->{$item} eq '') {
                   14740:             push(@{$trails},$trailstr);
                   14741:             $allitems->{$item} = scalar(@{$trails})-1;
                   14742:         }
1.1075.2.132  raeburn  14743:         if (ref($maxd) eq 'HASH') {
                   14744:             if ($depth > $maxd->{$parents->[0]}) {
                   14745:                 $maxd->{$parents->[0]} = $depth;
                   14746:             }
                   14747:         }
1.655     raeburn  14748:     }
                   14749:     return;
                   14750: }
                   14751: 
1.663     raeburn  14752: =pod
                   14753: 
1.1075.2.56  raeburn  14754: =item * &assign_categories_table()
1.663     raeburn  14755: 
                   14756: Create a datatable for display of hierarchical categories in a domain,
                   14757: with checkboxes to allow a course to be categorized. 
                   14758: 
                   14759: Inputs:
                   14760: 
                   14761: cathash - reference to hash of categories defined for the domain (from
                   14762:           configuration.db)
                   14763: 
                   14764: currcat - scalar with an & separated list of categories assigned to a course. 
                   14765: 
1.919     raeburn  14766: type    - scalar contains course type (Course or Community).
                   14767: 
1.1075.2.117  raeburn  14768: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   14769:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   14770: 
1.663     raeburn  14771: Returns: $output (markup to be displayed) 
                   14772: 
                   14773: =cut
                   14774: 
                   14775: sub assign_categories_table {
1.1075.2.117  raeburn  14776:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  14777:     my $output;
                   14778:     if (ref($cathash) eq 'HASH') {
1.1075.2.132  raeburn  14779:         my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
                   14780:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663     raeburn  14781:         $maxdepth = scalar(@cats);
                   14782:         if (@cats > 0) {
                   14783:             my $itemcount = 0;
                   14784:             if (ref($cats[0]) eq 'ARRAY') {
                   14785:                 my @currcategories;
                   14786:                 if ($currcat ne '') {
                   14787:                     @currcategories = split('&',$currcat);
                   14788:                 }
1.919     raeburn  14789:                 my $table;
1.663     raeburn  14790:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   14791:                     my $parent = $cats[0][$i];
1.919     raeburn  14792:                     next if ($parent eq 'instcode');
                   14793:                     if ($type eq 'Community') {
                   14794:                         next unless ($parent eq 'communities');
                   14795:                     } else {
                   14796:                         next if ($parent eq 'communities');
                   14797:                     }
1.663     raeburn  14798:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   14799:                     my $item = &escape($parent).'::0';
                   14800:                     my $checked = '';
                   14801:                     if (@currcategories > 0) {
                   14802:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   14803:                             $checked = ' checked="checked"';
1.663     raeburn  14804:                         }
                   14805:                     }
1.919     raeburn  14806:                     my $parent_title = $parent;
                   14807:                     if ($parent eq 'communities') {
                   14808:                         $parent_title = &mt('Communities');
                   14809:                     }
                   14810:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   14811:                               '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  14812:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  14813:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  14814:                     my $depth = 1;
                   14815:                     push(@path,$parent);
1.1075.2.117  raeburn  14816:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  14817:                     pop(@path);
1.919     raeburn  14818:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  14819:                     $itemcount ++;
                   14820:                 }
1.919     raeburn  14821:                 if ($itemcount) {
                   14822:                     $output = &Apache::loncommon::start_data_table().
                   14823:                               $table.
                   14824:                               &Apache::loncommon::end_data_table();
                   14825:                 }
1.663     raeburn  14826:             }
                   14827:         }
                   14828:     }
                   14829:     return $output;
                   14830: }
                   14831: 
                   14832: =pod
                   14833: 
1.1075.2.56  raeburn  14834: =item * &assign_category_rows()
1.663     raeburn  14835: 
                   14836: Create a datatable row for display of nested categories in a domain,
                   14837: with checkboxes to allow a course to be categorized,called recursively.
                   14838: 
                   14839: Inputs:
                   14840: 
                   14841: itemcount - track row number for alternating colors
                   14842: 
                   14843: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   14844:       categories and subcategories.
                   14845: 
                   14846: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   14847: 
                   14848: parent - parent of current category item
                   14849: 
                   14850: path - Array containing all categories back up through the hierarchy from the
                   14851:        current category to the top level.
                   14852: 
                   14853: currcategories - reference to array of current categories assigned to the course
                   14854: 
1.1075.2.117  raeburn  14855: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   14856:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   14857: 
1.663     raeburn  14858: Returns: $output (markup to be displayed).
                   14859: 
                   14860: =cut
                   14861: 
                   14862: sub assign_category_rows {
1.1075.2.117  raeburn  14863:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  14864:     my ($text,$name,$item,$chgstr);
                   14865:     if (ref($cats) eq 'ARRAY') {
                   14866:         my $maxdepth = scalar(@{$cats});
                   14867:         if (ref($cats->[$depth]) eq 'HASH') {
                   14868:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   14869:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   14870:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1075.2.45  raeburn  14871:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  14872:                 for (my $j=0; $j<$numchildren; $j++) {
                   14873:                     $name = $cats->[$depth]{$parent}[$j];
                   14874:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   14875:                     my $deeper = $depth+1;
                   14876:                     my $checked = '';
                   14877:                     if (ref($currcategories) eq 'ARRAY') {
                   14878:                         if (@{$currcategories} > 0) {
                   14879:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   14880:                                 $checked = ' checked="checked"';
1.663     raeburn  14881:                             }
                   14882:                         }
                   14883:                     }
1.664     raeburn  14884:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   14885:                              '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  14886:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  14887:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   14888:                              '</td><td>';
1.663     raeburn  14889:                     if (ref($path) eq 'ARRAY') {
                   14890:                         push(@{$path},$name);
1.1075.2.117  raeburn  14891:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  14892:                         pop(@{$path});
                   14893:                     }
                   14894:                     $text .= '</td></tr>';
                   14895:                 }
                   14896:                 $text .= '</table></td>';
                   14897:             }
                   14898:         }
                   14899:     }
                   14900:     return $text;
                   14901: }
                   14902: 
1.1075.2.69  raeburn  14903: =pod
                   14904: 
                   14905: =back
                   14906: 
                   14907: =cut
                   14908: 
1.655     raeburn  14909: ############################################################
                   14910: ############################################################
                   14911: 
                   14912: 
1.443     albertel 14913: sub commit_customrole {
1.664     raeburn  14914:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  14915:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 14916:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   14917:                          ($end?', ending '.localtime($end):'').': <b>'.
                   14918:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  14919:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 14920:                  '</b><br />';
                   14921:     return $output;
                   14922: }
                   14923: 
                   14924: sub commit_standardrole {
1.1075.2.31  raeburn  14925:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541     raeburn  14926:     my ($output,$logmsg,$linefeed);
                   14927:     if ($context eq 'auto') {
                   14928:         $linefeed = "\n";
                   14929:     } else {
                   14930:         $linefeed = "<br />\n";
                   14931:     }  
1.443     albertel 14932:     if ($three eq 'st') {
1.541     raeburn  14933:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31  raeburn  14934:                                          $one,$two,$sec,$context,$credits);
1.541     raeburn  14935:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  14936:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   14937:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 14938:         } else {
1.541     raeburn  14939:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 14940:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  14941:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   14942:             if ($context eq 'auto') {
                   14943:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   14944:             } else {
                   14945:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   14946:                &mt('Add to classlist').': <b>ok</b>';
                   14947:             }
                   14948:             $output .= $linefeed;
1.443     albertel 14949:         }
                   14950:     } else {
                   14951:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   14952:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  14953:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  14954:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  14955:         if ($context eq 'auto') {
                   14956:             $output .= $result.$linefeed;
                   14957:         } else {
                   14958:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   14959:         }
1.443     albertel 14960:     }
                   14961:     return $output;
                   14962: }
                   14963: 
                   14964: sub commit_studentrole {
1.1075.2.31  raeburn  14965:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
                   14966:         $credits) = @_;
1.626     raeburn  14967:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  14968:     if ($context eq 'auto') {
                   14969:         $linefeed = "\n";
                   14970:     } else {
                   14971:         $linefeed = '<br />'."\n";
                   14972:     }
1.443     albertel 14973:     if (defined($one) && defined($two)) {
                   14974:         my $cid=$one.'_'.$two;
                   14975:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   14976:         my $secchange = 0;
                   14977:         my $expire_role_result;
                   14978:         my $modify_section_result;
1.628     raeburn  14979:         if ($oldsec ne '-1') { 
                   14980:             if ($oldsec ne $sec) {
1.443     albertel 14981:                 $secchange = 1;
1.628     raeburn  14982:                 my $now = time;
1.443     albertel 14983:                 my $uurl='/'.$cid;
                   14984:                 $uurl=~s/\_/\//g;
                   14985:                 if ($oldsec) {
                   14986:                     $uurl.='/'.$oldsec;
                   14987:                 }
1.626     raeburn  14988:                 $oldsecurl = $uurl;
1.628     raeburn  14989:                 $expire_role_result = 
1.652     raeburn  14990:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  14991:                 if ($env{'request.course.sec'} ne '') { 
                   14992:                     if ($expire_role_result eq 'refused') {
                   14993:                         my @roles = ('st');
                   14994:                         my @statuses = ('previous');
                   14995:                         my @roledoms = ($one);
                   14996:                         my $withsec = 1;
                   14997:                         my %roleshash = 
                   14998:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   14999:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   15000:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   15001:                             my ($oldstart,$oldend) = 
                   15002:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   15003:                             if ($oldend > 0 && $oldend <= $now) {
                   15004:                                 $expire_role_result = 'ok';
                   15005:                             }
                   15006:                         }
                   15007:                     }
                   15008:                 }
1.443     albertel 15009:                 $result = $expire_role_result;
                   15010:             }
                   15011:         }
                   15012:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31  raeburn  15013:             $modify_section_result = 
                   15014:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   15015:                                                            undef,undef,undef,$sec,
                   15016:                                                            $end,$start,'','',$cid,
                   15017:                                                            '',$context,$credits);
1.443     albertel 15018:             if ($modify_section_result =~ /^ok/) {
                   15019:                 if ($secchange == 1) {
1.628     raeburn  15020:                     if ($sec eq '') {
                   15021:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   15022:                     } else {
                   15023:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   15024:                     }
1.443     albertel 15025:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  15026:                     if ($sec eq '') {
                   15027:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   15028:                     } else {
                   15029:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15030:                     }
1.443     albertel 15031:                 } else {
1.628     raeburn  15032:                     if ($sec eq '') {
                   15033:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   15034:                     } else {
                   15035:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15036:                     }
1.443     albertel 15037:                 }
                   15038:             } else {
1.628     raeburn  15039:                 if ($secchange) {       
                   15040:                     $$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;
                   15041:                 } else {
                   15042:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   15043:                 }
1.443     albertel 15044:             }
                   15045:             $result = $modify_section_result;
                   15046:         } elsif ($secchange == 1) {
1.628     raeburn  15047:             if ($oldsec eq '') {
1.1075.2.20  raeburn  15048:                 $$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  15049:             } else {
                   15050:                 $$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;
                   15051:             }
1.626     raeburn  15052:             if ($expire_role_result eq 'refused') {
                   15053:                 my $newsecurl = '/'.$cid;
                   15054:                 $newsecurl =~ s/\_/\//g;
                   15055:                 if ($sec ne '') {
                   15056:                     $newsecurl.='/'.$sec;
                   15057:                 }
                   15058:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   15059:                     if ($sec eq '') {
                   15060:                         $$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;
                   15061:                     } else {
                   15062:                         $$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;
                   15063:                     }
                   15064:                 }
                   15065:             }
1.443     albertel 15066:         }
                   15067:     } else {
1.626     raeburn  15068:         $$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 15069:         $result = "error: incomplete course id\n";
                   15070:     }
                   15071:     return $result;
                   15072: }
                   15073: 
1.1075.2.25  raeburn  15074: sub show_role_extent {
                   15075:     my ($scope,$context,$role) = @_;
                   15076:     $scope =~ s{^/}{};
                   15077:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   15078:     push(@courseroles,'co');
                   15079:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   15080:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   15081:         $scope =~ s{/}{_};
                   15082:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   15083:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   15084:         my ($audom,$auname) = split(/\//,$scope);
                   15085:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   15086:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   15087:     } else {
                   15088:         $scope =~ s{/$}{};
                   15089:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   15090:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   15091:     }
                   15092: }
                   15093: 
1.443     albertel 15094: ############################################################
                   15095: ############################################################
                   15096: 
1.566     albertel 15097: sub check_clone {
1.578     raeburn  15098:     my ($args,$linefeed) = @_;
1.566     albertel 15099:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   15100:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   15101:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1075.2.141.  .5(raebu 15102:20):     my $clonetitle;
                   15103:20):     my @clonemsg;
1.566     albertel 15104:     my $can_clone = 0;
1.944     raeburn  15105:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  15106:     if ($lctype ne 'community') {
                   15107:         $lctype = 'course';
                   15108:     }
1.566     albertel 15109:     if ($clonehome eq 'no_host') {
1.944     raeburn  15110:         if ($args->{'crstype'} eq 'Community') {
1.1075.2.141.  .5(raebu 15111:20):             push(@clonemsg,({
                   15112:20):                               mt => 'No new community created.',
                   15113:20):                               args => [],
                   15114:20):                             },
                   15115:20):                             {
                   15116:20):                               mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
                   15117:20):                               args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
                   15118:20):                             }));
1.908     raeburn  15119:         } else {
1.1075.2.141.  .5(raebu 15120:20):             push(@clonemsg,({
                   15121:20):                               mt => 'No new course created.',
                   15122:20):                               args => [],
                   15123:20):                             },
                   15124:20):                             {
                   15125:20):                               mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
                   15126:20):                               args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   15127:20):                             }));
                   15128:20):         }
1.566     albertel 15129:     } else {
                   15130: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1075.2.141.  .5(raebu 15131:20):         $clonetitle = $clonedesc{'description'};
1.944     raeburn  15132:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15133:             if ($clonedesc{'type'} ne 'Community') {
1.1075.2.141.  .5(raebu 15134:20):                 push(@clonemsg,({
                   15135:20):                                   mt => 'No new community created.',
                   15136:20):                                   args => [],
                   15137:20):                                 },
                   15138:20):                                 {
                   15139:20):                                   mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
                   15140:20):                                   args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   15141:20):                                 }));
                   15142:20):                 return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908     raeburn  15143:             }
                   15144:         }
1.1075.2.119  raeburn  15145: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  15146:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 15147: 	    $can_clone = 1;
                   15148: 	} else {
1.1075.2.95  raeburn  15149: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 15150: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1075.2.95  raeburn  15151:             if ($clonehash{'cloners'} eq '') {
                   15152:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   15153:                 if ($domdefs{'canclone'}) {
                   15154:                     unless ($domdefs{'canclone'} eq 'none') {
                   15155:                         if ($domdefs{'canclone'} eq 'domain') {
                   15156:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   15157:                                 $can_clone = 1;
                   15158:                             }
                   15159:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15160:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   15161:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   15162:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   15163:                                 $can_clone = 1;
                   15164:                             }
                   15165:                         }
                   15166:                     }
1.908     raeburn  15167:                 }
1.1075.2.95  raeburn  15168:             } else {
                   15169: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   15170:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  15171:                     $can_clone = 1;
1.1075.2.95  raeburn  15172:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  15173:                     $can_clone = 1;
1.1075.2.96  raeburn  15174:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   15175:                     $can_clone = 1;
1.1075.2.95  raeburn  15176:                 }
                   15177:                 unless ($can_clone) {
1.1075.2.96  raeburn  15178:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15179:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1075.2.95  raeburn  15180:                         my (%gotdomdefaults,%gotcodedefaults);
                   15181:                         foreach my $cloner (@cloners) {
                   15182:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   15183:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   15184:                                 my (%codedefaults,@code_order);
                   15185:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   15186:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   15187:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   15188:                                     }
                   15189:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   15190:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   15191:                                     }
                   15192:                                 } else {
                   15193:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   15194:                                                                             \%codedefaults,
                   15195:                                                                             \@code_order);
                   15196:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   15197:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   15198:                                 }
                   15199:                                 if (@code_order > 0) {
                   15200:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   15201:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   15202:                                                                                 $args->{'crscode'})) {
                   15203:                                         $can_clone = 1;
                   15204:                                         last;
                   15205:                                     }
                   15206:                                 }
                   15207:                             }
                   15208:                         }
                   15209:                     }
1.1075.2.96  raeburn  15210:                 }
                   15211:             }
                   15212:             unless ($can_clone) {
                   15213:                 my $ccrole = 'cc';
                   15214:                 if ($args->{'crstype'} eq 'Community') {
                   15215:                     $ccrole = 'co';
                   15216:                 }
                   15217:                 my %roleshash =
                   15218:                     &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   15219:                                                   $args->{'ccdomain'},
                   15220:                                                   'userroles',['active'],[$ccrole],
                   15221:                                                   [$args->{'clonedomain'}]);
                   15222:                 if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   15223:                     $can_clone = 1;
                   15224:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   15225:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   15226:                     $can_clone = 1;
1.1075.2.95  raeburn  15227:                 }
                   15228:             }
                   15229:             unless ($can_clone) {
                   15230:                 if ($args->{'crstype'} eq 'Community') {
1.1075.2.141.  .5(raebu 15231:20):                     push(@clonemsg,({
                   15232:20):                                       mt => 'No new community created.',
                   15233:20):                                       args => [],
                   15234:20):                                     },
                   15235:20):                                     {
                   15236:20):                                       mt => 'The new community could not be cloned from the existing community because the new community owner ([_1]) does not have cloning rights in the existing community ([_2]).',
                   15237:20):                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   15238:20):                                     }));
1.1075.2.95  raeburn  15239:                 } else {
1.1075.2.141.  .5(raebu 15240:20):                     push(@clonemsg,({
                   15241:20):                                       mt => 'No new course created.',
                   15242:20):                                       args => [],
                   15243:20):                                     },
                   15244:20):                                     {
                   15245:20):                                       mt => 'The new course could not be cloned from the existing course because the new course owner ([_1]) does not have cloning rights in the existing course ([_2]).',
                   15246:20):                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   15247:20):                                     }));
                   15248:20):                 }
1.566     albertel 15249: 	    }
1.578     raeburn  15250:         }
1.566     albertel 15251:     }
1.1075.2.141.  .5(raebu 15252:20):     return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566     albertel 15253: }
                   15254: 
1.444     albertel 15255: sub construct_course {
1.1075.2.119  raeburn  15256:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1075.2.141.  .5(raebu 15257:20):         $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
                   15258:20):     my ($outcome,$msgref,$clonemsgref);
1.541     raeburn  15259:     my $linefeed =  '<br />'."\n";
                   15260:     if ($context eq 'auto') {
                   15261:         $linefeed = "\n";
                   15262:     }
1.566     albertel 15263: 
                   15264: #
                   15265: # Are we cloning?
                   15266: #
1.1075.2.141.  .5(raebu 15267:20):     my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566     albertel 15268:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1075.2.141.  .5(raebu 15269:20): 	($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566     albertel 15270:         if (!$can_clone) {
1.1075.2.141.  .5(raebu 15271:20): 	    return (0,$outcome,$clonemsgref);
1.566     albertel 15272: 	}
                   15273:     }
                   15274: 
1.444     albertel 15275: #
                   15276: # Open course
                   15277: #
                   15278:     my $crstype = lc($args->{'crstype'});
                   15279:     my %cenv=();
                   15280:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   15281:                                              $args->{'cdescr'},
                   15282:                                              $args->{'curl'},
                   15283:                                              $args->{'course_home'},
                   15284:                                              $args->{'nonstandard'},
                   15285:                                              $args->{'crscode'},
                   15286:                                              $args->{'ccuname'}.':'.
                   15287:                                              $args->{'ccdomain'},
1.882     raeburn  15288:                                              $args->{'crstype'},
1.1075.2.141.  .5(raebu 15289:20):                                              $cnum,$context,$category,
                   15290:20):                                              $callercontext);
1.444     albertel 15291: 
                   15292:     # Note: The testing routines depend on this being output; see 
                   15293:     # Utils::Course. This needs to at least be output as a comment
                   15294:     # if anyone ever decides to not show this, and Utils::Course::new
                   15295:     # will need to be suitably modified.
1.1075.2.141.  .5(raebu 15296:20):     if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   15297:20):         $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
                   15298:20):     } else {
                   15299:20):         $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
                   15300:20):     }
1.943     raeburn  15301:     if ($$courseid =~ /^error:/) {
1.1075.2.141.  .5(raebu 15302:20):         return (0,$outcome,$clonemsgref);
1.943     raeburn  15303:     }
                   15304: 
1.444     albertel 15305: #
                   15306: # Check if created correctly
                   15307: #
1.479     albertel 15308:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 15309:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  15310:     if ($crsuhome eq 'no_host') {
1.1075.2.141.  .5(raebu 15311:20):         if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   15312:20):             $outcome .= &mt_user($user_lh,
                   15313:20):                             'Course creation failed, unrecognized course home server.');
                   15314:20):         } else {
                   15315:20):             $outcome .= &mt('Course creation failed, unrecognized course home server.');
                   15316:20):         }
                   15317:20):         $outcome .= $linefeed;
                   15318:20):         return (0,$outcome,$clonemsgref);
1.943     raeburn  15319:     }
1.541     raeburn  15320:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 15321: 
1.444     albertel 15322: #
1.566     albertel 15323: # Do the cloning
                   15324: #   
1.1075.2.141.  .5(raebu 15325:20):     my @clonemsg;
1.566     albertel 15326:     if ($can_clone && $cloneid) {
1.1075.2.141.  .5(raebu 15327:20):         push(@clonemsg,
                   15328:20):                       {
                   15329:20):                           mt => 'Created [_1] by cloning from [_2]',
                   15330:20):                           args => [$crstype,$clonetitle],
                   15331:20):                       });
1.566     albertel 15332: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 15333: # Copy all files
1.1075.2.141.  .5(raebu 15334:20):         my @info =
                   15335:20): 	    &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
                   15336:20):                                                      $args->{'dateshift'},$args->{'crscode'},
                   15337:20):                                                      $args->{'ccuname'}.':'.$args->{'ccdomain'},
                   15338:20):                                                      $args->{'tinyurls'});
                   15339:20):         if (@info) {
                   15340:20):             push(@clonemsg,@info);
                   15341:20):         }
1.444     albertel 15342: # Restore URL
1.566     albertel 15343: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 15344: # Restore title
1.566     albertel 15345: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  15346: # Restore creation date, creator and creation context.
                   15347:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   15348:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   15349:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 15350: # Mark as cloned
1.566     albertel 15351: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      15352: # Need to clone grading mode
                   15353:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   15354:         $cenv{'grading'}=$newenv{'grading'};
                   15355: # Do not clone these environment entries
                   15356:         &Apache::lonnet::del('environment',
                   15357:                   ['default_enrollment_start_date',
                   15358:                    'default_enrollment_end_date',
                   15359:                    'question.email',
                   15360:                    'policy.email',
                   15361:                    'comment.email',
                   15362:                    'pch.users.denied',
1.725     raeburn  15363:                    'plc.users.denied',
                   15364:                    'hidefromcat',
1.1075.2.36  raeburn  15365:                    'checkforpriv',
1.1075.2.59  raeburn  15366:                    'categories',
                   15367:                    'internal.uniquecode'],
1.638     www      15368:                    $$crsudom,$$crsunum);
1.1075.2.63  raeburn  15369:         if ($args->{'textbook'}) {
                   15370:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   15371:         }
1.444     albertel 15372:     }
1.566     albertel 15373: 
1.444     albertel 15374: #
                   15375: # Set environment (will override cloned, if existing)
                   15376: #
                   15377:     my @sections = ();
                   15378:     my @xlists = ();
                   15379:     if ($args->{'crstype'}) {
                   15380:         $cenv{'type'}=$args->{'crstype'};
                   15381:     }
                   15382:     if ($args->{'crsid'}) {
                   15383:         $cenv{'courseid'}=$args->{'crsid'};
                   15384:     }
                   15385:     if ($args->{'crscode'}) {
                   15386:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   15387:     }
                   15388:     if ($args->{'crsquota'} ne '') {
                   15389:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   15390:     } else {
                   15391:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   15392:     }
                   15393:     if ($args->{'ccuname'}) {
                   15394:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   15395:                                         ':'.$args->{'ccdomain'};
                   15396:     } else {
                   15397:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   15398:     }
1.1075.2.31  raeburn  15399:     if ($args->{'defaultcredits'}) {
                   15400:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   15401:     }
1.444     albertel 15402:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   15403:     if ($args->{'crssections'}) {
                   15404:         $cenv{'internal.sectionnums'} = '';
                   15405:         if ($args->{'crssections'} =~ m/,/) {
                   15406:             @sections = split/,/,$args->{'crssections'};
                   15407:         } else {
                   15408:             $sections[0] = $args->{'crssections'};
                   15409:         }
                   15410:         if (@sections > 0) {
                   15411:             foreach my $item (@sections) {
                   15412:                 my ($sec,$gp) = split/:/,$item;
                   15413:                 my $class = $args->{'crscode'}.$sec;
                   15414:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   15415:                 $cenv{'internal.sectionnums'} .= $item.',';
                   15416:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  15417:                     push(@badclasses,$class);
1.444     albertel 15418:                 }
                   15419:             }
                   15420:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   15421:         }
                   15422:     }
                   15423: # do not hide course coordinator from staff listing, 
                   15424: # even if privileged
                   15425:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36  raeburn  15426: # add course coordinator's domain to domains to check for privileged users
                   15427: # if different to course domain
                   15428:     if ($$crsudom ne $args->{'ccdomain'}) {
                   15429:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   15430:     }
1.444     albertel 15431: # add crosslistings
                   15432:     if ($args->{'crsxlist'}) {
                   15433:         $cenv{'internal.crosslistings'}='';
                   15434:         if ($args->{'crsxlist'} =~ m/,/) {
                   15435:             @xlists = split/,/,$args->{'crsxlist'};
                   15436:         } else {
                   15437:             $xlists[0] = $args->{'crsxlist'};
                   15438:         }
                   15439:         if (@xlists > 0) {
                   15440:             foreach my $item (@xlists) {
                   15441:                 my ($xl,$gp) = split/:/,$item;
                   15442:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   15443:                 $cenv{'internal.crosslistings'} .= $item.',';
                   15444:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  15445:                     push(@badclasses,$xl);
1.444     albertel 15446:                 }
                   15447:             }
                   15448:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   15449:         }
                   15450:     }
                   15451:     if ($args->{'autoadds'}) {
                   15452:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   15453:     }
                   15454:     if ($args->{'autodrops'}) {
                   15455:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   15456:     }
                   15457: # check for notification of enrollment changes
                   15458:     my @notified = ();
                   15459:     if ($args->{'notify_owner'}) {
                   15460:         if ($args->{'ccuname'} ne '') {
                   15461:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   15462:         }
                   15463:     }
                   15464:     if ($args->{'notify_dc'}) {
                   15465:         if ($uname ne '') { 
1.630     raeburn  15466:             push(@notified,$uname.':'.$udom);
1.444     albertel 15467:         }
                   15468:     }
                   15469:     if (@notified > 0) {
                   15470:         my $notifylist;
                   15471:         if (@notified > 1) {
                   15472:             $notifylist = join(',',@notified);
                   15473:         } else {
                   15474:             $notifylist = $notified[0];
                   15475:         }
                   15476:         $cenv{'internal.notifylist'} = $notifylist;
                   15477:     }
                   15478:     if (@badclasses > 0) {
                   15479:         my %lt=&Apache::lonlocal::texthash(
1.1075.2.119  raeburn  15480:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   15481:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   15482:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 15483:         );
1.1075.2.119  raeburn  15484:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   15485:                            &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  15486:         if ($context eq 'auto') {
                   15487:             $outcome .= $badclass_msg.$linefeed;
1.1075.2.119  raeburn  15488:         } else {
1.566     albertel 15489:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1075.2.119  raeburn  15490:         }
                   15491:         foreach my $item (@badclasses) {
1.541     raeburn  15492:             if ($context eq 'auto') {
1.1075.2.119  raeburn  15493:                 $outcome .= " - $item\n";
1.541     raeburn  15494:             } else {
1.1075.2.119  raeburn  15495:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  15496:             }
1.1075.2.119  raeburn  15497:         }
                   15498:         if ($context eq 'auto') {
                   15499:             $outcome .= $linefeed;
                   15500:         } else {
                   15501:             $outcome .= "</ul><br /><br /></div>\n";
                   15502:         }
1.444     albertel 15503:     }
                   15504:     if ($args->{'no_end_date'}) {
                   15505:         $args->{'endaccess'} = 0;
                   15506:     }
                   15507:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   15508:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   15509:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   15510:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   15511:     if ($args->{'showphotos'}) {
                   15512:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   15513:     }
                   15514:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   15515:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   15516:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   15517:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  15518:             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'); 
                   15519:             if ($context eq 'auto') {
                   15520:                 $outcome .= $krb_msg;
                   15521:             } else {
1.566     albertel 15522:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  15523:             }
                   15524:             $outcome .= $linefeed;
1.444     albertel 15525:         }
                   15526:     }
                   15527:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   15528:        if ($args->{'setpolicy'}) {
                   15529:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15530:        }
                   15531:        if ($args->{'setcontent'}) {
                   15532:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15533:        }
1.1075.2.110  raeburn  15534:        if ($args->{'setcomment'}) {
                   15535:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15536:        }
1.444     albertel 15537:     }
                   15538:     if ($args->{'reshome'}) {
                   15539: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   15540: 	$cenv{'reshome'}=~s/\/+$/\//;
                   15541:     }
                   15542: #
                   15543: # course has keyed access
                   15544: #
                   15545:     if ($args->{'setkeys'}) {
                   15546:        $cenv{'keyaccess'}='yes';
                   15547:     }
                   15548: # if specified, key authority is not course, but user
                   15549: # only active if keyaccess is yes
                   15550:     if ($args->{'keyauth'}) {
1.487     albertel 15551: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   15552: 	$user = &LONCAPA::clean_username($user);
                   15553: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     15554: 	if ($user ne '' && $domain ne '') {
1.487     albertel 15555: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 15556: 	}
                   15557:     }
                   15558: 
1.1075.2.59  raeburn  15559: #
                   15560: #  generate and store uniquecode (available to course requester), if course should have one.
                   15561: #
                   15562:     if ($args->{'uniquecode'}) {
                   15563:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   15564:         if ($code) {
                   15565:             $cenv{'internal.uniquecode'} = $code;
                   15566:             my %crsinfo =
                   15567:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   15568:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   15569:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   15570:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   15571:             }
                   15572:             if (ref($coderef)) {
                   15573:                 $$coderef = $code;
                   15574:             }
                   15575:         }
                   15576:     }
                   15577: 
1.444     albertel 15578:     if ($args->{'disresdis'}) {
                   15579:         $cenv{'pch.roles.denied'}='st';
                   15580:     }
                   15581:     if ($args->{'disablechat'}) {
                   15582:         $cenv{'plc.roles.denied'}='st';
                   15583:     }
                   15584: 
                   15585:     # Record we've not yet viewed the Course Initialization Helper for this 
                   15586:     # course
                   15587:     $cenv{'course.helper.not.run'} = 1;
                   15588:     #
                   15589:     # Use new Randomseed
                   15590:     #
                   15591:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   15592:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   15593:     #
                   15594:     # The encryption code and receipt prefix for this course
                   15595:     #
                   15596:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   15597:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   15598:     #
                   15599:     # By default, use standard grading
                   15600:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   15601: 
1.541     raeburn  15602:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   15603:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15604: #
                   15605: # Open all assignments
                   15606: #
                   15607:     if ($args->{'openall'}) {
1.1075.2.141.  .4(raebu 15608:20):        my $opendate = time;
                   15609:20):        if ($args->{'openallfrom'} =~ /^\d+$/) {
                   15610:20):            $opendate = $args->{'openallfrom'};
                   15611:20):        }
1.444     albertel 15612:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1075.2.141.  .4(raebu 15613:20):        my %storecontent = ($storeunder         => $opendate,
1.444     albertel 15614:                            $storeunder.'.type' => 'date_start');
1.1075.2.141.  .4(raebu 15615:20):        $outcome .= &mt('All assignments open starting [_1]',
                   15616:20):                        &Apache::lonlocal::locallocaltime($opendate)).': '.
                   15617:20):                    &Apache::lonnet::cput
                   15618:20):                        ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15619:    }
                   15620: #
                   15621: # Set first page
                   15622: #
                   15623:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   15624: 	    || ($cloneid)) {
1.445     albertel 15625: 	use LONCAPA::map;
1.444     albertel 15626: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 15627: 
                   15628: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   15629:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   15630: 
1.444     albertel 15631:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   15632:         my $title; my $url;
                   15633:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   15634: 	    $title=&mt('Syllabus');
1.444     albertel 15635:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   15636:         } else {
1.963     raeburn  15637:             $title=&mt('Table of Contents');
1.444     albertel 15638:             $url='/adm/navmaps';
                   15639:         }
1.445     albertel 15640: 
                   15641:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   15642: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   15643: 
                   15644: 	if ($errtext) { $fatal=2; }
1.541     raeburn  15645:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 15646:     }
1.566     albertel 15647: 
1.1075.2.141.  .5(raebu 15648:20):     return (1,$outcome,\@clonemsg);
1.444     albertel 15649: }
                   15650: 
1.1075.2.59  raeburn  15651: sub make_unique_code {
                   15652:     my ($cdom,$cnum) = @_;
                   15653:     # get lock on uniquecodes db
                   15654:     my $lockhash = {
                   15655:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   15656:                                                   ':'.$env{'user.domain'},
                   15657:                    };
                   15658:     my $tries = 0;
                   15659:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15660:     my ($code,$error);
                   15661: 
                   15662:     while (($gotlock ne 'ok') && ($tries<3)) {
                   15663:         $tries ++;
                   15664:         sleep 1;
                   15665:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15666:     }
                   15667:     if ($gotlock eq 'ok') {
                   15668:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   15669:         my $gotcode;
                   15670:         my $attempts = 0;
                   15671:         while ((!$gotcode) && ($attempts < 100)) {
                   15672:             $code = &generate_code();
                   15673:             if (!exists($currcodes{$code})) {
                   15674:                 $gotcode = 1;
                   15675:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   15676:                     $error = 'nostore';
                   15677:                 }
                   15678:             }
                   15679:             $attempts ++;
                   15680:         }
                   15681:         my @del_lock = ($cnum."\0".'uniquecodes');
                   15682:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   15683:     } else {
                   15684:         $error = 'nolock';
                   15685:     }
                   15686:     return ($code,$error);
                   15687: }
                   15688: 
                   15689: sub generate_code {
                   15690:     my $code;
                   15691:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   15692:     for (my $i=0; $i<6; $i++) {
                   15693:         my $lettnum = int (rand 2);
                   15694:         my $item = '';
                   15695:         if ($lettnum) {
                   15696:             $item = $letts[int( rand(18) )];
                   15697:         } else {
                   15698:             $item = 1+int( rand(8) );
                   15699:         }
                   15700:         $code .= $item;
                   15701:     }
                   15702:     return $code;
                   15703: }
                   15704: 
1.444     albertel 15705: ############################################################
                   15706: ############################################################
                   15707: 
1.953     droeschl 15708: #SD
                   15709: # only Community and Course, or anything else?
1.378     raeburn  15710: sub course_type {
                   15711:     my ($cid) = @_;
                   15712:     if (!defined($cid)) {
                   15713:         $cid = $env{'request.course.id'};
                   15714:     }
1.404     albertel 15715:     if (defined($env{'course.'.$cid.'.type'})) {
                   15716:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  15717:     } else {
                   15718:         return 'Course';
1.377     raeburn  15719:     }
                   15720: }
1.156     albertel 15721: 
1.406     raeburn  15722: sub group_term {
                   15723:     my $crstype = &course_type();
                   15724:     my %names = (
                   15725:                   'Course' => 'group',
1.865     raeburn  15726:                   'Community' => 'group',
1.406     raeburn  15727:                 );
                   15728:     return $names{$crstype};
                   15729: }
                   15730: 
1.902     raeburn  15731: sub course_types {
1.1075.2.59  raeburn  15732:     my @types = ('official','unofficial','community','textbook');
1.902     raeburn  15733:     my %typename = (
                   15734:                          official   => 'Official course',
                   15735:                          unofficial => 'Unofficial course',
                   15736:                          community  => 'Community',
1.1075.2.59  raeburn  15737:                          textbook   => 'Textbook course',
1.902     raeburn  15738:                    );
                   15739:     return (\@types,\%typename);
                   15740: }
                   15741: 
1.156     albertel 15742: sub icon {
                   15743:     my ($file)=@_;
1.505     albertel 15744:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 15745:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 15746:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 15747:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   15748: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   15749: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   15750: 	            $curfext.".gif") {
                   15751: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   15752: 		$curfext.".gif";
                   15753: 	}
                   15754:     }
1.249     albertel 15755:     return &lonhttpdurl($iconname);
1.154     albertel 15756: } 
1.84      albertel 15757: 
1.575     albertel 15758: sub lonhttpdurl {
1.692     www      15759: #
                   15760: # Had been used for "small fry" static images on separate port 8080.
                   15761: # Modify here if lightweight http functionality desired again.
                   15762: # Currently eliminated due to increasing firewall issues.
                   15763: #
1.575     albertel 15764:     my ($url)=@_;
1.692     www      15765:     return $url;
1.215     albertel 15766: }
                   15767: 
1.213     albertel 15768: sub connection_aborted {
                   15769:     my ($r)=@_;
                   15770:     $r->print(" ");$r->rflush();
                   15771:     my $c = $r->connection;
                   15772:     return $c->aborted();
                   15773: }
                   15774: 
1.221     foxr     15775: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     15776: #    strings as 'strings'.
                   15777: sub escape_single {
1.221     foxr     15778:     my ($input) = @_;
1.223     albertel 15779:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     15780:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   15781:     return $input;
                   15782: }
1.223     albertel 15783: 
1.222     foxr     15784: #  Same as escape_single, but escape's "'s  This 
                   15785: #  can be used for  "strings"
                   15786: sub escape_double {
                   15787:     my ($input) = @_;
                   15788:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   15789:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   15790:     return $input;
                   15791: }
1.223     albertel 15792:  
1.222     foxr     15793: #   Escapes the last element of a full URL.
                   15794: sub escape_url {
                   15795:     my ($url)   = @_;
1.238     raeburn  15796:     my @urlslices = split(/\//, $url,-1);
1.369     www      15797:     my $lastitem = &escape(pop(@urlslices));
1.1075.2.83  raeburn  15798:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     15799: }
1.462     albertel 15800: 
1.820     raeburn  15801: sub compare_arrays {
                   15802:     my ($arrayref1,$arrayref2) = @_;
                   15803:     my (@difference,%count);
                   15804:     @difference = ();
                   15805:     %count = ();
                   15806:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   15807:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   15808:         foreach my $element (keys(%count)) {
                   15809:             if ($count{$element} == 1) {
                   15810:                 push(@difference,$element);
                   15811:             }
                   15812:         }
                   15813:     }
                   15814:     return @difference;
                   15815: }
                   15816: 
1.817     bisitz   15817: # -------------------------------------------------------- Initialize user login
1.462     albertel 15818: sub init_user_environment {
1.463     albertel 15819:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 15820:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   15821: 
                   15822:     my $public=($username eq 'public' && $domain eq 'public');
                   15823: 
                   15824: # See if old ID present, if so, remove
                   15825: 
1.1062    raeburn  15826:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 15827:     my $now=time;
                   15828: 
                   15829:     if ($public) {
                   15830: 	my $max_public=100;
                   15831: 	my $oldest;
                   15832: 	my $oldest_time=0;
                   15833: 	for(my $next=1;$next<=$max_public;$next++) {
                   15834: 	    if (-e $lonids."/publicuser_$next.id") {
                   15835: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   15836: 		if ($mtime<$oldest_time || !$oldest_time) {
                   15837: 		    $oldest_time=$mtime;
                   15838: 		    $oldest=$next;
                   15839: 		}
                   15840: 	    } else {
                   15841: 		$cookie="publicuser_$next";
                   15842: 		last;
                   15843: 	    }
                   15844: 	}
                   15845: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   15846:     } else {
1.463     albertel 15847: 	# if this isn't a robot, kill any existing non-robot sessions
                   15848: 	if (!$args->{'robot'}) {
                   15849: 	    opendir(DIR,$lonids);
                   15850: 	    while ($filename=readdir(DIR)) {
                   15851: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1075.2.136  raeburn  15852:                     if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
                   15853:                             &GDBM_READER(),0640)) {
                   15854:                         my $linkedfile;
                   15855:                         if (exists($oldenv{'user.linkedenv'})) {
                   15856:                             $linkedfile = $oldenv{'user.linkedenv'};
                   15857:                         }
                   15858:                         untie(%oldenv);
                   15859:                         if (unlink("$lonids/$filename")) {
                   15860:                             if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                   15861:                                 if (-l "$lonids/$linkedfile.id") {
                   15862:                                     unlink("$lonids/$linkedfile.id");
                   15863:                                 }
                   15864:                             }
                   15865:                         }
                   15866:                     } else {
                   15867:                         unlink($lonids.'/'.$filename);
                   15868:                     }
1.463     albertel 15869: 		}
1.462     albertel 15870: 	    }
1.463     albertel 15871: 	    closedir(DIR);
1.1075.2.84  raeburn  15872: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   15873:             my $namespace = 'nohist_courseeditor';
                   15874:             my $lockingkey = 'paste'."\0".'locked_num';
                   15875:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   15876:                                                 $domain,$username);
                   15877:             if (exists($lockhash{$lockingkey})) {
                   15878:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   15879:                 unless ($delresult eq 'ok') {
                   15880:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   15881:                 }
                   15882:             }
1.462     albertel 15883: 	}
                   15884: # Give them a new cookie
1.463     albertel 15885: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      15886: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 15887: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 15888:     
                   15889: # Initialize roles
                   15890: 
1.1062    raeburn  15891: 	($userroles,$firstaccenv,$timerintenv) = 
                   15892:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 15893:     }
                   15894: # ------------------------------------ Check browser type and MathML capability
                   15895: 
1.1075.2.77  raeburn  15896:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   15897:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 15898: 
                   15899: # ------------------------------------------------------------- Get environment
                   15900: 
                   15901:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   15902:     my ($tmp) = keys(%userenv);
                   15903:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   15904:     } else {
                   15905: 	undef(%userenv);
                   15906:     }
                   15907:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   15908: 	$form->{'interface'}=$userenv{'interface'};
                   15909:     }
                   15910:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   15911: 
                   15912: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   15913:     foreach my $option ('interface','localpath','localres') {
                   15914:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 15915:     }
                   15916: # --------------------------------------------------------- Write first profile
                   15917: 
                   15918:     {
                   15919: 	my %initial_env = 
                   15920: 	    ("user.name"          => $username,
                   15921: 	     "user.domain"        => $domain,
                   15922: 	     "user.home"          => $authhost,
                   15923: 	     "browser.type"       => $clientbrowser,
                   15924: 	     "browser.version"    => $clientversion,
                   15925: 	     "browser.mathml"     => $clientmathml,
                   15926: 	     "browser.unicode"    => $clientunicode,
                   15927: 	     "browser.os"         => $clientos,
1.1075.2.42  raeburn  15928:              "browser.mobile"     => $clientmobile,
                   15929:              "browser.info"       => $clientinfo,
1.1075.2.77  raeburn  15930:              "browser.osversion"  => $clientosversion,
1.462     albertel 15931: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   15932: 	     "request.course.fn"  => '',
                   15933: 	     "request.course.uri" => '',
                   15934: 	     "request.course.sec" => '',
                   15935: 	     "request.role"       => 'cm',
                   15936: 	     "request.role.adv"   => $env{'user.adv'},
                   15937: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   15938: 
                   15939:         if ($form->{'localpath'}) {
                   15940: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   15941: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   15942:         }
                   15943: 	
                   15944: 	if ($form->{'interface'}) {
                   15945: 	    $form->{'interface'}=~s/\W//gs;
                   15946: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   15947: 	    $env{'browser.interface'}=$form->{'interface'};
                   15948: 	}
                   15949: 
1.1075.2.54  raeburn  15950:         if ($form->{'iptoken'}) {
                   15951:             my $lonhost = $r->dir_config('lonHostID');
                   15952:             $initial_env{"user.noloadbalance"} = $lonhost;
                   15953:             $env{'user.noloadbalance'} = $lonhost;
                   15954:         }
                   15955: 
1.1075.2.120  raeburn  15956:         if ($form->{'noloadbalance'}) {
                   15957:             my @hosts = &Apache::lonnet::current_machine_ids();
                   15958:             my $hosthere = $form->{'noloadbalance'};
                   15959:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   15960:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   15961:                 $env{'user.noloadbalance'} = $hosthere;
                   15962:             }
                   15963:         }
                   15964: 
1.1016    raeburn  15965:         unless ($domain eq 'public') {
1.1075.2.125  raeburn  15966:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   15967:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
1.980     raeburn  15968: 
1.1075.2.125  raeburn  15969:             foreach my $tool ('aboutme','blog','webdav','portfolio') {
                   15970:                 $userenv{'availabletools.'.$tool} = 
                   15971:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   15972:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   15973:             }
1.724     raeburn  15974: 
1.1075.2.125  raeburn  15975:             foreach my $crstype ('official','unofficial','community','textbook') {
                   15976:                 $userenv{'canrequest.'.$crstype} =
                   15977:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   15978:                                                       'reload','requestcourses',
                   15979:                                                       \%userenv,\%domdef,\%is_adv);
                   15980:             }
1.765     raeburn  15981: 
1.1075.2.125  raeburn  15982:             $userenv{'canrequest.author'} =
                   15983:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   15984:                                                   'reload','requestauthor',
                   15985:                                                   \%userenv,\%domdef,\%is_adv);
                   15986:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   15987:                                                  $domain,$username);
                   15988:             my $reqstatus = $reqauthor{'author_status'};
                   15989:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
                   15990:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   15991:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   15992:                                                       $reqauthor{'author'}{'timestamp'};
                   15993:                 }
1.1075.2.14  raeburn  15994:             }
                   15995:         }
                   15996: 
1.462     albertel 15997: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  15998: 
1.462     albertel 15999: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   16000: 		 &GDBM_WRCREAT(),0640)) {
                   16001: 	    &_add_to_env(\%disk_env,\%initial_env);
                   16002: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   16003: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  16004:             if (ref($firstaccenv) eq 'HASH') {
                   16005:                 &_add_to_env(\%disk_env,$firstaccenv);
                   16006:             }
                   16007:             if (ref($timerintenv) eq 'HASH') {
                   16008:                 &_add_to_env(\%disk_env,$timerintenv);
                   16009:             }
1.463     albertel 16010: 	    if (ref($args->{'extra_env'})) {
                   16011: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   16012: 	    }
1.462     albertel 16013: 	    untie(%disk_env);
                   16014: 	} else {
1.705     tempelho 16015: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   16016: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 16017: 	    return 'error: '.$!;
                   16018: 	}
                   16019:     }
                   16020:     $env{'request.role'}='cm';
                   16021:     $env{'request.role.adv'}=$env{'user.adv'};
                   16022:     $env{'browser.type'}=$clientbrowser;
                   16023: 
                   16024:     return $cookie;
                   16025: 
                   16026: }
                   16027: 
                   16028: sub _add_to_env {
                   16029:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  16030:     if (ref($env_data) eq 'HASH') {
                   16031:         while (my ($key,$value) = each(%$env_data)) {
                   16032: 	    $idf->{$prefix.$key} = $value;
                   16033: 	    $env{$prefix.$key}   = $value;
                   16034:         }
1.462     albertel 16035:     }
                   16036: }
                   16037: 
1.685     tempelho 16038: # --- Get the symbolic name of a problem and the url
                   16039: sub get_symb {
                   16040:     my ($request,$silent) = @_;
1.726     raeburn  16041:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 16042:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   16043:     if ($symb eq '') {
                   16044:         if (!$silent) {
1.1071    raeburn  16045:             if (ref($request)) { 
                   16046:                 $request->print("Unable to handle ambiguous references:$url:.");
                   16047:             }
1.685     tempelho 16048:             return ();
                   16049:         }
                   16050:     }
                   16051:     &Apache::lonenc::check_decrypt(\$symb);
                   16052:     return ($symb);
                   16053: }
                   16054: 
                   16055: # --------------------------------------------------------------Get annotation
                   16056: 
                   16057: sub get_annotation {
                   16058:     my ($symb,$enc) = @_;
                   16059: 
                   16060:     my $key = $symb;
                   16061:     if (!$enc) {
                   16062:         $key =
                   16063:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   16064:     }
                   16065:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   16066:     return $annotation{$key};
                   16067: }
                   16068: 
                   16069: sub clean_symb {
1.731     raeburn  16070:     my ($symb,$delete_enc) = @_;
1.685     tempelho 16071: 
                   16072:     &Apache::lonenc::check_decrypt(\$symb);
                   16073:     my $enc = $env{'request.enc'};
1.731     raeburn  16074:     if ($delete_enc) {
1.730     raeburn  16075:         delete($env{'request.enc'});
                   16076:     }
1.685     tempelho 16077: 
                   16078:     return ($symb,$enc);
                   16079: }
1.462     albertel 16080: 
1.1075.2.69  raeburn  16081: ############################################################
                   16082: ############################################################
                   16083: 
                   16084: =pod
                   16085: 
                   16086: =head1 Routines for building display used to search for courses
                   16087: 
                   16088: 
                   16089: =over 4
                   16090: 
                   16091: =item * &build_filters()
                   16092: 
                   16093: Create markup for a table used to set filters to use when selecting
                   16094: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   16095: and quotacheck.pl
                   16096: 
                   16097: 
                   16098: Inputs:
                   16099: 
                   16100: filterlist - anonymous array of fields to include as potential filters
                   16101: 
                   16102: crstype - course type
                   16103: 
                   16104: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   16105:               to pop-open a course selector (will contain "extra element").
                   16106: 
                   16107: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   16108: 
                   16109: filter - anonymous hash of criteria and their values
                   16110: 
                   16111: action - form action
                   16112: 
                   16113: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   16114: 
                   16115: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
                   16116: 
                   16117: cloneruname - username of owner of new course who wants to clone
                   16118: 
                   16119: clonerudom - domain of owner of new course who wants to clone
                   16120: 
                   16121: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
                   16122: 
                   16123: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   16124: 
                   16125: codedom - domain
                   16126: 
                   16127: formname - value of form element named "form".
                   16128: 
                   16129: fixeddom - domain, if fixed.
                   16130: 
                   16131: prevphase - value to assign to form element named "phase" when going back to the previous screen
                   16132: 
                   16133: cnameelement - name of form element in form on opener page which will receive title of selected course
                   16134: 
                   16135: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   16136: 
                   16137: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   16138: 
                   16139: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   16140: 
                   16141: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   16142: 
                   16143: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   16144: 
                   16145: 
                   16146: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   16147: 
                   16148: 
                   16149: Side Effects: None
                   16150: 
                   16151: =cut
                   16152: 
                   16153: # ---------------------------------------------- search for courses based on last activity etc.
                   16154: 
                   16155: sub build_filters {
                   16156:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   16157:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   16158:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   16159:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   16160:         $clonetext,$clonewarning) = @_;
                   16161:     my ($list,$jscript);
                   16162:     my $onchange = 'javascript:updateFilters(this)';
                   16163:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   16164:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   16165:         $typeselectform,$instcodetitle);
                   16166:     if ($formname eq '') {
                   16167:         $formname = $caller;
                   16168:     }
                   16169:     foreach my $item (@{$filterlist}) {
                   16170:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   16171:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   16172:             if ($item eq 'domainfilter') {
                   16173:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   16174:             } elsif ($item eq 'coursefilter') {
                   16175:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   16176:             } elsif ($item eq 'ownerfilter') {
                   16177:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16178:             } elsif ($item eq 'ownerdomfilter') {
                   16179:                 $filter->{'ownerdomfilter'} =
                   16180:                     &LONCAPA::clean_domain($filter->{$item});
                   16181:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   16182:                                                        'ownerdomfilter',1);
                   16183:             } elsif ($item eq 'personfilter') {
                   16184:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16185:             } elsif ($item eq 'persondomfilter') {
                   16186:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   16187:                                                         'persondomfilter',1);
                   16188:             } else {
                   16189:                 $filter->{$item} =~ s/\W//g;
                   16190:             }
                   16191:             if (!$filter->{$item}) {
                   16192:                 $filter->{$item} = '';
                   16193:             }
                   16194:         }
                   16195:         if ($item eq 'domainfilter') {
                   16196:             my $allow_blank = 1;
                   16197:             if ($formname eq 'portform') {
                   16198:                 $allow_blank=0;
                   16199:             } elsif ($formname eq 'studentform') {
                   16200:                 $allow_blank=0;
                   16201:             }
                   16202:             if ($fixeddom) {
                   16203:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   16204:                                     ' value="'.$codedom.'" />'.
                   16205:                                     &Apache::lonnet::domain($codedom,'description');
                   16206:             } else {
                   16207:                 $domainselectform = &select_dom_form($filter->{$item},
                   16208:                                                      'domainfilter',
                   16209:                                                       $allow_blank,'',$onchange);
                   16210:             }
                   16211:         } else {
                   16212:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   16213:         }
                   16214:     }
                   16215: 
                   16216:     # last course activity filter and selection
                   16217:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   16218: 
                   16219:     # course created filter and selection
                   16220:     if (exists($filter->{'createdfilter'})) {
                   16221:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   16222:     }
                   16223: 
                   16224:     my %lt = &Apache::lonlocal::texthash(
                   16225:                 'cac' => "$crstype Activity",
                   16226:                 'ccr' => "$crstype Created",
                   16227:                 'cde' => "$crstype Title",
                   16228:                 'cdo' => "$crstype Domain",
                   16229:                 'ins' => 'Institutional Code',
                   16230:                 'inc' => 'Institutional Categorization',
                   16231:                 'cow' => "$crstype Owner/Co-owner",
                   16232:                 'cop' => "$crstype Personnel Includes",
                   16233:                 'cog' => 'Type',
                   16234:              );
                   16235: 
                   16236:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16237:         my $typeval = 'Course';
                   16238:         if ($crstype eq 'Community') {
                   16239:             $typeval = 'Community';
                   16240:         }
                   16241:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   16242:     } else {
                   16243:         $typeselectform =  '<select name="type" size="1"';
                   16244:         if ($onchange) {
                   16245:             $typeselectform .= ' onchange="'.$onchange.'"';
                   16246:         }
                   16247:         $typeselectform .= '>'."\n";
                   16248:         foreach my $posstype ('Course','Community') {
                   16249:             $typeselectform.='<option value="'.$posstype.'"'.
                   16250:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
                   16251:         }
                   16252:         $typeselectform.="</select>";
                   16253:     }
                   16254: 
                   16255:     my ($cloneableonlyform,$cloneabletitle);
                   16256:     if (exists($filter->{'cloneableonly'})) {
                   16257:         my $cloneableon = '';
                   16258:         my $cloneableoff = ' checked="checked"';
                   16259:         if ($filter->{'cloneableonly'}) {
                   16260:             $cloneableon = $cloneableoff;
                   16261:             $cloneableoff = '';
                   16262:         }
                   16263:         $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>';
                   16264:         if ($formname eq 'ccrs') {
1.1075.2.71  raeburn  16265:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1075.2.69  raeburn  16266:         } else {
                   16267:             $cloneabletitle = &mt('Cloneable by you');
                   16268:         }
                   16269:     }
                   16270:     my $officialjs;
                   16271:     if ($crstype eq 'Course') {
                   16272:         if (exists($filter->{'instcodefilter'})) {
                   16273: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   16274: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   16275:             if ($codedom) {
                   16276:                 $officialjs = 1;
                   16277:                 ($instcodeform,$jscript,$$numtitlesref) =
                   16278:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   16279:                                                                   $officialjs,$codetitlesref);
                   16280:                 if ($jscript) {
                   16281:                     $jscript = '<script type="text/javascript">'."\n".
                   16282:                                '// <![CDATA['."\n".
                   16283:                                $jscript."\n".
                   16284:                                '// ]]>'."\n".
                   16285:                                '</script>'."\n";
                   16286:                 }
                   16287:             }
                   16288:             if ($instcodeform eq '') {
                   16289:                 $instcodeform =
                   16290:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   16291:                     $list->{'instcodefilter'}.'" />';
                   16292:                 $instcodetitle = $lt{'ins'};
                   16293:             } else {
                   16294:                 $instcodetitle = $lt{'inc'};
                   16295:             }
                   16296:             if ($fixeddom) {
                   16297:                 $instcodetitle .= '<br />('.$codedom.')';
                   16298:             }
                   16299:         }
                   16300:     }
                   16301:     my $output = qq|
                   16302: <form method="post" name="filterpicker" action="$action">
                   16303: <input type="hidden" name="form" value="$formname" />
                   16304: |;
                   16305:     if ($formname eq 'modifycourse') {
                   16306:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   16307:                    '<input type="hidden" name="prevphase" value="'.
                   16308:                    $prevphase.'" />'."\n";
1.1075.2.82  raeburn  16309:     } elsif ($formname eq 'quotacheck') {
                   16310:         $output .= qq|
                   16311: <input type="hidden" name="sortby" value="" />
                   16312: <input type="hidden" name="sortorder" value="" />
                   16313: |;
                   16314:     } else {
1.1075.2.69  raeburn  16315:         my $name_input;
                   16316:         if ($cnameelement ne '') {
                   16317:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   16318:                           $cnameelement.'" />';
                   16319:         }
                   16320:         $output .= qq|
                   16321: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   16322: <input type="hidden" name="cdomelement" value="$cdomelement" />
                   16323: $name_input
                   16324: $roleelement
                   16325: $multelement
                   16326: $typeelement
                   16327: |;
                   16328:         if ($formname eq 'portform') {
                   16329:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   16330:         }
                   16331:     }
                   16332:     if ($fixeddom) {
                   16333:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   16334:     }
                   16335:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   16336:     if ($sincefilterform) {
                   16337:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   16338:                   .$sincefilterform
                   16339:                   .&Apache::lonhtmlcommon::row_closure();
                   16340:     }
                   16341:     if ($createdfilterform) {
                   16342:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   16343:                   .$createdfilterform
                   16344:                   .&Apache::lonhtmlcommon::row_closure();
                   16345:     }
                   16346:     if ($domainselectform) {
                   16347:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   16348:                   .$domainselectform
                   16349:                   .&Apache::lonhtmlcommon::row_closure();
                   16350:     }
                   16351:     if ($typeselectform) {
                   16352:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16353:             $output .= $typeselectform;
                   16354:         } else {
                   16355:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   16356:                       .$typeselectform
                   16357:                       .&Apache::lonhtmlcommon::row_closure();
                   16358:         }
                   16359:     }
                   16360:     if ($instcodeform) {
                   16361:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   16362:                   .$instcodeform
                   16363:                   .&Apache::lonhtmlcommon::row_closure();
                   16364:     }
                   16365:     if (exists($filter->{'ownerfilter'})) {
                   16366:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   16367:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16368:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   16369:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16370:                    $ownerdomselectform.'</td></tr></table>'.
                   16371:                    &Apache::lonhtmlcommon::row_closure();
                   16372:     }
                   16373:     if (exists($filter->{'personfilter'})) {
                   16374:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   16375:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16376:                    '<input type="text" name="personfilter" size="20" value="'.
                   16377:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16378:                    $persondomselectform.'</td></tr></table>'.
                   16379:                    &Apache::lonhtmlcommon::row_closure();
                   16380:     }
                   16381:     if (exists($filter->{'coursefilter'})) {
                   16382:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   16383:                   .'<input type="text" name="coursefilter" size="25" value="'
                   16384:                   .$list->{'coursefilter'}.'" />'
                   16385:                   .&Apache::lonhtmlcommon::row_closure();
                   16386:     }
                   16387:     if ($cloneableonlyform) {
                   16388:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   16389:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   16390:     }
                   16391:     if (exists($filter->{'descriptfilter'})) {
                   16392:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   16393:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   16394:                   .$list->{'descriptfilter'}.'" />'
                   16395:                   .&Apache::lonhtmlcommon::row_closure(1);
                   16396:     }
                   16397:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   16398:                '<input type="hidden" name="updater" value="" />'."\n".
                   16399:                '<input type="submit" name="gosearch" value="'.
                   16400:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   16401:     return $jscript.$clonewarning.$output;
                   16402: }
                   16403: 
                   16404: =pod
                   16405: 
                   16406: =item * &timebased_select_form()
                   16407: 
                   16408: Create markup for a dropdown list used to select a time-based
                   16409: filter e.g., Course Activity, Course Created, when searching for courses
                   16410: or communities
                   16411: 
                   16412: Inputs:
                   16413: 
                   16414: item - name of form element (sincefilter or createdfilter)
                   16415: 
                   16416: filter - anonymous hash of criteria and their values
                   16417: 
                   16418: Returns: HTML for a select box contained a blank, then six time selections,
                   16419:          with value set in incoming form variables currently selected.
                   16420: 
                   16421: Side Effects: None
                   16422: 
                   16423: =cut
                   16424: 
                   16425: sub timebased_select_form {
                   16426:     my ($item,$filter) = @_;
                   16427:     if (ref($filter) eq 'HASH') {
                   16428:         $filter->{$item} =~ s/[^\d-]//g;
                   16429:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   16430:         return &select_form(
                   16431:                             $filter->{$item},
                   16432:                             $item,
                   16433:                             {      '-1' => '',
                   16434:                                 '86400' => &mt('today'),
                   16435:                                '604800' => &mt('last week'),
                   16436:                               '2592000' => &mt('last month'),
                   16437:                               '7776000' => &mt('last three months'),
                   16438:                              '15552000' => &mt('last six months'),
                   16439:                              '31104000' => &mt('last year'),
                   16440:                     'select_form_order' =>
                   16441:                            ['-1','86400','604800','2592000','7776000',
                   16442:                             '15552000','31104000']});
                   16443:     }
                   16444: }
                   16445: 
                   16446: =pod
                   16447: 
                   16448: =item * &js_changer()
                   16449: 
                   16450: Create script tag containing Javascript used to submit course search form
                   16451: when course type or domain is changed, and also to hide 'Searching ...' on
                   16452: page load completion for page showing search result.
                   16453: 
                   16454: Inputs: None
                   16455: 
                   16456: Returns: markup containing updateFilters() and hideSearching() javascript functions.
                   16457: 
                   16458: Side Effects: None
                   16459: 
                   16460: =cut
                   16461: 
                   16462: sub js_changer {
                   16463:     return <<ENDJS;
                   16464: <script type="text/javascript">
                   16465: // <![CDATA[
                   16466: function updateFilters(caller) {
                   16467:     if (typeof(caller) != "undefined") {
                   16468:         document.filterpicker.updater.value = caller.name;
                   16469:     }
                   16470:     document.filterpicker.submit();
                   16471: }
                   16472: 
                   16473: function hideSearching() {
                   16474:     if (document.getElementById('searching')) {
                   16475:         document.getElementById('searching').style.display = 'none';
                   16476:     }
                   16477:     return;
                   16478: }
                   16479: 
                   16480: // ]]>
                   16481: </script>
                   16482: 
                   16483: ENDJS
                   16484: }
                   16485: 
                   16486: =pod
                   16487: 
                   16488: =item * &search_courses()
                   16489: 
                   16490: Process selected filters form course search form and pass to lonnet::courseiddump
                   16491: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   16492: 
                   16493: Inputs:
                   16494: 
                   16495: dom - domain being searched
                   16496: 
                   16497: type - course type ('Course' or 'Community' or '.' if any).
                   16498: 
                   16499: filter - anonymous hash of criteria and their values
                   16500: 
                   16501: numtitles - for institutional codes - number of categories
                   16502: 
                   16503: cloneruname - optional username of new course owner
                   16504: 
                   16505: clonerudom - optional domain of new course owner
                   16506: 
1.1075.2.95  raeburn  16507: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1075.2.69  raeburn  16508:             (used when DC is using course creation form)
                   16509: 
                   16510: codetitles - reference to array of titles of components in institutional codes (official courses).
                   16511: 
1.1075.2.95  raeburn  16512: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   16513:            (and so can clone automatically)
                   16514: 
                   16515: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   16516: 
                   16517: reqinstcode - institutional code of new course, where search_courses is used to identify potential
                   16518:               courses to clone
1.1075.2.69  raeburn  16519: 
                   16520: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   16521: 
                   16522: 
                   16523: Side Effects: None
                   16524: 
                   16525: =cut
                   16526: 
                   16527: 
                   16528: sub search_courses {
1.1075.2.95  raeburn  16529:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   16530:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1075.2.69  raeburn  16531:     my (%courses,%showcourses,$cloner);
                   16532:     if (($filter->{'ownerfilter'} ne '') ||
                   16533:         ($filter->{'ownerdomfilter'} ne '')) {
                   16534:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   16535:                                        $filter->{'ownerdomfilter'};
                   16536:     }
                   16537:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   16538:         if (!$filter->{$item}) {
                   16539:             $filter->{$item}='.';
                   16540:         }
                   16541:     }
                   16542:     my $now = time;
                   16543:     my $timefilter =
                   16544:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   16545:     my ($createdbefore,$createdafter);
                   16546:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   16547:         $createdbefore = $now;
                   16548:         $createdafter = $now-$filter->{'createdfilter'};
                   16549:     }
                   16550:     my ($instcodefilter,$regexpok);
                   16551:     if ($numtitles) {
                   16552:         if ($env{'form.official'} eq 'on') {
                   16553:             $instcodefilter =
                   16554:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16555:             $regexpok = 1;
                   16556:         } elsif ($env{'form.official'} eq 'off') {
                   16557:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16558:             unless ($instcodefilter eq '') {
                   16559:                 $regexpok = -1;
                   16560:             }
                   16561:         }
                   16562:     } else {
                   16563:         $instcodefilter = $filter->{'instcodefilter'};
                   16564:     }
                   16565:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   16566:     if ($type eq '') { $type = '.'; }
                   16567: 
                   16568:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   16569:         $cloner = $cloneruname.':'.$clonerudom;
                   16570:     }
                   16571:     %courses = &Apache::lonnet::courseiddump($dom,
                   16572:                                              $filter->{'descriptfilter'},
                   16573:                                              $timefilter,
                   16574:                                              $instcodefilter,
                   16575:                                              $filter->{'combownerfilter'},
                   16576:                                              $filter->{'coursefilter'},
                   16577:                                              undef,undef,$type,$regexpok,undef,undef,
1.1075.2.95  raeburn  16578:                                              undef,undef,$cloner,$cc_clone,
1.1075.2.69  raeburn  16579:                                              $filter->{'cloneableonly'},
                   16580:                                              $createdbefore,$createdafter,undef,
1.1075.2.95  raeburn  16581:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1075.2.69  raeburn  16582:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   16583:         my $ccrole;
                   16584:         if ($type eq 'Community') {
                   16585:             $ccrole = 'co';
                   16586:         } else {
                   16587:             $ccrole = 'cc';
                   16588:         }
                   16589:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   16590:                                                      $filter->{'persondomfilter'},
                   16591:                                                      'userroles',undef,
                   16592:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   16593:                                                      $dom);
                   16594:         foreach my $role (keys(%rolehash)) {
                   16595:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   16596:             my $cid = $cdom.'_'.$cnum;
                   16597:             if (exists($courses{$cid})) {
                   16598:                 if (ref($courses{$cid}) eq 'HASH') {
                   16599:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   16600:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1075.2.119  raeburn  16601:                             push(@{$courses{$cid}{roles}},$courserole);
1.1075.2.69  raeburn  16602:                         }
                   16603:                     } else {
                   16604:                         $courses{$cid}{roles} = [$courserole];
                   16605:                     }
                   16606:                     $showcourses{$cid} = $courses{$cid};
                   16607:                 }
                   16608:             }
                   16609:         }
                   16610:         %courses = %showcourses;
                   16611:     }
                   16612:     return %courses;
                   16613: }
                   16614: 
                   16615: =pod
                   16616: 
                   16617: =back
                   16618: 
1.1075.2.88  raeburn  16619: =head1 Routines for version requirements for current course.
                   16620: 
                   16621: =over 4
                   16622: 
                   16623: =item * &check_release_required()
                   16624: 
                   16625: Compares required LON-CAPA version with version on server, and
                   16626: if required version is newer looks for a server with the required version.
                   16627: 
                   16628: Looks first at servers in user's owen domain; if none suitable, looks at
                   16629: servers in course's domain are permitted to host sessions for user's domain.
                   16630: 
                   16631: Inputs:
                   16632: 
                   16633: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16634: 
                   16635: $courseid - Course ID of current course
                   16636: 
                   16637: $rolecode - User's current role in course (for switchserver query string).
                   16638: 
                   16639: $required - LON-CAPA version needed by course (format: Major.Minor).
                   16640: 
                   16641: 
                   16642: Returns:
                   16643: 
                   16644: $switchserver - query string tp append to /adm/switchserver call (if
                   16645:                 current server's LON-CAPA version is too old.
                   16646: 
                   16647: $warning - Message is displayed if no suitable server could be found.
                   16648: 
                   16649: =cut
                   16650: 
                   16651: sub check_release_required {
                   16652:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   16653:     my ($switchserver,$warning);
                   16654:     if ($required ne '') {
                   16655:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   16656:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16657:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   16658:             my $otherserver;
                   16659:             if (($major eq '' && $minor eq '') ||
                   16660:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   16661:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   16662:                 my $switchlcrev =
                   16663:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   16664:                                                            $userdomserver);
                   16665:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16666:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   16667:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   16668:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   16669:                     if ($cdom ne $env{'user.domain'}) {
                   16670:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   16671:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   16672:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   16673:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   16674:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   16675:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   16676:                         my $canhost =
                   16677:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   16678:                                                               $coursedomserver,
                   16679:                                                               $remoterev,
                   16680:                                                               $udomdefaults{'remotesessions'},
                   16681:                                                               $defdomdefaults{'hostedsessions'});
                   16682: 
                   16683:                         if ($canhost) {
                   16684:                             $otherserver = $coursedomserver;
                   16685:                         } else {
                   16686:                             $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.");
                   16687:                         }
                   16688:                     } else {
                   16689:                         $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).");
                   16690:                     }
                   16691:                 } else {
                   16692:                     $otherserver = $userdomserver;
                   16693:                 }
                   16694:             }
                   16695:             if ($otherserver ne '') {
                   16696:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   16697:             }
                   16698:         }
                   16699:     }
                   16700:     return ($switchserver,$warning);
                   16701: }
                   16702: 
                   16703: =pod
                   16704: 
                   16705: =item * &check_release_result()
                   16706: 
                   16707: Inputs:
                   16708: 
                   16709: $switchwarning - Warning message if no suitable server found to host session.
                   16710: 
                   16711: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   16712:                 and current role.
                   16713: 
                   16714: Returns: HTML to display with information about requirement to switch server.
                   16715:          Either displaying warning with link to Roles/Courses screen or
                   16716:          display link to switchserver.
                   16717: 
1.1075.2.69  raeburn  16718: =cut
                   16719: 
1.1075.2.88  raeburn  16720: sub check_release_result {
                   16721:     my ($switchwarning,$switchserver) = @_;
                   16722:     my $output = &start_page('Selected course unavailable on this server').
                   16723:                  '<p class="LC_warning">';
                   16724:     if ($switchwarning) {
                   16725:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   16726:         if (&show_course()) {
                   16727:             $output .= &mt('Display courses');
                   16728:         } else {
                   16729:             $output .= &mt('Display roles');
                   16730:         }
                   16731:         $output .= '</a>';
                   16732:     } elsif ($switchserver) {
                   16733:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   16734:                    '<br />'.
                   16735:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   16736:                    &mt('Switch Server').
                   16737:                    '</a>';
                   16738:     }
                   16739:     $output .= '</p>'.&end_page();
                   16740:     return $output;
                   16741: }
                   16742: 
                   16743: =pod
                   16744: 
                   16745: =item * &needs_coursereinit()
                   16746: 
                   16747: Determine if course contents stored for user's session needs to be
                   16748: refreshed, because content has changed since "Big Hash" last tied.
                   16749: 
                   16750: Check for change is made if time last checked is more than 10 minutes ago
                   16751: (by default).
                   16752: 
                   16753: Inputs:
                   16754: 
                   16755: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16756: 
                   16757: $interval (optional) - Time which may elapse (in s) between last check for content
                   16758:                        change in current course. (default: 600 s).
                   16759: 
                   16760: Returns: an array; first element is:
                   16761: 
                   16762: =over 4
                   16763: 
                   16764: 'switch' - if content updates mean user's session
                   16765:            needs to be switched to a server running a newer LON-CAPA version
                   16766: 
                   16767: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   16768:            on current server hosting user's session
                   16769: 
                   16770: ''       - if no action required.
                   16771: 
                   16772: =back
                   16773: 
                   16774: If first item element is 'switch':
                   16775: 
                   16776: second item is $switchwarning - Warning message if no suitable server found to host session.
                   16777: 
                   16778: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   16779:                               and current role.
                   16780: 
                   16781: otherwise: no other elements returned.
                   16782: 
                   16783: =back
                   16784: 
                   16785: =cut
                   16786: 
                   16787: sub needs_coursereinit {
                   16788:     my ($loncaparev,$interval) = @_;
                   16789:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   16790:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   16791:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   16792:     my $now = time;
                   16793:     if ($interval eq '') {
                   16794:         $interval = 600;
                   16795:     }
                   16796:     if (($now-$env{'request.course.timechecked'})>$interval) {
                   16797:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1075.2.141.  .6(raebu 16798:20):         my $blocked = &blocking_status('reinit',$cnum,$cdom,undef,1);
                   16799:20):         if ($blocked) {
                   16800:20):             return ();
                   16801:20):         }
                   16802:20):         my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
1.1075.2.88  raeburn  16803:         if ($lastchange > $env{'request.course.tied'}) {
                   16804:             my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   16805:             if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   16806:                 my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   16807:                 if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   16808:                     &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   16809:                                              $curr_reqd_hash{'internal.releaserequired'}});
                   16810:                     my ($switchserver,$switchwarning) =
                   16811:                         &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   16812:                                                 $curr_reqd_hash{'internal.releaserequired'});
                   16813:                     if ($switchwarning ne '' || $switchserver ne '') {
                   16814:                         return ('switch',$switchwarning,$switchserver);
                   16815:                     }
                   16816:                 }
                   16817:             }
                   16818:             return ('update');
                   16819:         }
                   16820:     }
                   16821:     return ();
                   16822: }
1.1075.2.69  raeburn  16823: 
1.1075.2.11  raeburn  16824: sub update_content_constraints {
                   16825:     my ($cdom,$cnum,$chome,$cid) = @_;
                   16826:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   16827:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   16828:     my %checkresponsetypes;
                   16829:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   16830:         my ($item,$name,$value) = split(/:/,$key);
                   16831:         if ($item eq 'resourcetag') {
                   16832:             if ($name eq 'responsetype') {
                   16833:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   16834:             }
                   16835:         }
                   16836:     }
                   16837:     my $navmap = Apache::lonnavmaps::navmap->new();
                   16838:     if (defined($navmap)) {
                   16839:         my %allresponses;
                   16840:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
                   16841:             my %responses = $res->responseTypes();
                   16842:             foreach my $key (keys(%responses)) {
                   16843:                 next unless(exists($checkresponsetypes{$key}));
                   16844:                 $allresponses{$key} += $responses{$key};
                   16845:             }
                   16846:         }
                   16847:         foreach my $key (keys(%allresponses)) {
                   16848:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   16849:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   16850:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   16851:             }
                   16852:         }
                   16853:         undef($navmap);
                   16854:     }
                   16855:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   16856:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   16857:     }
                   16858:     return;
                   16859: }
                   16860: 
1.1075.2.27  raeburn  16861: sub allmaps_incourse {
                   16862:     my ($cdom,$cnum,$chome,$cid) = @_;
                   16863:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   16864:         $cid = $env{'request.course.id'};
                   16865:         $cdom = $env{'course.'.$cid.'.domain'};
                   16866:         $cnum = $env{'course.'.$cid.'.num'};
                   16867:         $chome = $env{'course.'.$cid.'.home'};
                   16868:     }
                   16869:     my %allmaps = ();
                   16870:     my $lastchange =
                   16871:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   16872:     if ($lastchange > $env{'request.course.tied'}) {
                   16873:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   16874:         unless ($ferr) {
                   16875:             &update_content_constraints($cdom,$cnum,$chome,$cid);
                   16876:         }
                   16877:     }
                   16878:     my $navmap = Apache::lonnavmaps::navmap->new();
                   16879:     if (defined($navmap)) {
                   16880:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   16881:             $allmaps{$res->src()} = 1;
                   16882:         }
                   16883:     }
                   16884:     return \%allmaps;
                   16885: }
                   16886: 
1.1075.2.11  raeburn  16887: sub parse_supplemental_title {
                   16888:     my ($title) = @_;
                   16889: 
                   16890:     my ($foldertitle,$renametitle);
                   16891:     if ($title =~ /&amp;&amp;&amp;/) {
                   16892:         $title = &HTML::Entites::decode($title);
                   16893:     }
                   16894:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   16895:         $renametitle=$4;
                   16896:         my ($time,$uname,$udom) = ($1,$2,$3);
                   16897:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   16898:         my $name =  &plainname($uname,$udom);
                   16899:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   16900:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
                   16901:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
                   16902:             $name.': <br />'.$foldertitle;
                   16903:     }
                   16904:     if (wantarray) {
                   16905:         return ($title,$foldertitle,$renametitle);
                   16906:     }
                   16907:     return $title;
                   16908: }
                   16909: 
1.1075.2.43  raeburn  16910: sub recurse_supplemental {
                   16911:     my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
                   16912:     if ($suppmap) {
                   16913:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   16914:         if ($fatal) {
                   16915:             $errors ++;
                   16916:         } else {
                   16917:             if ($#LONCAPA::map::resources > 0) {
                   16918:                 foreach my $res (@LONCAPA::map::resources) {
                   16919:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
                   16920:                     if (($src ne '') && ($status eq 'res')) {
1.1075.2.46  raeburn  16921:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
                   16922:                             ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1075.2.43  raeburn  16923:                         } else {
                   16924:                             $numfiles ++;
                   16925:                         }
                   16926:                     }
                   16927:                 }
                   16928:             }
                   16929:         }
                   16930:     }
                   16931:     return ($numfiles,$errors);
                   16932: }
                   16933: 
1.1075.2.18  raeburn  16934: sub symb_to_docspath {
1.1075.2.119  raeburn  16935:     my ($symb,$navmapref) = @_;
                   16936:     return unless ($symb && ref($navmapref));
1.1075.2.18  raeburn  16937:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   16938:     if ($resurl=~/\.(sequence|page)$/) {
                   16939:         $mapurl=$resurl;
                   16940:     } elsif ($resurl eq 'adm/navmaps') {
                   16941:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   16942:     }
                   16943:     my $mapresobj;
1.1075.2.119  raeburn  16944:     unless (ref($$navmapref)) {
                   16945:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   16946:     }
                   16947:     if (ref($$navmapref)) {
                   16948:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1075.2.18  raeburn  16949:     }
                   16950:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   16951:     my $type=$2;
                   16952:     my $path;
                   16953:     if (ref($mapresobj)) {
                   16954:         my $pcslist = $mapresobj->map_hierarchy();
                   16955:         if ($pcslist ne '') {
                   16956:             foreach my $pc (split(/,/,$pcslist)) {
                   16957:                 next if ($pc <= 1);
1.1075.2.119  raeburn  16958:                 my $res = $$navmapref->getByMapPc($pc);
1.1075.2.18  raeburn  16959:                 if (ref($res)) {
                   16960:                     my $thisurl = $res->src();
                   16961:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   16962:                     my $thistitle = $res->title();
                   16963:                     $path .= '&'.
                   16964:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1075.2.46  raeburn  16965:                              &escape($thistitle).
1.1075.2.18  raeburn  16966:                              ':'.$res->randompick().
                   16967:                              ':'.$res->randomout().
                   16968:                              ':'.$res->encrypted().
                   16969:                              ':'.$res->randomorder().
                   16970:                              ':'.$res->is_page();
                   16971:                 }
                   16972:             }
                   16973:         }
                   16974:         $path =~ s/^\&//;
                   16975:         my $maptitle = $mapresobj->title();
                   16976:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  16977:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  16978:         }
                   16979:         $path .= (($path ne '')? '&' : '').
                   16980:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  16981:                  &escape($maptitle).
1.1075.2.18  raeburn  16982:                  ':'.$mapresobj->randompick().
                   16983:                  ':'.$mapresobj->randomout().
                   16984:                  ':'.$mapresobj->encrypted().
                   16985:                  ':'.$mapresobj->randomorder().
                   16986:                  ':'.$mapresobj->is_page();
                   16987:     } else {
                   16988:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   16989:         my $ispage = (($type eq 'page')? 1 : '');
                   16990:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  16991:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  16992:         }
                   16993:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  16994:                 &escape($maptitle).':::::'.$ispage;
1.1075.2.18  raeburn  16995:     }
                   16996:     unless ($mapurl eq 'default') {
                   16997:         $path = 'default&'.
1.1075.2.46  raeburn  16998:                 &escape('Main Content').
1.1075.2.18  raeburn  16999:                 ':::::&'.$path;
                   17000:     }
                   17001:     return $path;
                   17002: }
                   17003: 
1.1075.2.14  raeburn  17004: sub captcha_display {
1.1075.2.137  raeburn  17005:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17006:     my ($output,$error);
1.1075.2.107  raeburn  17007:     my ($captcha,$pubkey,$privkey,$version) =
1.1075.2.137  raeburn  17008:         &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17009:     if ($captcha eq 'original') {
                   17010:         $output = &create_captcha();
                   17011:         unless ($output) {
                   17012:             $error = 'captcha';
                   17013:         }
                   17014:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17015:         $output = &create_recaptcha($pubkey,$version);
1.1075.2.14  raeburn  17016:         unless ($output) {
                   17017:             $error = 'recaptcha';
                   17018:         }
                   17019:     }
1.1075.2.107  raeburn  17020:     return ($output,$error,$captcha,$version);
1.1075.2.14  raeburn  17021: }
                   17022: 
                   17023: sub captcha_response {
1.1075.2.137  raeburn  17024:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17025:     my ($captcha_chk,$captcha_error);
1.1075.2.137  raeburn  17026:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17027:     if ($captcha eq 'original') {
                   17028:         ($captcha_chk,$captcha_error) = &check_captcha();
                   17029:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17030:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1075.2.14  raeburn  17031:     } else {
                   17032:         $captcha_chk = 1;
                   17033:     }
                   17034:     return ($captcha_chk,$captcha_error);
                   17035: }
                   17036: 
                   17037: sub get_captcha_config {
1.1075.2.137  raeburn  17038:     my ($context,$lonhost,$dom_in_effect) = @_;
1.1075.2.107  raeburn  17039:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1075.2.14  raeburn  17040:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   17041:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   17042:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   17043:     if ($context eq 'usercreation') {
                   17044:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   17045:         if (ref($domconfig{$context}) eq 'HASH') {
                   17046:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   17047:             if (ref($hashtocheck) eq 'HASH') {
                   17048:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   17049:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   17050:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   17051:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   17052:                     }
                   17053:                     if ($privkey && $pubkey) {
                   17054:                         $captcha = 'recaptcha';
1.1075.2.107  raeburn  17055:                         $version = $hashtocheck->{'recaptchaversion'};
                   17056:                         if ($version ne '2') {
                   17057:                             $version = 1;
                   17058:                         }
1.1075.2.14  raeburn  17059:                     } else {
                   17060:                         $captcha = 'original';
                   17061:                     }
                   17062:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   17063:                     $captcha = 'original';
                   17064:                 }
                   17065:             }
                   17066:         } else {
                   17067:             $captcha = 'captcha';
                   17068:         }
                   17069:     } elsif ($context eq 'login') {
                   17070:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   17071:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   17072:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   17073:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
                   17074:             if ($privkey && $pubkey) {
                   17075:                 $captcha = 'recaptcha';
1.1075.2.107  raeburn  17076:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   17077:                 if ($version ne '2') {
                   17078:                     $version = 1;
                   17079:                 }
1.1075.2.14  raeburn  17080:             } else {
                   17081:                 $captcha = 'original';
                   17082:             }
                   17083:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   17084:             $captcha = 'original';
                   17085:         }
1.1075.2.137  raeburn  17086:     } elsif ($context eq 'passwords') {
                   17087:         if ($dom_in_effect) {
                   17088:             my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
                   17089:             if ($passwdconf{'captcha'} eq 'recaptcha') {
                   17090:                 if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
                   17091:                     $pubkey = $passwdconf{'recaptchakeys'}{'public'};
                   17092:                     $privkey = $passwdconf{'recaptchakeys'}{'private'};
                   17093:                 }
                   17094:                 if ($privkey && $pubkey) {
                   17095:                     $captcha = 'recaptcha';
                   17096:                     $version = $passwdconf{'recaptchaversion'};
                   17097:                     if ($version ne '2') {
                   17098:                         $version = 1;
                   17099:                     }
                   17100:                 } else {
                   17101:                     $captcha = 'original';
                   17102:                 }
                   17103:             } elsif ($passwdconf{'captcha'} ne 'notused') {
                   17104:                 $captcha = 'original';
                   17105:             }
                   17106:         }
1.1075.2.14  raeburn  17107:     }
1.1075.2.107  raeburn  17108:     return ($captcha,$pubkey,$privkey,$version);
1.1075.2.14  raeburn  17109: }
                   17110: 
                   17111: sub create_captcha {
                   17112:     my %captcha_params = &captcha_settings();
                   17113:     my ($output,$maxtries,$tries) = ('',10,0);
                   17114:     while ($tries < $maxtries) {
                   17115:         $tries ++;
                   17116:         my $captcha = Authen::Captcha->new (
                   17117:                                            output_folder => $captcha_params{'output_dir'},
                   17118:                                            data_folder   => $captcha_params{'db_dir'},
                   17119:                                           );
                   17120:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   17121: 
                   17122:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   17123:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
                   17124:                       &mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1075.2.66  raeburn  17125:                       '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
                   17126:                       '<br />'.
                   17127:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1075.2.14  raeburn  17128:             last;
                   17129:         }
                   17130:     }
                   17131:     return $output;
                   17132: }
                   17133: 
                   17134: sub captcha_settings {
                   17135:     my %captcha_params = (
                   17136:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   17137:                            www_output_dir => "/captchaspool",
                   17138:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   17139:                            numchars       => '5',
                   17140:                          );
                   17141:     return %captcha_params;
                   17142: }
                   17143: 
                   17144: sub check_captcha {
                   17145:     my ($captcha_chk,$captcha_error);
                   17146:     my $code = $env{'form.code'};
                   17147:     my $md5sum = $env{'form.crypt'};
                   17148:     my %captcha_params = &captcha_settings();
                   17149:     my $captcha = Authen::Captcha->new(
                   17150:                       output_folder => $captcha_params{'output_dir'},
                   17151:                       data_folder   => $captcha_params{'db_dir'},
                   17152:                   );
1.1075.2.26  raeburn  17153:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14  raeburn  17154:     my %captcha_hash = (
                   17155:                         0       => 'Code not checked (file error)',
                   17156:                        -1      => 'Failed: code expired',
                   17157:                        -2      => 'Failed: invalid code (not in database)',
                   17158:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   17159:     );
                   17160:     if ($captcha_chk != 1) {
                   17161:         $captcha_error = $captcha_hash{$captcha_chk}
                   17162:     }
                   17163:     return ($captcha_chk,$captcha_error);
                   17164: }
                   17165: 
                   17166: sub create_recaptcha {
1.1075.2.107  raeburn  17167:     my ($pubkey,$version) = @_;
                   17168:     if ($version >= 2) {
                   17169:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>';
                   17170:     } else {
                   17171:         my $use_ssl;
                   17172:         if ($ENV{'SERVER_PORT'} == 443) {
                   17173:             $use_ssl = 1;
                   17174:         }
                   17175:         my $captcha = Captcha::reCAPTCHA->new;
                   17176:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   17177:                $captcha->get_html($pubkey,undef,$use_ssl).
                   17178:                &mt('If the text is hard to read, [_1] will replace them.',
                   17179:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   17180:                '<br /><br />';
                   17181:      }
1.1075.2.14  raeburn  17182: }
                   17183: 
                   17184: sub check_recaptcha {
1.1075.2.107  raeburn  17185:     my ($privkey,$version) = @_;
1.1075.2.14  raeburn  17186:     my $captcha_chk;
1.1075.2.107  raeburn  17187:     if ($version >= 2) {
                   17188:         my $ua = LWP::UserAgent->new;
                   17189:         $ua->timeout(10);
                   17190:         my %info = (
                   17191:                      secret   => $privkey,
                   17192:                      response => $env{'form.g-recaptcha-response'},
                   17193:                      remoteip => $ENV{'REMOTE_ADDR'},
                   17194:                    );
                   17195:         my $response = $ua->post('https://www.google.com/recaptcha/api/siteverify',\%info);
                   17196:         if ($response->is_success)  {
                   17197:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   17198:             if (ref($data) eq 'HASH') {
                   17199:                 if ($data->{'success'}) {
                   17200:                     $captcha_chk = 1;
                   17201:                 }
                   17202:             }
                   17203:         }
                   17204:     } else {
                   17205:         my $captcha = Captcha::reCAPTCHA->new;
                   17206:         my $captcha_result =
                   17207:             $captcha->check_answer(
                   17208:                                     $privkey,
                   17209:                                     $ENV{'REMOTE_ADDR'},
                   17210:                                     $env{'form.recaptcha_challenge_field'},
                   17211:                                     $env{'form.recaptcha_response_field'},
                   17212:                                   );
                   17213:         if ($captcha_result->{is_valid}) {
                   17214:             $captcha_chk = 1;
                   17215:         }
1.1075.2.14  raeburn  17216:     }
                   17217:     return $captcha_chk;
                   17218: }
                   17219: 
1.1075.2.64  raeburn  17220: sub emailusername_info {
1.1075.2.103  raeburn  17221:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1075.2.64  raeburn  17222:     my %titles = &Apache::lonlocal::texthash (
                   17223:                      lastname      => 'Last Name',
                   17224:                      firstname     => 'First Name',
                   17225:                      institution   => 'School/college/university',
                   17226:                      location      => "School's city, state/province, country",
                   17227:                      web           => "School's web address",
                   17228:                      officialemail => 'E-mail address at institution (if different)',
1.1075.2.103  raeburn  17229:                      id            => 'Student/Employee ID',
1.1075.2.64  raeburn  17230:                  );
                   17231:     return (\@fields,\%titles);
                   17232: }
                   17233: 
1.1075.2.56  raeburn  17234: sub cleanup_html {
                   17235:     my ($incoming) = @_;
                   17236:     my $outgoing;
                   17237:     if ($incoming ne '') {
                   17238:         $outgoing = $incoming;
                   17239:         $outgoing =~ s/;/&#059;/g;
                   17240:         $outgoing =~ s/\#/&#035;/g;
                   17241:         $outgoing =~ s/\&/&#038;/g;
                   17242:         $outgoing =~ s/</&#060;/g;
                   17243:         $outgoing =~ s/>/&#062;/g;
                   17244:         $outgoing =~ s/\(/&#040/g;
                   17245:         $outgoing =~ s/\)/&#041;/g;
                   17246:         $outgoing =~ s/"/&#034;/g;
                   17247:         $outgoing =~ s/'/&#039;/g;
                   17248:         $outgoing =~ s/\$/&#036;/g;
                   17249:         $outgoing =~ s{/}{&#047;}g;
                   17250:         $outgoing =~ s/=/&#061;/g;
                   17251:         $outgoing =~ s/\\/&#092;/g
                   17252:     }
                   17253:     return $outgoing;
                   17254: }
                   17255: 
1.1075.2.74  raeburn  17256: # Checks for critical messages and returns a redirect url if one exists.
                   17257: # $interval indicates how often to check for messages.
1.1075.2.141.  .6(raebu 17258:20): # $context is the calling context -- roles, grades, contents, menu or flip.
1.1075.2.74  raeburn  17259: sub critical_redirect {
1.1075.2.141.  .6(raebu 17260:20):     my ($interval,$context) = @_;
1.1075.2.74  raeburn  17261:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1075.2.141.  .6(raebu 17262:20):         if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
                   17263:20):             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   17264:20):             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   17265:20):             my $blocked = &blocking_status('alert',$cnum,$cdom,undef,1);
                   17266:20):             if ($blocked) {
                   17267:20):                 my $checkrole = "cm./$cdom/$cnum";
                   17268:20):                 if ($env{'request.course.sec'} ne '') {
                   17269:20):                     $checkrole .= "/$env{'request.course.sec'}";
                   17270:20):                 }
                   17271:20):                 unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   17272:20):                         ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   17273:20):                     return;
                   17274:20):                 }
                   17275:20):             }
                   17276:20):         }
1.1075.2.74  raeburn  17277:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
                   17278:                                         $env{'user.name'});
                   17279:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
                   17280:         my $redirecturl;
                   17281:         if ($what[0]) {
                   17282:             if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) {
                   17283:                 $redirecturl='/adm/email?critical=display';
                   17284:                 my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   17285:                 return (1, $url);
                   17286:             }
                   17287:         }
                   17288:     }
                   17289:     return ();
                   17290: }
                   17291: 
1.1075.2.64  raeburn  17292: # Use:
                   17293: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   17294: #
                   17295: ##################################################
                   17296: #          password associated functions         #
                   17297: ##################################################
                   17298: sub des_keys {
                   17299:     # Make a new key for DES encryption.
                   17300:     # Each key has two parts which are returned separately.
                   17301:     # Please note:  Each key must be passed through the &hex function
                   17302:     # before it is output to the web browser.  The hex versions cannot
                   17303:     # be used to decrypt.
                   17304:     my @hexstr=('0','1','2','3','4','5','6','7',
                   17305:                 '8','9','a','b','c','d','e','f');
                   17306:     my $lkey='';
                   17307:     for (0..7) {
                   17308:         $lkey.=$hexstr[rand(15)];
                   17309:     }
                   17310:     my $ukey='';
                   17311:     for (0..7) {
                   17312:         $ukey.=$hexstr[rand(15)];
                   17313:     }
                   17314:     return ($lkey,$ukey);
                   17315: }
                   17316: 
                   17317: sub des_decrypt {
                   17318:     my ($key,$cyphertext) = @_;
                   17319:     my $keybin=pack("H16",$key);
                   17320:     my $cypher;
                   17321:     if ($Crypt::DES::VERSION>=2.03) {
                   17322:         $cypher=new Crypt::DES $keybin;
                   17323:     } else {
                   17324:         $cypher=new DES $keybin;
                   17325:     }
1.1075.2.106  raeburn  17326:     my $plaintext='';
                   17327:     my $cypherlength = length($cyphertext);
                   17328:     my $numchunks = int($cypherlength/32);
                   17329:     for (my $j=0; $j<$numchunks; $j++) {
                   17330:         my $start = $j*32;
                   17331:         my $cypherblock = substr($cyphertext,$start,32);
                   17332:         my $chunk =
                   17333:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   17334:         $chunk .=
                   17335:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   17336:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   17337:         $plaintext .= $chunk;
                   17338:     }
1.1075.2.64  raeburn  17339:     return $plaintext;
                   17340: }
                   17341: 
1.1075.2.141.  .5(raebu 17342:20): sub get_requested_shorturls {
          .1(raebu 17343:20):     my ($cdom,$cnum,$navmap) = @_;
                   17344:20):     return unless (ref($navmap));
          .5(raebu 17345:20):     my ($numnew,$errors);
          .1(raebu 17346:20):     my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
                   17347:20):     if (@toshorten) {
                   17348:20):         my (%maps,%resources,%titles);
                   17349:20):         &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
                   17350:20):                                                                'shorturls',$cdom,$cnum);
                   17351:20):         if (keys(%resources)) {
          .5(raebu 17352:20):             my %tocreate;
          .1(raebu 17353:20):             foreach my $item (sort {$a <=> $b} (@toshorten)) {
                   17354:20):                 my $symb = $resources{$item};
                   17355:20):                 if ($symb) {
                   17356:20):                     $tocreate{$cnum.'&'.$symb} = 1;
                   17357:20):                 }
                   17358:20):             }
          .5(raebu 17359:20):             if (keys(%tocreate)) {
                   17360:20):                 ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
                   17361:20):                                                       \%tocreate);
                   17362:20):             }
          .1(raebu 17363:20):         }
          .5(raebu 17364:20):     }
                   17365:20):     return ($numnew,$errors);
                   17366:20): }
                   17367:20): 
                   17368:20): sub make_short_symbs {
                   17369:20):     my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
                   17370:20):     my ($numnew,@errors);
                   17371:20):     if (ref($tocreateref) eq 'HASH') {
                   17372:20):         my %tocreate = %{$tocreateref};
          .1(raebu 17373:20):         if (keys(%tocreate)) {
                   17374:20):             my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
                   17375:20):             my $su = Short::URL->new(no_vowels => 1);
                   17376:20):             my $init = '';
                   17377:20):             my (%newunique,%addcourse,%courseonly,%failed);
                   17378:20):             # get lock on tiny db
                   17379:20):             my $now = time;
          .5(raebu 17380:20):             if ($lockuser eq '') {
                   17381:20):                 $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
                   17382:20):             }
          .1(raebu 17383:20):             my $lockhash = {
          .5(raebu 17384:20):                                 "lock\0$now" => $lockuser,
          .1(raebu 17385:20):                             };
                   17386:20):             my $tries = 0;
                   17387:20):             my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
                   17388:20):             my ($code,$error);
                   17389:20):             while (($gotlock ne 'ok') && ($tries<3)) {
                   17390:20):                 $tries ++;
                   17391:20):                 sleep 1;
                   17392:20):                 $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
                   17393:20):             }
                   17394:20):             if ($gotlock eq 'ok') {
                   17395:20):                 $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
                   17396:20):                                        \%addcourse,\%courseonly,\%failed);
                   17397:20):                 if (keys(%failed)) {
                   17398:20):                     my $numfailed = scalar(keys(%failed));
                   17399:20):                     push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
                   17400:20):                 }
                   17401:20):                 if (keys(%newunique)) {
                   17402:20):                     my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
                   17403:20):                     if ($putres eq 'ok') {
                   17404:20):                         $numnew = scalar(keys(%newunique));
                   17405:20):                         my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
                   17406:20):                         unless ($newputres eq 'ok') {
                   17407:20):                             push(@errors,&mt('error: could not store course look-up of short URLs'));
                   17408:20):                         }
                   17409:20):                     } else {
                   17410:20):                         push(@errors,&mt('error: could not store unique six character URLs'));
                   17411:20):                     }
                   17412:20):                 }
                   17413:20):             }
                   17414:20):         }
                   17415:20):     }
                   17416:20):     return ($numnew,\@errors);
                   17417:20): }
                   17418:20): 
                   17419:20): sub shorten_symbs {
                   17420:20):     my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
                   17421:20):     return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
                   17422:20):                    (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
                   17423:20):                    (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
                   17424:20):     my (%possibles,%collisions);
                   17425:20):     foreach my $key (keys(%{$tocreate})) {
                   17426:20):         my $num = String::CRC32::crc32($key);
                   17427:20):         my $tiny = $su->encode($num,$init);
                   17428:20):         if ($tiny) {
                   17429:20):             $possibles{$tiny} = $key;
                   17430:20):         }
                   17431:20):     }
                   17432:20):     if (!$init) {
                   17433:20):         $init = 1;
                   17434:20):     } else {
                   17435:20):         $init ++;
                   17436:20):     }
                   17437:20):     if (keys(%possibles)) {
                   17438:20):         my @posstiny = keys(%possibles);
                   17439:20):         my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
                   17440:20):         my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
                   17441:20):         if (keys(%currtiny)) {
                   17442:20):             foreach my $key (keys(%currtiny)) {
                   17443:20):                 next if ($currtiny{$key} eq '');
                   17444:20):                 if ($currtiny{$key} eq $possibles{$key}) {
                   17445:20):                     my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
                   17446:20):                     unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   17447:20):                         $courseonly->{$tsymb} = $key;
                   17448:20):                     }
                   17449:20):                 } else {
                   17450:20):                     $collisions{$possibles{$key}} = 1;
                   17451:20):                 }
                   17452:20):                 delete($possibles{$key});
                   17453:20):             }
                   17454:20):         }
                   17455:20):         foreach my $key (keys(%possibles)) {
                   17456:20):             $newunique->{$key} = $possibles{$key};
                   17457:20):             my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
                   17458:20):             unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   17459:20):                 $addcourse->{$tsymb} = $key;
                   17460:20):             }
                   17461:20):         }
                   17462:20):     }
                   17463:20):     if (keys(%collisions)) {
                   17464:20):         if ($init <5) {
                   17465:20):             if (!$init) {
                   17466:20):                 $init = 1;
                   17467:20):             } else {
                   17468:20):                 $init ++;
                   17469:20):             }
                   17470:20):             $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
                   17471:20):                                    $newunique,$addcourse,$courseonly,$failed);
                   17472:20):         } else {
                   17473:20):             foreach my $key (keys(%collisions)) {
                   17474:20):                 $failed->{$key} = 1;
                   17475:20):                 $failed->{$key} = 1;
                   17476:20):             }
                   17477:20):         }
                   17478:20):     }
                   17479:20):     return $init;
                   17480:20): }
                   17481:20): 
1.1075.2.135  raeburn  17482: sub is_nonframeable {
                   17483:     my ($url,$absolute,$hostname,$ip,$nocache) = @_;
                   17484:     my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
                   17485:     return if (($remprotocol eq '') || ($remhost eq ''));
                   17486: 
                   17487:     $remprotocol = lc($remprotocol);
                   17488:     $remhost = lc($remhost);
                   17489:     my $remport = 80;
                   17490:     if ($remprotocol eq 'https') {
                   17491:         $remport = 443;
                   17492:     }
                   17493:     my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
                   17494:     if ($cached) {
                   17495:         unless ($nocache) {
                   17496:             if ($result) {
                   17497:                 return 1;
                   17498:             } else {
                   17499:                 return 0;
                   17500:             }
                   17501:         }
                   17502:     }
                   17503:     my $uselink;
                   17504:     my $request = new HTTP::Request('HEAD',$url);
1.1075.2.141.  .2(raebu 17505:20):     my $ua = LWP::UserAgent->new;
                   17506:20):     $ua->timeout(5);
                   17507:20):     my $response=$ua->request($request);
1.1075.2.135  raeburn  17508:     if ($response->is_success()) {
                   17509:         my $secpolicy = lc($response->header('content-security-policy'));
                   17510:         my $xframeop = lc($response->header('x-frame-options'));
                   17511:         $secpolicy =~ s/^\s+|\s+$//g;
                   17512:         $xframeop =~ s/^\s+|\s+$//g;
                   17513:         if (($secpolicy ne '') || ($xframeop ne '')) {
                   17514:             my $remotehost = $remprotocol.'://'.$remhost;
                   17515:             my ($origin,$protocol,$port);
                   17516:             if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
                   17517:                 $port = $ENV{'SERVER_PORT'};
                   17518:             } else {
                   17519:                 $port = 80;
                   17520:             }
                   17521:             if ($absolute eq '') {
                   17522:                 $protocol = 'http:';
                   17523:                 if ($port == 443) {
                   17524:                     $protocol = 'https:';
                   17525:                 }
                   17526:                 $origin = $protocol.'//'.lc($hostname);
                   17527:             } else {
                   17528:                 $origin = lc($absolute);
                   17529:                 ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
                   17530:             }
                   17531:             if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
                   17532:                 my $framepolicy = $1;
                   17533:                 $framepolicy =~ s/^\s+|\s+$//g;
                   17534:                 my @policies = split(/\s+/,$framepolicy);
                   17535:                 if (@policies) {
                   17536:                     if (grep(/^\Q'none'\E$/,@policies)) {
                   17537:                         $uselink = 1;
                   17538:                     } else {
                   17539:                         $uselink = 1;
                   17540:                         if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
                   17541:                                 (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
                   17542:                                 (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
                   17543:                             undef($uselink);
                   17544:                         }
                   17545:                         if ($uselink) {
                   17546:                             if (grep(/^\Q'self'\E$/,@policies)) {
                   17547:                                 if (($origin ne '') && ($remotehost eq $origin)) {
                   17548:                                     undef($uselink);
                   17549:                                 }
                   17550:                             }
                   17551:                         }
                   17552:                         if ($uselink) {
                   17553:                             my @possok;
                   17554:                             if ($ip ne '') {
                   17555:                                 push(@possok,$ip);
                   17556:                             }
                   17557:                             my $hoststr = '';
                   17558:                             foreach my $part (reverse(split(/\./,$hostname))) {
                   17559:                                 if ($hoststr eq '') {
                   17560:                                     $hoststr = $part;
                   17561:                                 } else {
                   17562:                                     $hoststr = "$part.$hoststr";
                   17563:                                 }
                   17564:                                 if ($hoststr eq $hostname) {
                   17565:                                     push(@possok,$hostname);
                   17566:                                 } else {
                   17567:                                     push(@possok,"*.$hoststr");
                   17568:                                 }
                   17569:                             }
                   17570:                             if (@possok) {
                   17571:                                 foreach my $poss (@possok) {
                   17572:                                     last if (!$uselink);
                   17573:                                     foreach my $policy (@policies) {
                   17574:                                         if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
                   17575:                                             undef($uselink);
                   17576:                                             last;
                   17577:                                         }
                   17578:                                     }
                   17579:                                 }
                   17580:                             }
                   17581:                         }
                   17582:                     }
                   17583:                 }
                   17584:             } elsif ($xframeop ne '') {
                   17585:                 $uselink = 1;
                   17586:                 my @policies = split(/\s*,\s*/,$xframeop);
                   17587:                 if (@policies) {
                   17588:                     unless (grep(/^deny$/,@policies)) {
                   17589:                         if ($origin ne '') {
                   17590:                             if (grep(/^sameorigin$/,@policies)) {
                   17591:                                 if ($remotehost eq $origin) {
                   17592:                                     undef($uselink);
                   17593:                                 }
                   17594:                             }
                   17595:                             if ($uselink) {
                   17596:                                 foreach my $policy (@policies) {
                   17597:                                     if ($policy =~ /^allow-from\s*(.+)$/) {
                   17598:                                         my $allowfrom = $1;
                   17599:                                         if (($allowfrom ne '') && ($allowfrom eq $origin)) {
                   17600:                                             undef($uselink);
                   17601:                                             last;
                   17602:                                         }
                   17603:                                     }
                   17604:                                 }
                   17605:                             }
                   17606:                         }
                   17607:                     }
                   17608:                 }
                   17609:             }
                   17610:         }
                   17611:     }
                   17612:     if ($nocache) {
                   17613:         if ($cached) {
                   17614:             my $devalidate;
                   17615:             if ($uselink && !$result) {
                   17616:                 $devalidate = 1;
                   17617:             } elsif (!$uselink && $result) {
                   17618:                 $devalidate = 1;
                   17619:             }
                   17620:             if ($devalidate) {
                   17621:                 &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
                   17622:             }
                   17623:         }
                   17624:     } else {
                   17625:         if ($uselink) {
                   17626:             $result = 1;
                   17627:         } else {
                   17628:             $result = 0;
                   17629:         }
                   17630:         &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
                   17631:     }
                   17632:     return $uselink;
                   17633: }
                   17634: 
1.112     bowersj2 17635: 1;
                   17636: __END__;
1.41      ng       17637: 

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