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

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.156! raeburn     4: # $Id: loncommon.pm,v 1.1075.2.153 2021/03/04 01:45:46 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.117     www        86: 
1.517     raeburn    87: # ---------------------------------------------- Designs
                     88: use vars qw(%defaultdesign);
                     89: 
1.22      www        90: my $readit;
                     91: 
1.517     raeburn    92: 
1.157     matthew    93: ##
                     94: ## Global Variables
                     95: ##
1.46      matthew    96: 
1.643     foxr       97: 
                     98: # ----------------------------------------------- SSI with retries:
                     99: #
                    100: 
                    101: =pod
                    102: 
1.648     raeburn   103: =head1 Server Side include with retries:
1.643     foxr      104: 
                    105: =over 4
                    106: 
1.648     raeburn   107: =item * &ssi_with_retries(resource,retries form)
1.643     foxr      108: 
                    109: Performs an ssi with some number of retries.  Retries continue either
                    110: until the result is ok or until the retry count supplied by the
                    111: caller is exhausted.  
                    112: 
                    113: Inputs:
1.648     raeburn   114: 
                    115: =over 4
                    116: 
1.643     foxr      117: resource   - Identifies the resource to insert.
1.648     raeburn   118: 
1.643     foxr      119: retries    - Count of the number of retries allowed.
1.648     raeburn   120: 
1.643     foxr      121: form       - Hash that identifies the rendering options.
                    122: 
1.648     raeburn   123: =back
                    124: 
                    125: Returns:
                    126: 
                    127: =over 4
                    128: 
1.643     foxr      129: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   130: 
1.643     foxr      131: response   - The response from the last attempt (which may or may not have been successful.
                    132: 
1.648     raeburn   133: =back
                    134: 
                    135: =back
                    136: 
1.643     foxr      137: =cut
                    138: 
                    139: sub ssi_with_retries {
                    140:     my ($resource, $retries, %form) = @_;
                    141: 
                    142: 
                    143:     my $ok = 0;			# True if we got a good response.
                    144:     my $content;
                    145:     my $response;
                    146: 
                    147:     # Try to get the ssi done. within the retries count:
                    148: 
                    149:     do {
                    150: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    151: 	$ok      = $response->is_success;
1.650     www       152:         if (!$ok) {
                    153:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    154:         }
1.643     foxr      155: 	$retries--;
                    156:     } while (!$ok && ($retries > 0));
                    157: 
                    158:     if (!$ok) {
                    159: 	$content = '';		# On error return an empty content.
                    160:     }
                    161:     return ($content, $response);
                    162: 
                    163: }
                    164: 
                    165: 
                    166: 
1.20      www       167: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  168: my %language;
1.124     www       169: my %supported_language;
1.1048    foxr      170: my %latex_language;		# For choosing hyphenation in <transl..>
                    171: my %latex_language_bykey;	# for choosing hyphenation from metadata
1.12      harris41  172: my %cprtag;
1.192     taceyjo1  173: my %scprtag;
1.351     www       174: my %fe; my %fd; my %fm;
1.41      ng        175: my %category_extensions;
1.12      harris41  176: 
1.46      matthew   177: # ---------------------------------------------- Thesaurus variables
1.144     matthew   178: #
                    179: # %Keywords:
                    180: #      A hash used by &keyword to determine if a word is considered a keyword.
                    181: # $thesaurus_db_file 
                    182: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   183: 
                    184: my %Keywords;
                    185: my $thesaurus_db_file;
                    186: 
1.144     matthew   187: #
                    188: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    189: # thesaurus.tab, and filecategories.tab.
                    190: #
1.18      www       191: BEGIN {
1.46      matthew   192:     # Variable initialization
                    193:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    194:     #
1.22      www       195:     unless ($readit) {
1.12      harris41  196: # ------------------------------------------------------------------- languages
                    197:     {
1.158     raeburn   198:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    199:                                    '/language.tab';
1.1075.2.128  raeburn   200:         if ( open(my $fh,'<',$langtabfile) ) {
1.356     albertel  201:             while (my $line = <$fh>) {
                    202:                 next if ($line=~/^\#/);
                    203:                 chomp($line);
1.1048    foxr      204:                 my ($key,$two,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158     raeburn   205:                 $language{$key}=$val.' - '.$enc;
                    206:                 if ($sup) {
                    207:                     $supported_language{$key}=$sup;
                    208:                 }
1.1048    foxr      209: 		if ($latex) {
                    210: 		    $latex_language_bykey{$key} = $latex;
                    211: 		    $latex_language{$two} = $latex;
                    212: 		}
1.158     raeburn   213:             }
                    214:             close($fh);
                    215:         }
1.12      harris41  216:     }
                    217: # ------------------------------------------------------------------ copyrights
                    218:     {
1.158     raeburn   219:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    220:                                   '/copyright.tab';
1.1075.2.128  raeburn   221:         if ( open (my $fh,'<',$copyrightfile) ) {
1.356     albertel  222:             while (my $line = <$fh>) {
                    223:                 next if ($line=~/^\#/);
                    224:                 chomp($line);
                    225:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   226:                 $cprtag{$key}=$val;
                    227:             }
                    228:             close($fh);
                    229:         }
1.12      harris41  230:     }
1.351     www       231: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  232:     {
                    233:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    234:                                   '/source_copyright.tab';
1.1075.2.128  raeburn   235:         if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356     albertel  236:             while (my $line = <$fh>) {
                    237:                 next if ($line =~ /^\#/);
                    238:                 chomp($line);
                    239:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  240:                 $scprtag{$key}=$val;
                    241:             }
                    242:             close($fh);
                    243:         }
                    244:     }
1.63      www       245: 
1.517     raeburn   246: # -------------------------------------------------------------- default domain designs
1.63      www       247:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   248:     my $designfile = $designdir.'/default.tab';
1.1075.2.128  raeburn   249:     if ( open (my $fh,'<',$designfile) ) {
1.517     raeburn   250:         while (my $line = <$fh>) {
                    251:             next if ($line =~ /^\#/);
                    252:             chomp($line);
                    253:             my ($key,$val)=(split(/\=/,$line));
                    254:             if ($val) { $defaultdesign{$key}=$val; }
                    255:         }
                    256:         close($fh);
1.63      www       257:     }
                    258: 
1.15      harris41  259: # ------------------------------------------------------------- file categories
                    260:     {
1.158     raeburn   261:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    262:                                   '/filecategories.tab';
1.1075.2.128  raeburn   263:         if ( open (my $fh,'<',$categoryfile) ) {
1.356     albertel  264: 	    while (my $line = <$fh>) {
                    265: 		next if ($line =~ /^\#/);
                    266: 		chomp($line);
                    267:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.1075.2.119  raeburn   268:                 push(@{$category_extensions{lc($category)}},$extension);
1.158     raeburn   269:             }
                    270:             close($fh);
                    271:         }
                    272: 
1.15      harris41  273:     }
1.12      harris41  274: # ------------------------------------------------------------------ file types
                    275:     {
1.158     raeburn   276:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    277:                '/filetypes.tab';
1.1075.2.128  raeburn   278:         if ( open (my $fh,'<',$typesfile) ) {
1.356     albertel  279:             while (my $line = <$fh>) {
                    280: 		next if ($line =~ /^\#/);
                    281: 		chomp($line);
                    282:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   283:                 if ($descr ne '') {
                    284:                     $fe{$ending}=lc($emb);
                    285:                     $fd{$ending}=$descr;
1.351     www       286:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   287:                 }
                    288:             }
                    289:             close($fh);
                    290:         }
1.12      harris41  291:     }
1.22      www       292:     &Apache::lonnet::logthis(
1.705     tempelho  293:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       294:     $readit=1;
1.46      matthew   295:     }  # end of unless($readit) 
1.32      matthew   296:     
                    297: }
1.112     bowersj2  298: 
1.42      matthew   299: ###############################################################
                    300: ##           HTML and Javascript Helper Functions            ##
                    301: ###############################################################
                    302: 
                    303: =pod 
                    304: 
1.112     bowersj2  305: =head1 HTML and Javascript Functions
1.42      matthew   306: 
1.112     bowersj2  307: =over 4
                    308: 
1.648     raeburn   309: =item * &browser_and_searcher_javascript()
1.112     bowersj2  310: 
                    311: X<browsing, javascript>X<searching, javascript>Returns a string
                    312: containing javascript with two functions, C<openbrowser> and
                    313: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    314: tags.
1.42      matthew   315: 
1.648     raeburn   316: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   317: 
                    318: inputs: formname, elementname, only, omit
                    319: 
                    320: formname and elementname indicate the name of the html form and name of
                    321: the element that the results of the browsing selection are to be placed in. 
                    322: 
                    323: Specifying 'only' will restrict the browser to displaying only files
1.185     www       324: with the given extension.  Can be a comma separated list.
1.42      matthew   325: 
                    326: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       327: with the given extension.  Can be a comma separated list.
1.42      matthew   328: 
1.648     raeburn   329: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   330: 
                    331: Inputs: formname, elementname
                    332: 
                    333: formname and elementname specify the name of the html form and the name
                    334: of the element the selection from the search results will be placed in.
1.542     raeburn   335: 
1.42      matthew   336: =cut
                    337: 
                    338: sub browser_and_searcher_javascript {
1.199     albertel  339:     my ($mode)=@_;
                    340:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  341:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   342:     return <<END;
1.219     albertel  343: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   344:     var editbrowser = null;
1.135     albertel  345:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       346:         var url = '$resurl/?';
1.42      matthew   347:         if (editbrowser == null) {
                    348:             url += 'launch=1&';
                    349:         }
                    350:         url += 'catalogmode=interactive&';
1.199     albertel  351:         url += 'mode=$mode&';
1.611     albertel  352:         url += 'inhibitmenu=yes&';
1.42      matthew   353:         url += 'form=' + formname + '&';
                    354:         if (only != null) {
                    355:             url += 'only=' + only + '&';
1.217     albertel  356:         } else {
                    357:             url += 'only=&';
                    358: 	}
1.42      matthew   359:         if (omit != null) {
                    360:             url += 'omit=' + omit + '&';
1.217     albertel  361:         } else {
                    362:             url += 'omit=&';
                    363: 	}
1.135     albertel  364:         if (titleelement != null) {
                    365:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  366:         } else {
                    367: 	    url += 'titleelement=&';
                    368: 	}
1.42      matthew   369:         url += 'element=' + elementname + '';
                    370:         var title = 'Browser';
1.435     albertel  371:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   372:         options += ',width=700,height=600';
                    373:         editbrowser = open(url,title,options,'1');
                    374:         editbrowser.focus();
                    375:     }
                    376:     var editsearcher;
1.135     albertel  377:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   378:         var url = '/adm/searchcat?';
                    379:         if (editsearcher == null) {
                    380:             url += 'launch=1&';
                    381:         }
                    382:         url += 'catalogmode=interactive&';
1.199     albertel  383:         url += 'mode=$mode&';
1.42      matthew   384:         url += 'form=' + formname + '&';
1.135     albertel  385:         if (titleelement != null) {
                    386:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  387:         } else {
                    388: 	    url += 'titleelement=&';
                    389: 	}
1.42      matthew   390:         url += 'element=' + elementname + '';
                    391:         var title = 'Search';
1.435     albertel  392:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   393:         options += ',width=700,height=600';
                    394:         editsearcher = open(url,title,options,'1');
                    395:         editsearcher.focus();
                    396:     }
1.219     albertel  397: // END LON-CAPA Internal -->
1.42      matthew   398: END
1.170     www       399: }
                    400: 
                    401: sub lastresurl {
1.258     albertel  402:     if ($env{'environment.lastresurl'}) {
                    403: 	return $env{'environment.lastresurl'}
1.170     www       404:     } else {
                    405: 	return '/res';
                    406:     }
                    407: }
                    408: 
                    409: sub storeresurl {
                    410:     my $resurl=&Apache::lonnet::clutter(shift);
                    411:     unless ($resurl=~/^\/res/) { return 0; }
                    412:     $resurl=~s/\/$//;
                    413:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   414:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       415:     return 1;
1.42      matthew   416: }
                    417: 
1.74      www       418: sub studentbrowser_javascript {
1.111     www       419:    unless (
1.258     albertel  420:             (($env{'request.course.id'}) && 
1.302     albertel  421:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    422: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    423: 					  '/'.$env{'request.course.sec'})
                    424: 	      ))
1.258     albertel  425:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       426:           ) { return ''; }  
1.74      www       427:    return (<<'ENDSTDBRW');
1.776     bisitz    428: <script type="text/javascript" language="Javascript">
1.824     bisitz    429: // <![CDATA[
1.74      www       430:     var stdeditbrowser;
1.1075.2.143  raeburn   431:     function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadv) {
1.74      www       432:         var url = '/adm/pickstudent?';
                    433:         var filter;
1.558     albertel  434: 	if (!ignorefilter) {
                    435: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    436: 	}
1.74      www       437:         if (filter != null) {
                    438:            if (filter != '') {
                    439:                url += 'filter='+filter+'&';
                    440: 	   }
                    441:         }
                    442:         url += 'form=' + formname + '&unameelement='+uname+
1.999     www       443:                                     '&udomelement='+udom+
                    444:                                     '&clicker='+clicker;
1.111     www       445: 	if (roleflag) { url+="&roles=1"; }
1.1075.2.143  raeburn   446:         if (courseadv == 'condition') {
                    447:             if (document.getElementById('courseadv')) {
                    448:                 courseadv = document.getElementById('courseadv').value;
                    449:             }
                    450:         }
                    451:         if ((courseadv == 'only') || (courseadv == 'none')) { url+="&courseadv="+courseadv; }
1.102     www       452:         var title = 'Student_Browser';
1.74      www       453:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    454:         options += ',width=700,height=600';
                    455:         stdeditbrowser = open(url,title,options,'1');
                    456:         stdeditbrowser.focus();
                    457:     }
1.824     bisitz    458: // ]]>
1.74      www       459: </script>
                    460: ENDSTDBRW
                    461: }
1.42      matthew   462: 
1.1003    www       463: sub resourcebrowser_javascript {
                    464:    unless ($env{'request.course.id'}) { return ''; }
1.1004    www       465:    return (<<'ENDRESBRW');
1.1003    www       466: <script type="text/javascript" language="Javascript">
                    467: // <![CDATA[
                    468:     var reseditbrowser;
1.1004    www       469:     function openresbrowser(formname,reslink) {
1.1005    www       470:         var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003    www       471:         var title = 'Resource_Browser';
                    472:         var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005    www       473:         options += ',width=700,height=500';
1.1004    www       474:         reseditbrowser = open(url,title,options,'1');
                    475:         reseditbrowser.focus();
1.1003    www       476:     }
                    477: // ]]>
                    478: </script>
1.1004    www       479: ENDRESBRW
1.1003    www       480: }
                    481: 
1.74      www       482: sub selectstudent_link {
1.1075.2.143  raeburn   483:    my ($form,$unameele,$udomele,$courseadv,$clickerid)=@_;
1.999     www       484:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    485:                       &Apache::lonhtmlcommon::entity_encode($unameele)."','".
                    486:                       &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258     albertel  487:    if ($env{'request.course.id'}) {  
1.302     albertel  488:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    489: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    490: 					'/'.$env{'request.course.sec'})) {
1.111     www       491: 	   return '';
                    492:        }
1.999     www       493:        $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.1075.2.143  raeburn   494:        if ($courseadv eq 'only') {
                    495:            $callargs .= ",'',1,'$courseadv'";
                    496:        } elsif ($courseadv eq 'none') {
                    497:            $callargs .= ",'','','$courseadv'";
                    498:        } elsif ($courseadv eq 'condition') {
                    499:            $callargs .= ",'','','$courseadv'";
1.793     raeburn   500:        }
                    501:        return '<span class="LC_nobreak">'.
                    502:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    503:               &mt('Select User').'</a></span>';
1.74      www       504:    }
1.258     albertel  505:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012    www       506:        $callargs .= ",'',1"; 
1.793     raeburn   507:        return '<span class="LC_nobreak">'.
                    508:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    509:               &mt('Select User').'</a></span>';
1.111     www       510:    }
                    511:    return '';
1.91      www       512: }
                    513: 
1.1004    www       514: sub selectresource_link {
                    515:    my ($form,$reslink,$arg)=@_;
                    516:    
                    517:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    518:                       &Apache::lonhtmlcommon::entity_encode($reslink)."'";
                    519:    unless ($env{'request.course.id'}) { return $arg; }
                    520:    return '<span class="LC_nobreak">'.
                    521:               '<a href="javascript:openresbrowser('.$callargs.');">'.
                    522:               $arg.'</a></span>';
                    523: }
                    524: 
                    525: 
                    526: 
1.653     raeburn   527: sub authorbrowser_javascript {
                    528:     return <<"ENDAUTHORBRW";
1.776     bisitz    529: <script type="text/javascript" language="JavaScript">
1.824     bisitz    530: // <![CDATA[
1.653     raeburn   531: var stdeditbrowser;
                    532: 
                    533: function openauthorbrowser(formname,udom) {
                    534:     var url = '/adm/pickauthor?';
                    535:     url += 'form='+formname+'&roledom='+udom;
                    536:     var title = 'Author_Browser';
                    537:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    538:     options += ',width=700,height=600';
                    539:     stdeditbrowser = open(url,title,options,'1');
                    540:     stdeditbrowser.focus();
                    541: }
                    542: 
1.824     bisitz    543: // ]]>
1.653     raeburn   544: </script>
                    545: ENDAUTHORBRW
                    546: }
                    547: 
1.91      www       548: sub coursebrowser_javascript {
1.1075.2.31  raeburn   549:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1075.2.95  raeburn   550:         $credits_element,$instcode) = @_;
1.932     raeburn   551:     my $wintitle = 'Course_Browser';
1.931     raeburn   552:     if ($crstype eq 'Community') {
1.932     raeburn   553:         $wintitle = 'Community_Browser';
1.909     raeburn   554:     }
1.876     raeburn   555:     my $id_functions = &javascript_index_functions();
                    556:     my $output = '
1.776     bisitz    557: <script type="text/javascript" language="JavaScript">
1.824     bisitz    558: // <![CDATA[
1.468     raeburn   559:     var stdeditbrowser;'."\n";
1.876     raeburn   560: 
                    561:     $output .= <<"ENDSTDBRW";
1.909     raeburn   562:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       563:         var url = '/adm/pickcourse?';
1.895     raeburn   564:         var formid = getFormIdByName(formname);
1.876     raeburn   565:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  566:         if (domainfilter != null) {
                    567:            if (domainfilter != '') {
                    568:                url += 'domainfilter='+domainfilter+'&';
                    569: 	   }
                    570:         }
1.91      www       571:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  572: 	                            '&cdomelement='+udom+
                    573:                                     '&cnameelement='+desc;
1.468     raeburn   574:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   575:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   576:                 url += '&roleelement='+extra_element;
                    577:                 if (domainfilter == null || domainfilter == '') {
                    578:                     url += '&domainfilter='+extra_element;
                    579:                 }
1.234     raeburn   580:             }
1.468     raeburn   581:             else {
                    582:                 if (formname == 'portform') {
                    583:                     url += '&setroles='+extra_element;
1.800     raeburn   584:                 } else {
                    585:                     if (formname == 'rules') {
                    586:                         url += '&fixeddom='+extra_element; 
                    587:                     }
1.468     raeburn   588:                 }
                    589:             }     
1.230     raeburn   590:         }
1.909     raeburn   591:         if (type != null && type != '') {
                    592:             url += '&type='+type;
                    593:         }
                    594:         if (type_elem != null && type_elem != '') {
                    595:             url += '&typeelement='+type_elem;
                    596:         }
1.872     raeburn   597:         if (formname == 'ccrs') {
                    598:             var ownername = document.forms[formid].ccuname.value;
                    599:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1075.2.101  raeburn   600:             url += '&cloner='+ownername+':'+ownerdom;
                    601:             if (type == 'Course') {
                    602:                 url += '&crscode='+document.forms[formid].crscode.value;
                    603:             }
1.1075.2.95  raeburn   604:         }
                    605:         if (formname == 'requestcrs') {
                    606:             url += '&crsdom=$domainfilter&crscode=$instcode';
1.872     raeburn   607:         }
1.293     raeburn   608:         if (multflag !=null && multflag != '') {
                    609:             url += '&multiple='+multflag;
                    610:         }
1.909     raeburn   611:         var title = '$wintitle';
1.91      www       612:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    613:         options += ',width=700,height=600';
                    614:         stdeditbrowser = open(url,title,options,'1');
                    615:         stdeditbrowser.focus();
                    616:     }
1.876     raeburn   617: $id_functions
                    618: ENDSTDBRW
1.1075.2.31  raeburn   619:     if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
                    620:         $output .= &setsec_javascript($sec_element,$formname,$role_element,
                    621:                                       $credits_element);
1.876     raeburn   622:     }
                    623:     $output .= '
                    624: // ]]>
                    625: </script>';
                    626:     return $output;
                    627: }
                    628: 
                    629: sub javascript_index_functions {
                    630:     return <<"ENDJS";
                    631: 
                    632: function getFormIdByName(formname) {
                    633:     for (var i=0;i<document.forms.length;i++) {
                    634:         if (document.forms[i].name == formname) {
                    635:             return i;
                    636:         }
                    637:     }
                    638:     return -1;
                    639: }
                    640: 
                    641: function getIndexByName(formid,item) {
                    642:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    643:         if (document.forms[formid].elements[i].name == item) {
                    644:             return i;
                    645:         }
                    646:     }
                    647:     return -1;
                    648: }
1.468     raeburn   649: 
1.876     raeburn   650: function getDomainFromSelectbox(formname,udom) {
                    651:     var userdom;
                    652:     var formid = getFormIdByName(formname);
                    653:     if (formid > -1) {
                    654:         var domid = getIndexByName(formid,udom);
                    655:         if (domid > -1) {
                    656:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    657:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    658:             }
                    659:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    660:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   661:             }
                    662:         }
                    663:     }
1.876     raeburn   664:     return userdom;
                    665: }
                    666: 
                    667: ENDJS
1.468     raeburn   668: 
1.876     raeburn   669: }
                    670: 
1.1017    raeburn   671: sub javascript_array_indexof {
1.1018    raeburn   672:     return <<ENDJS;
1.1017    raeburn   673: <script type="text/javascript" language="JavaScript">
                    674: // <![CDATA[
                    675: 
                    676: if (!Array.prototype.indexOf) {
                    677:     Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
                    678:         "use strict";
                    679:         if (this === void 0 || this === null) {
                    680:             throw new TypeError();
                    681:         }
                    682:         var t = Object(this);
                    683:         var len = t.length >>> 0;
                    684:         if (len === 0) {
                    685:             return -1;
                    686:         }
                    687:         var n = 0;
                    688:         if (arguments.length > 0) {
                    689:             n = Number(arguments[1]);
                    690:             if (n !== n) { // shortcut for verifying if it's NaN
                    691:                 n = 0;
                    692:             } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
                    693:                 n = (n > 0 || -1) * Math.floor(Math.abs(n));
                    694:             }
                    695:         }
                    696:         if (n >= len) {
                    697:             return -1;
                    698:         }
                    699:         var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
                    700:         for (; k < len; k++) {
                    701:             if (k in t && t[k] === searchElement) {
                    702:                 return k;
                    703:             }
                    704:         }
                    705:         return -1;
                    706:     }
                    707: }
                    708: 
                    709: // ]]>
                    710: </script>
                    711: 
                    712: ENDJS
                    713: 
                    714: }
                    715: 
1.876     raeburn   716: sub userbrowser_javascript {
                    717:     my $id_functions = &javascript_index_functions();
                    718:     return <<"ENDUSERBRW";
                    719: 
1.888     raeburn   720: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   721:     var url = '/adm/pickuser?';
                    722:     var userdom = getDomainFromSelectbox(formname,udom);
                    723:     if (userdom != null) {
                    724:        if (userdom != '') {
                    725:            url += 'srchdom='+userdom+'&';
                    726:        }
                    727:     }
                    728:     url += 'form=' + formname + '&unameelement='+uname+
                    729:                                 '&udomelement='+udom+
                    730:                                 '&ulastelement='+ulast+
                    731:                                 '&ufirstelement='+ufirst+
                    732:                                 '&uemailelement='+uemail+
1.881     raeburn   733:                                 '&hideudomelement='+hideudom+
                    734:                                 '&coursedom='+crsdom;
1.888     raeburn   735:     if ((caller != null) && (caller != undefined)) {
                    736:         url += '&caller='+caller;
                    737:     }
1.876     raeburn   738:     var title = 'User_Browser';
                    739:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    740:     options += ',width=700,height=600';
                    741:     var stdeditbrowser = open(url,title,options,'1');
                    742:     stdeditbrowser.focus();
                    743: }
                    744: 
1.888     raeburn   745: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   746:     var formid = getFormIdByName(formname);
                    747:     if (formid > -1) {
1.888     raeburn   748:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   749:         var domid = getIndexByName(formid,udom);
                    750:         var hidedomid = getIndexByName(formid,origdom);
                    751:         if (hidedomid > -1) {
                    752:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   753:             var unameval = document.forms[formid].elements[unameid].value;
                    754:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    755:                 if (domid > -1) {
                    756:                     var slct = document.forms[formid].elements[domid];
                    757:                     if (slct.type == 'select-one') {
                    758:                         var i;
                    759:                         for (i=0;i<slct.length;i++) {
                    760:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    761:                         }
                    762:                     }
                    763:                     if (slct.type == 'hidden') {
                    764:                         slct.value = fixeddom;
1.876     raeburn   765:                     }
                    766:                 }
1.468     raeburn   767:             }
                    768:         }
                    769:     }
1.876     raeburn   770:     return;
                    771: }
                    772: 
                    773: $id_functions
                    774: ENDUSERBRW
1.468     raeburn   775: }
                    776: 
                    777: sub setsec_javascript {
1.1075.2.31  raeburn   778:     my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905     raeburn   779:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    780:         $communityrolestr);
                    781:     if ($role_element ne '') {
                    782:         my @allroles = ('st','ta','ep','in','ad');
                    783:         foreach my $crstype ('Course','Community') {
                    784:             if ($crstype eq 'Community') {
                    785:                 foreach my $role (@allroles) {
                    786:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    787:                 }
                    788:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    789:             } else {
                    790:                 foreach my $role (@allroles) {
                    791:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    792:                 }
                    793:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    794:             }
                    795:         }
                    796:         $rolestr = '"'.join('","',@allroles).'"';
                    797:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    798:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    799:     }
1.468     raeburn   800:     my $setsections = qq|
                    801: function setSect(sectionlist) {
1.629     raeburn   802:     var sectionsArray = new Array();
                    803:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    804:         sectionsArray = sectionlist.split(",");
                    805:     }
1.468     raeburn   806:     var numSections = sectionsArray.length;
                    807:     document.$formname.$sec_element.length = 0;
                    808:     if (numSections == 0) {
                    809:         document.$formname.$sec_element.multiple=false;
                    810:         document.$formname.$sec_element.size=1;
                    811:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    812:     } else {
                    813:         if (numSections == 1) {
                    814:             document.$formname.$sec_element.multiple=false;
                    815:             document.$formname.$sec_element.size=1;
                    816:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    817:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    818:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    819:         } else {
                    820:             for (var i=0; i<numSections; i++) {
                    821:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    822:             }
                    823:             document.$formname.$sec_element.multiple=true
                    824:             if (numSections < 3) {
                    825:                 document.$formname.$sec_element.size=numSections;
                    826:             } else {
                    827:                 document.$formname.$sec_element.size=3;
                    828:             }
                    829:             document.$formname.$sec_element.options[0].selected = false
                    830:         }
                    831:     }
1.91      www       832: }
1.905     raeburn   833: 
                    834: function setRole(crstype) {
1.468     raeburn   835: |;
1.905     raeburn   836:     if ($role_element eq '') {
                    837:         $setsections .= '    return;
                    838: }
                    839: ';
                    840:     } else {
                    841:         $setsections .= qq|
                    842:     var elementLength = document.$formname.$role_element.length;
                    843:     var allroles = Array($rolestr);
                    844:     var courserolenames = Array($courserolestr);
                    845:     var communityrolenames = Array($communityrolestr);
                    846:     if (elementLength != undefined) {
                    847:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    848:             if (crstype == 'Course') {
                    849:                 return;
                    850:             } else {
                    851:                 allroles[5] = 'co';
                    852:                 for (var i=0; i<6; i++) {
                    853:                     document.$formname.$role_element.options[i].value = allroles[i];
                    854:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    855:                 }
                    856:             }
                    857:         } else {
                    858:             if (crstype == 'Community') {
                    859:                 return;
                    860:             } else {
                    861:                 allroles[5] = 'cc';
                    862:                 for (var i=0; i<6; i++) {
                    863:                     document.$formname.$role_element.options[i].value = allroles[i];
                    864:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    865:                 }
                    866:             }
                    867:         }
                    868:     }
                    869:     return;
                    870: }
                    871: |;
                    872:     }
1.1075.2.31  raeburn   873:     if ($credits_element) {
                    874:         $setsections .= qq|
                    875: function setCredits(defaultcredits) {
                    876:     document.$formname.$credits_element.value = defaultcredits;
                    877:     return;
                    878: }
                    879: |;
                    880:     }
1.468     raeburn   881:     return $setsections;
                    882: }
                    883: 
1.91      www       884: sub selectcourse_link {
1.909     raeburn   885:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    886:        $typeelement) = @_;
                    887:    my $type = $selecttype;
1.871     raeburn   888:    my $linktext = &mt('Select Course');
                    889:    if ($selecttype eq 'Community') {
1.909     raeburn   890:        $linktext = &mt('Select Community');
1.906     raeburn   891:    } elsif ($selecttype eq 'Course/Community') {
                    892:        $linktext = &mt('Select Course/Community');
1.909     raeburn   893:        $type = '';
1.1019    raeburn   894:    } elsif ($selecttype eq 'Select') {
                    895:        $linktext = &mt('Select');
                    896:        $type = '';
1.871     raeburn   897:    }
1.787     bisitz    898:    return '<span class="LC_nobreak">'
                    899:          ."<a href='"
                    900:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    901:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   902:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   903:          ."'>".$linktext.'</a>'
1.787     bisitz    904:          .'</span>';
1.74      www       905: }
1.42      matthew   906: 
1.653     raeburn   907: sub selectauthor_link {
                    908:    my ($form,$udom)=@_;
                    909:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    910:           &mt('Select Author').'</a>';
                    911: }
                    912: 
1.876     raeburn   913: sub selectuser_link {
1.881     raeburn   914:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   915:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   916:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   917:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   918:            ');">'.$linktext.'</a>';
1.876     raeburn   919: }
                    920: 
1.273     raeburn   921: sub check_uncheck_jscript {
                    922:     my $jscript = <<"ENDSCRT";
                    923: function checkAll(field) {
                    924:     if (field.length > 0) {
                    925:         for (i = 0; i < field.length; i++) {
1.1075.2.14  raeburn   926:             if (!field[i].disabled) {
                    927:                 field[i].checked = true;
                    928:             }
1.273     raeburn   929:         }
                    930:     } else {
1.1075.2.14  raeburn   931:         if (!field.disabled) {
                    932:             field.checked = true;
                    933:         }
1.273     raeburn   934:     }
                    935: }
                    936:  
                    937: function uncheckAll(field) {
                    938:     if (field.length > 0) {
                    939:         for (i = 0; i < field.length; i++) {
                    940:             field[i].checked = false ;
1.543     albertel  941:         }
                    942:     } else {
1.273     raeburn   943:         field.checked = false ;
                    944:     }
                    945: }
                    946: ENDSCRT
                    947:     return $jscript;
                    948: }
                    949: 
1.656     www       950: sub select_timezone {
1.1075.2.115  raeburn   951:    my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
                    952:    my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.659     raeburn   953:    if ($includeempty) {
                    954:        $output .= '<option value=""';
                    955:        if (($selected eq '') || ($selected eq 'local')) {
                    956:            $output .= ' selected="selected" ';
                    957:        }
                    958:        $output .= '> </option>';
                    959:    }
1.657     raeburn   960:    my @timezones = DateTime::TimeZone->all_names;
                    961:    foreach my $tzone (@timezones) {
                    962:        $output.= '<option value="'.$tzone.'"';
                    963:        if ($tzone eq $selected) {
                    964:            $output.=' selected="selected"';
                    965:        }
                    966:        $output.=">$tzone</option>\n";
1.656     www       967:    }
                    968:    $output.="</select>";
                    969:    return $output;
                    970: }
1.273     raeburn   971: 
1.687     raeburn   972: sub select_datelocale {
1.1075.2.115  raeburn   973:     my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
                    974:     my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687     raeburn   975:     if ($includeempty) {
                    976:         $output .= '<option value=""';
                    977:         if ($selected eq '') {
                    978:             $output .= ' selected="selected" ';
                    979:         }
                    980:         $output .= '> </option>';
                    981:     }
1.1075.2.102  raeburn   982:     my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   983:     my (@possibles,%locale_names);
1.1075.2.102  raeburn   984:     my @locales = DateTime::Locale->ids();
                    985:     foreach my $id (@locales) {
                    986:         if ($id ne '') {
                    987:             my ($en_terr,$native_terr);
                    988:             my $loc = DateTime::Locale->load($id);
                    989:             if (ref($loc)) {
                    990:                 $en_terr = $loc->name();
                    991:                 $native_terr = $loc->native_name();
1.687     raeburn   992:                 if (grep(/^en$/,@languages) || !@languages) {
                    993:                     if ($en_terr ne '') {
                    994:                         $locale_names{$id} = '('.$en_terr.')';
                    995:                     } elsif ($native_terr ne '') {
                    996:                         $locale_names{$id} = $native_terr;
                    997:                     }
                    998:                 } else {
                    999:                     if ($native_terr ne '') {
                   1000:                         $locale_names{$id} = $native_terr.' ';
                   1001:                     } elsif ($en_terr ne '') {
                   1002:                         $locale_names{$id} = '('.$en_terr.')';
                   1003:                     }
                   1004:                 }
1.1075.2.94  raeburn  1005:                 $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1075.2.102  raeburn  1006:                 push(@possibles,$id);
1.687     raeburn  1007:             }
                   1008:         }
                   1009:     }
                   1010:     foreach my $item (sort(@possibles)) {
                   1011:         $output.= '<option value="'.$item.'"';
                   1012:         if ($item eq $selected) {
                   1013:             $output.=' selected="selected"';
                   1014:         }
                   1015:         $output.=">$item";
                   1016:         if ($locale_names{$item} ne '') {
1.1075.2.94  raeburn  1017:             $output.='  '.$locale_names{$item};
1.687     raeburn  1018:         }
                   1019:         $output.="</option>\n";
                   1020:     }
                   1021:     $output.="</select>";
                   1022:     return $output;
                   1023: }
                   1024: 
1.792     raeburn  1025: sub select_language {
1.1075.2.115  raeburn  1026:     my ($name,$selected,$includeempty,$noedit) = @_;
1.792     raeburn  1027:     my %langchoices;
                   1028:     if ($includeempty) {
1.1075.2.32  raeburn  1029:         %langchoices = ('' => 'No language preference');
1.792     raeburn  1030:     }
                   1031:     foreach my $id (&languageids()) {
                   1032:         my $code = &supportedlanguagecode($id);
                   1033:         if ($code) {
                   1034:             $langchoices{$code} = &plainlanguagedescription($id);
                   1035:         }
                   1036:     }
1.1075.2.32  raeburn  1037:     %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1075.2.115  raeburn  1038:     return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792     raeburn  1039: }
                   1040: 
1.42      matthew  1041: =pod
1.36      matthew  1042: 
1.648     raeburn  1043: =item * &linked_select_forms(...)
1.36      matthew  1044: 
                   1045: linked_select_forms returns a string containing a <script></script> block
                   1046: and html for two <select> menus.  The select menus will be linked in that
                   1047: changing the value of the first menu will result in new values being placed
                   1048: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn  1049: order unless a defined order is provided.
1.36      matthew  1050: 
                   1051: linked_select_forms takes the following ordered inputs:
                   1052: 
                   1053: =over 4
                   1054: 
1.112     bowersj2 1055: =item * $formname, the name of the <form> tag
1.36      matthew  1056: 
1.112     bowersj2 1057: =item * $middletext, the text which appears between the <select> tags
1.36      matthew  1058: 
1.112     bowersj2 1059: =item * $firstdefault, the default value for the first menu
1.36      matthew  1060: 
1.112     bowersj2 1061: =item * $firstselectname, the name of the first <select> tag
1.36      matthew  1062: 
1.112     bowersj2 1063: =item * $secondselectname, the name of the second <select> tag
1.36      matthew  1064: 
1.112     bowersj2 1065: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew  1066: 
1.609     raeburn  1067: =item * $menuorder, the order of values in the first menu
                   1068: 
1.1075.2.31  raeburn  1069: =item * $onchangefirst, additional javascript call to execute for an onchange
                   1070:         event for the first <select> tag
                   1071: 
                   1072: =item * $onchangesecond, additional javascript call to execute for an onchange
                   1073:         event for the second <select> tag
                   1074: 
1.41      ng       1075: =back 
                   1076: 
1.36      matthew  1077: Below is an example of such a hash.  Only the 'text', 'default', and 
                   1078: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                   1079: values for the first select menu.  The text that coincides with the 
1.41      ng       1080: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew  1081: and text for the second menu are given in the hash pointed to by 
                   1082: $menu{$choice1}->{'select2'}.  
                   1083: 
1.112     bowersj2 1084:  my %menu = ( A1 => { text =>"Choice A1" ,
                   1085:                        default => "B3",
                   1086:                        select2 => { 
                   1087:                            B1 => "Choice B1",
                   1088:                            B2 => "Choice B2",
                   1089:                            B3 => "Choice B3",
                   1090:                            B4 => "Choice B4"
1.609     raeburn  1091:                            },
                   1092:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2 1093:                    },
                   1094:                A2 => { text =>"Choice A2" ,
                   1095:                        default => "C2",
                   1096:                        select2 => { 
                   1097:                            C1 => "Choice C1",
                   1098:                            C2 => "Choice C2",
                   1099:                            C3 => "Choice C3"
1.609     raeburn  1100:                            },
                   1101:                        order => ['C2','C1','C3'],
1.112     bowersj2 1102:                    },
                   1103:                A3 => { text =>"Choice A3" ,
                   1104:                        default => "D6",
                   1105:                        select2 => { 
                   1106:                            D1 => "Choice D1",
                   1107:                            D2 => "Choice D2",
                   1108:                            D3 => "Choice D3",
                   1109:                            D4 => "Choice D4",
                   1110:                            D5 => "Choice D5",
                   1111:                            D6 => "Choice D6",
                   1112:                            D7 => "Choice D7"
1.609     raeburn  1113:                            },
                   1114:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2 1115:                    }
                   1116:                );
1.36      matthew  1117: 
                   1118: =cut
                   1119: 
                   1120: sub linked_select_forms {
                   1121:     my ($formname,
                   1122:         $middletext,
                   1123:         $firstdefault,
                   1124:         $firstselectname,
                   1125:         $secondselectname, 
1.609     raeburn  1126:         $hashref,
                   1127:         $menuorder,
1.1075.2.31  raeburn  1128:         $onchangefirst,
                   1129:         $onchangesecond
1.36      matthew  1130:         ) = @_;
                   1131:     my $second = "document.$formname.$secondselectname";
                   1132:     my $first = "document.$formname.$firstselectname";
                   1133:     # output the javascript to do the changing
                   1134:     my $result = '';
1.776     bisitz   1135:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz   1136:     $result.="// <![CDATA[\n";
1.36      matthew  1137:     $result.="var select2data = new Object();\n";
                   1138:     $" = '","';
                   1139:     my $debug = '';
                   1140:     foreach my $s1 (sort(keys(%$hashref))) {
                   1141:         $result.="select2data.d_$s1 = new Object();\n";        
                   1142:         $result.="select2data.d_$s1.def = new String('".
                   1143:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn  1144:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew  1145:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1146:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1147:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1148:         }
1.36      matthew  1149:         $result.="\"@s2values\");\n";
                   1150:         $result.="select2data.d_$s1.texts = new Array(";        
                   1151:         my @s2texts;
                   1152:         foreach my $value (@s2values) {
1.1075.2.119  raeburn  1153:             push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36      matthew  1154:         }
                   1155:         $result.="\"@s2texts\");\n";
                   1156:     }
                   1157:     $"=' ';
                   1158:     $result.= <<"END";
                   1159: 
                   1160: function select1_changed() {
                   1161:     // Determine new choice
                   1162:     var newvalue = "d_" + $first.value;
                   1163:     // update select2
                   1164:     var values     = select2data[newvalue].values;
                   1165:     var texts      = select2data[newvalue].texts;
                   1166:     var select2def = select2data[newvalue].def;
                   1167:     var i;
                   1168:     // out with the old
                   1169:     for (i = 0; i < $second.options.length; i++) {
                   1170:         $second.options[i] = null;
                   1171:     }
                   1172:     // in with the nuclear
                   1173:     for (i=0;i<values.length; i++) {
                   1174:         $second.options[i] = new Option(values[i]);
1.143     matthew  1175:         $second.options[i].value = values[i];
1.36      matthew  1176:         $second.options[i].text = texts[i];
                   1177:         if (values[i] == select2def) {
                   1178:             $second.options[i].selected = true;
                   1179:         }
                   1180:     }
                   1181: }
1.824     bisitz   1182: // ]]>
1.36      matthew  1183: </script>
                   1184: END
                   1185:     # output the initial values for the selection lists
1.1075.2.31  raeburn  1186:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed();$onchangefirst\">\n";
1.609     raeburn  1187:     my @order = sort(keys(%{$hashref}));
                   1188:     if (ref($menuorder) eq 'ARRAY') {
                   1189:         @order = @{$menuorder};
                   1190:     }
                   1191:     foreach my $value (@order) {
1.36      matthew  1192:         $result.="    <option value=\"$value\" ";
1.253     albertel 1193:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1194:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1195:     }
                   1196:     $result .= "</select>\n";
                   1197:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1198:     $result .= $middletext;
1.1075.2.31  raeburn  1199:     $result .= "<select size=\"1\" name=\"$secondselectname\"";
                   1200:     if ($onchangesecond) {
                   1201:         $result .= ' onchange="'.$onchangesecond.'"';
                   1202:     }
                   1203:     $result .= ">\n";
1.36      matthew  1204:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1205:     
                   1206:     my @secondorder = sort(keys(%select2));
                   1207:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1208:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1209:     }
                   1210:     foreach my $value (@secondorder) {
1.36      matthew  1211:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1212:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1213:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1214:     }
                   1215:     $result .= "</select>\n";
                   1216:     #    return $debug;
                   1217:     return $result;
                   1218: }   #  end of sub linked_select_forms {
                   1219: 
1.45      matthew  1220: =pod
1.44      bowersj2 1221: 
1.973     raeburn  1222: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44      bowersj2 1223: 
1.112     bowersj2 1224: Returns a string corresponding to an HTML link to the given help
                   1225: $topic, where $topic corresponds to the name of a .tex file in
                   1226: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1227: spaces. 
                   1228: 
                   1229: $text will optionally be linked to the same topic, allowing you to
                   1230: link text in addition to the graphic. If you do not want to link
                   1231: text, but wish to specify one of the later parameters, pass an
                   1232: empty string. 
                   1233: 
                   1234: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1235: the link will not open a new window. If false, the link will open
                   1236: a new window using Javascript. (Default is false.) 
                   1237: 
                   1238: $width and $height are optional numerical parameters that will
                   1239: override the width and height of the popped up window, which may
1.973     raeburn  1240: be useful for certain help topics with big pictures included.
                   1241: 
                   1242: $imgid is the id of the img tag used for the help icon. This may be
                   1243: used in a javascript call to switch the image src.  See 
                   1244: lonhtmlcommon::htmlareaselectactive() for an example.
1.44      bowersj2 1245: 
                   1246: =cut
                   1247: 
                   1248: sub help_open_topic {
1.973     raeburn  1249:     my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48      bowersj2 1250:     $text = "" if (not defined $text);
1.44      bowersj2 1251:     $stayOnPage = 0 if (not defined $stayOnPage);
1.1033    www      1252:     $width = 500 if (not defined $width);
1.44      bowersj2 1253:     $height = 400 if (not defined $height);
                   1254:     my $filename = $topic;
                   1255:     $filename =~ s/ /_/g;
                   1256: 
1.48      bowersj2 1257:     my $template = "";
                   1258:     my $link;
1.572     banghart 1259:     
1.159     www      1260:     $topic=~s/\W/\_/g;
1.44      bowersj2 1261: 
1.572     banghart 1262:     if (!$stayOnPage) {
1.1075.2.50  raeburn  1263:         if ($env{'browser.mobile'}) {
                   1264: 	    $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
                   1265:         } else {
                   1266:             $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1267:         }
1.1037    www      1268:     } elsif ($stayOnPage eq 'popup') {
                   1269:         $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 1270:     } else {
1.48      bowersj2 1271: 	$link = "/adm/help/${filename}.hlp";
                   1272:     }
                   1273: 
                   1274:     # Add the text
1.755     neumanie 1275:     if ($text ne "") {	
1.763     bisitz   1276: 	$template.='<span class="LC_help_open_topic">'
                   1277:                   .'<a target="_top" href="'.$link.'">'
                   1278:                   .$text.'</a>';
1.48      bowersj2 1279:     }
                   1280: 
1.763     bisitz   1281:     # (Always) Add the graphic
1.179     matthew  1282:     my $title = &mt('Online Help');
1.667     raeburn  1283:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973     raeburn  1284:     if ($imgid ne '') {
                   1285:         $imgid = ' id="'.$imgid.'"';
                   1286:     }
1.763     bisitz   1287:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1288:               .'<img src="'.$helpicon.'" border="0"'
                   1289:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973     raeburn  1290:               .' title="'.$title.'" style="vertical-align:middle;"'.$imgid 
1.763     bisitz   1291:               .' /></a>';
                   1292:     if ($text ne "") {	
                   1293:         $template.='</span>';
                   1294:     }
1.44      bowersj2 1295:     return $template;
                   1296: 
1.106     bowersj2 1297: }
                   1298: 
                   1299: # This is a quicky function for Latex cheatsheet editing, since it 
                   1300: # appears in at least four places
                   1301: sub helpLatexCheatsheet {
1.1037    www      1302:     my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732     raeburn  1303:     my $out;
1.106     bowersj2 1304:     my $addOther = '';
1.732     raeburn  1305:     if ($topic) {
1.1037    www      1306: 	$addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763     bisitz   1307:     }
                   1308:     $out = '<span>' # Start cheatsheet
                   1309: 	  .$addOther
                   1310:           .'<span>'
1.1037    www      1311: 	  .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1312: 	  .'</span> <span>'
1.1037    www      1313: 	  .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1314: 	  .'</span>';
1.732     raeburn  1315:     unless ($not_author) {
1.763     bisitz   1316:         $out .= ' <span>'
1.1037    www      1317: 	       .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.1075.2.71  raeburn  1318: 	       .'</span> <span>'
1.1075.2.78  raeburn  1319:                .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.1075.2.71  raeburn  1320:                .'</span>';
1.732     raeburn  1321:     }
1.763     bisitz   1322:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1323:     return $out;
1.172     www      1324: }
                   1325: 
1.430     albertel 1326: sub general_help {
                   1327:     my $helptopic='Student_Intro';
                   1328:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1329: 	$helptopic='Authoring_Intro';
1.907     raeburn  1330:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1331: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1332:     } elsif ($env{'request.role'}=~/^dc/) {
                   1333:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1334:     }
                   1335:     return $helptopic;
                   1336: }
                   1337: 
                   1338: sub update_help_link {
                   1339:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1340:     my $origurl = $ENV{'REQUEST_URI'};
                   1341:     $origurl=~s|^/~|/priv/|;
                   1342:     my $timestamp = time;
                   1343:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1344:         $$datum = &escape($$datum);
                   1345:     }
                   1346: 
                   1347:     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";
                   1348:     my $output .= <<"ENDOUTPUT";
                   1349: <script type="text/javascript">
1.824     bisitz   1350: // <![CDATA[
1.430     albertel 1351: banner_link = '$banner_link';
1.824     bisitz   1352: // ]]>
1.430     albertel 1353: </script>
                   1354: ENDOUTPUT
                   1355:     return $output;
                   1356: }
                   1357: 
                   1358: # now just updates the help link and generates a blue icon
1.193     raeburn  1359: sub help_open_menu {
1.430     albertel 1360:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1361: 	= @_;    
1.949     droeschl 1362:     $stayOnPage = 1;
1.430     albertel 1363:     my $output;
                   1364:     if ($component_help) {
                   1365: 	if (!$text) {
                   1366: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1367: 				       $width,$height);
                   1368: 	} else {
                   1369: 	    my $help_text;
                   1370: 	    $help_text=&unescape($topic);
                   1371: 	    $output='<table><tr><td>'.
                   1372: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1373: 				 $width,$height).'</td></tr></table>';
                   1374: 	}
                   1375:     }
                   1376:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1377:     return $output.$banner_link;
                   1378: }
                   1379: 
                   1380: sub top_nav_help {
                   1381:     my ($text) = @_;
1.436     albertel 1382:     $text = &mt($text);
1.1075.2.60  raeburn  1383:     my $stay_on_page;
                   1384:     unless ($env{'environment.remote'} eq 'on') {
                   1385:         $stay_on_page = 1;
                   1386:     }
1.1075.2.61  raeburn  1387:     my ($link,$banner_link);
                   1388:     unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
                   1389:         $link = ($stay_on_page) ? "javascript:helpMenu('display')"
                   1390: 	                         : "javascript:helpMenu('open')";
                   1391:         $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
                   1392:     }
1.201     raeburn  1393:     my $title = &mt('Get help');
1.1075.2.61  raeburn  1394:     if ($link) {
                   1395:         return <<"END";
1.436     albertel 1396: $banner_link
1.1075.2.56  raeburn  1397: <a href="$link" title="$title">$text</a>
1.436     albertel 1398: END
1.1075.2.61  raeburn  1399:     } else {
                   1400:         return '&nbsp;'.$text.'&nbsp;';
                   1401:     }
1.436     albertel 1402: }
                   1403: 
                   1404: sub help_menu_js {
1.1075.2.52  raeburn  1405:     my ($httphost) = @_;
1.949     droeschl 1406:     my $stayOnPage = 1;
1.436     albertel 1407:     my $width = 620;
                   1408:     my $height = 600;
1.430     albertel 1409:     my $helptopic=&general_help();
1.1075.2.52  raeburn  1410:     my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1411:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1412:     my $start_page =
                   1413:         &Apache::loncommon::start_page('Help Menu', undef,
                   1414: 				       {'frameset'    => 1,
                   1415: 					'js_ready'    => 1,
1.1075.2.136  raeburn  1416:                                         'use_absolute' => $httphost,
1.331     albertel 1417: 					'add_entries' => {
                   1418: 					    'border' => '0',
1.579     raeburn  1419: 					    'rows'   => "110,*",},});
1.331     albertel 1420:     my $end_page =
                   1421:         &Apache::loncommon::end_page({'frameset' => 1,
                   1422: 				      'js_ready' => 1,});
                   1423: 
1.436     albertel 1424:     my $template .= <<"ENDTEMPLATE";
                   1425: <script type="text/javascript">
1.877     bisitz   1426: // <![CDATA[
1.253     albertel 1427: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1428: var banner_link = '';
1.243     raeburn  1429: function helpMenu(target) {
                   1430:     var caller = this;
                   1431:     if (target == 'open') {
                   1432:         var newWindow = null;
                   1433:         try {
1.262     albertel 1434:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1435:         }
                   1436:         catch(error) {
                   1437:             writeHelp(caller);
                   1438:             return;
                   1439:         }
                   1440:         if (newWindow) {
                   1441:             caller = newWindow;
                   1442:         }
1.193     raeburn  1443:     }
1.243     raeburn  1444:     writeHelp(caller);
                   1445:     return;
                   1446: }
                   1447: function writeHelp(caller) {
1.1075.2.61  raeburn  1448:     caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
                   1449:     caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
                   1450:     caller.document.close();
                   1451:     caller.focus();
1.193     raeburn  1452: }
1.877     bisitz   1453: // END LON-CAPA Internal -->
1.253     albertel 1454: // ]]>
1.436     albertel 1455: </script>
1.193     raeburn  1456: ENDTEMPLATE
                   1457:     return $template;
                   1458: }
                   1459: 
1.172     www      1460: sub help_open_bug {
                   1461:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1462:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1463:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1464:     $text = "" if (not defined $text);
                   1465: 	$stayOnPage=1;
1.184     albertel 1466:     $width = 600 if (not defined $width);
                   1467:     $height = 600 if (not defined $height);
1.172     www      1468: 
                   1469:     $topic=~s/\W+/\+/g;
                   1470:     my $link='';
                   1471:     my $template='';
1.379     albertel 1472:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1473: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1474:     if (!$stayOnPage)
                   1475:     {
                   1476: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1477:     }
                   1478:     else
                   1479:     {
                   1480: 	$link = $url;
                   1481:     }
                   1482:     # Add the text
                   1483:     if ($text ne "")
                   1484:     {
                   1485: 	$template .= 
                   1486:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1487:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1488:     }
                   1489: 
                   1490:     # Add the graphic
1.179     matthew  1491:     my $title = &mt('Report a Bug');
1.215     albertel 1492:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1493:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1494:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1495: ENDTEMPLATE
                   1496:     if ($text ne '') { $template.='</td></tr></table>' };
                   1497:     return $template;
                   1498: 
                   1499: }
                   1500: 
                   1501: sub help_open_faq {
                   1502:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1503:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1504:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1505:     $text = "" if (not defined $text);
                   1506: 	$stayOnPage=1;
                   1507:     $width = 350 if (not defined $width);
                   1508:     $height = 400 if (not defined $height);
                   1509: 
                   1510:     $topic=~s/\W+/\+/g;
                   1511:     my $link='';
                   1512:     my $template='';
                   1513:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1514:     if (!$stayOnPage)
                   1515:     {
                   1516: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1517:     }
                   1518:     else
                   1519:     {
                   1520: 	$link = $url;
                   1521:     }
                   1522: 
                   1523:     # Add the text
                   1524:     if ($text ne "")
                   1525:     {
                   1526: 	$template .= 
1.173     www      1527:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1528:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1529:     }
                   1530: 
                   1531:     # Add the graphic
1.179     matthew  1532:     my $title = &mt('View the FAQ');
1.215     albertel 1533:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1534:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1535:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1536: ENDTEMPLATE
                   1537:     if ($text ne '') { $template.='</td></tr></table>' };
                   1538:     return $template;
                   1539: 
1.44      bowersj2 1540: }
1.37      matthew  1541: 
1.180     matthew  1542: ###############################################################
                   1543: ###############################################################
                   1544: 
1.45      matthew  1545: =pod
                   1546: 
1.648     raeburn  1547: =item * &change_content_javascript():
1.256     matthew  1548: 
                   1549: This and the next function allow you to create small sections of an
                   1550: otherwise static HTML page that you can update on the fly with
                   1551: Javascript, even in Netscape 4.
                   1552: 
                   1553: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1554: must be written to the HTML page once. It will prove the Javascript
                   1555: function "change(name, content)". Calling the change function with the
                   1556: name of the section 
                   1557: you want to update, matching the name passed to C<changable_area>, and
                   1558: the new content you want to put in there, will put the content into
                   1559: that area.
                   1560: 
                   1561: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1562: to contain room for the original contents. You need to "make space"
                   1563: for whatever changes you wish to make, and be B<sure> to check your
                   1564: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1565: it's adequate for updating a one-line status display, but little more.
                   1566: This script will set the space to 100% width, so you only need to
                   1567: worry about height in Netscape 4.
                   1568: 
                   1569: Modern browsers are much less limiting, and if you can commit to the
                   1570: user not using Netscape 4, this feature may be used freely with
                   1571: pretty much any HTML.
                   1572: 
                   1573: =cut
                   1574: 
                   1575: sub change_content_javascript {
                   1576:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1577:     if ($env{'browser.type'} eq 'netscape' &&
                   1578: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1579: 	return (<<NETSCAPE4);
                   1580: 	function change(name, content) {
                   1581: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1582: 	    doc.open();
                   1583: 	    doc.write(content);
                   1584: 	    doc.close();
                   1585: 	}
                   1586: NETSCAPE4
                   1587:     } else {
                   1588: 	# Otherwise, we need to use semi-standards-compliant code
                   1589: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1590: 	# is really scary, and every useful browser supports it
                   1591: 	return (<<DOMBASED);
                   1592: 	function change(name, content) {
                   1593: 	    element = document.getElementById(name);
                   1594: 	    element.innerHTML = content;
                   1595: 	}
                   1596: DOMBASED
                   1597:     }
                   1598: }
                   1599: 
                   1600: =pod
                   1601: 
1.648     raeburn  1602: =item * &changable_area($name,$origContent):
1.256     matthew  1603: 
                   1604: This provides a "changable area" that can be modified on the fly via
                   1605: the Javascript code provided in C<change_content_javascript>. $name is
                   1606: the name you will use to reference the area later; do not repeat the
                   1607: same name on a given HTML page more then once. $origContent is what
                   1608: the area will originally contain, which can be left blank.
                   1609: 
                   1610: =cut
                   1611: 
                   1612: sub changable_area {
                   1613:     my ($name, $origContent) = @_;
                   1614: 
1.258     albertel 1615:     if ($env{'browser.type'} eq 'netscape' &&
                   1616: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1617: 	# If this is netscape 4, we need to use the Layer tag
                   1618: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1619:     } else {
                   1620: 	return "<span id='$name'>$origContent</span>";
                   1621:     }
                   1622: }
                   1623: 
                   1624: =pod
                   1625: 
1.648     raeburn  1626: =item * &viewport_geometry_js 
1.590     raeburn  1627: 
                   1628: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1629: 
                   1630: =cut
                   1631: 
                   1632: 
                   1633: sub viewport_geometry_js { 
                   1634:     return <<"GEOMETRY";
                   1635: var Geometry = {};
                   1636: function init_geometry() {
                   1637:     if (Geometry.init) { return };
                   1638:     Geometry.init=1;
                   1639:     if (window.innerHeight) {
                   1640:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1641:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1642:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1643:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1644:     }
                   1645:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1646:         Geometry.getViewportHeight =
                   1647:             function() { return document.documentElement.clientHeight; };
                   1648:         Geometry.getViewportWidth =
                   1649:             function() { return document.documentElement.clientWidth; };
                   1650: 
                   1651:         Geometry.getHorizontalScroll =
                   1652:             function() { return document.documentElement.scrollLeft; };
                   1653:         Geometry.getVerticalScroll =
                   1654:             function() { return document.documentElement.scrollTop; };
                   1655:     }
                   1656:     else if (document.body.clientHeight) {
                   1657:         Geometry.getViewportHeight =
                   1658:             function() { return document.body.clientHeight; };
                   1659:         Geometry.getViewportWidth =
                   1660:             function() { return document.body.clientWidth; };
                   1661:         Geometry.getHorizontalScroll =
                   1662:             function() { return document.body.scrollLeft; };
                   1663:         Geometry.getVerticalScroll =
                   1664:             function() { return document.body.scrollTop; };
                   1665:     }
                   1666: }
                   1667: 
                   1668: GEOMETRY
                   1669: }
                   1670: 
                   1671: =pod
                   1672: 
1.648     raeburn  1673: =item * &viewport_size_js()
1.590     raeburn  1674: 
                   1675: 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. 
                   1676: 
                   1677: =cut
                   1678: 
                   1679: sub viewport_size_js {
                   1680:     my $geometry = &viewport_geometry_js();
                   1681:     return <<"DIMS";
                   1682: 
                   1683: $geometry
                   1684: 
                   1685: function getViewportDims(width,height) {
                   1686:     init_geometry();
                   1687:     width.value = Geometry.getViewportWidth();
                   1688:     height.value = Geometry.getViewportHeight();
                   1689:     return;
                   1690: }
                   1691: 
                   1692: DIMS
                   1693: }
                   1694: 
                   1695: =pod
                   1696: 
1.648     raeburn  1697: =item * &resize_textarea_js()
1.565     albertel 1698: 
                   1699: emits the needed javascript to resize a textarea to be as big as possible
                   1700: 
                   1701: creates a function resize_textrea that takes two IDs first should be
                   1702: the id of the element to resize, second should be the id of a div that
                   1703: surrounds everything that comes after the textarea, this routine needs
                   1704: to be attached to the <body> for the onload and onresize events.
                   1705: 
1.648     raeburn  1706: =back
1.565     albertel 1707: 
                   1708: =cut
                   1709: 
                   1710: sub resize_textarea_js {
1.590     raeburn  1711:     my $geometry = &viewport_geometry_js();
1.565     albertel 1712:     return <<"RESIZE";
                   1713:     <script type="text/javascript">
1.824     bisitz   1714: // <![CDATA[
1.590     raeburn  1715: $geometry
1.565     albertel 1716: 
1.588     albertel 1717: function getX(element) {
                   1718:     var x = 0;
                   1719:     while (element) {
                   1720: 	x += element.offsetLeft;
                   1721: 	element = element.offsetParent;
                   1722:     }
                   1723:     return x;
                   1724: }
                   1725: function getY(element) {
                   1726:     var y = 0;
                   1727:     while (element) {
                   1728: 	y += element.offsetTop;
                   1729: 	element = element.offsetParent;
                   1730:     }
                   1731:     return y;
                   1732: }
                   1733: 
                   1734: 
1.565     albertel 1735: function resize_textarea(textarea_id,bottom_id) {
                   1736:     init_geometry();
                   1737:     var textarea        = document.getElementById(textarea_id);
                   1738:     //alert(textarea);
                   1739: 
1.588     albertel 1740:     var textarea_top    = getY(textarea);
1.565     albertel 1741:     var textarea_height = textarea.offsetHeight;
                   1742:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1743:     var bottom_top      = getY(bottom);
1.565     albertel 1744:     var bottom_height   = bottom.offsetHeight;
                   1745:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1746:     var fudge           = 23;
1.565     albertel 1747:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1748:     if (new_height < 300) {
                   1749: 	new_height = 300;
                   1750:     }
                   1751:     textarea.style.height=new_height+'px';
                   1752: }
1.824     bisitz   1753: // ]]>
1.565     albertel 1754: </script>
                   1755: RESIZE
                   1756: 
                   1757: }
                   1758: 
1.1075.2.112  raeburn  1759: sub colorfuleditor_js {
                   1760:     return <<"COLORFULEDIT"
                   1761: <script type="text/javascript">
                   1762: // <![CDATA[>
                   1763:     function fold_box(curDepth, lastresource){
                   1764: 
                   1765:     // we need a list because there can be several blocks you need to fold in one tag
                   1766:         var block = document.getElementsByName('foldblock_'+curDepth);
                   1767:     // but there is only one folding button per tag
                   1768:         var foldbutton = document.getElementById('folding_btn_'+curDepth);
                   1769: 
                   1770:         if(block.item(0).style.display == 'none'){
                   1771: 
                   1772:             foldbutton.value = '@{[&mt("Hide")]}';
                   1773:             for (i = 0; i < block.length; i++){
                   1774:                 block.item(i).style.display = '';
                   1775:             }
                   1776:         }else{
                   1777: 
                   1778:             foldbutton.value = '@{[&mt("Show")]}';
                   1779:             for (i = 0; i < block.length; i++){
                   1780:                 // block.item(i).style.visibility = 'collapse';
                   1781:                 block.item(i).style.display = 'none';
                   1782:             }
                   1783:         };
                   1784:         saveState(lastresource);
                   1785:     }
                   1786: 
                   1787:     function saveState (lastresource) {
                   1788: 
                   1789:         var tag_list = getTagList();
                   1790:         if(tag_list != null){
                   1791:             var timestamp = new Date().getTime();
                   1792:             var key = lastresource;
                   1793: 
                   1794:             // the value pattern is: 'time;key1,value1;key2,value2; ... '
                   1795:             // starting with timestamp
                   1796:             var value = timestamp+';';
                   1797: 
                   1798:             // building the list of key-value pairs
                   1799:             for(var i = 0; i < tag_list.length; i++){
                   1800:                 value += tag_list[i]+',';
                   1801:                 value += document.getElementsByName(tag_list[i])[0].style.display+';';
                   1802:             }
                   1803: 
                   1804:             // only iterate whole storage if nothing to override
                   1805:             if(localStorage.getItem(key) == null){
                   1806: 
                   1807:                 // prevent storage from growing large
                   1808:                 if(localStorage.length > 50){
                   1809:                     var regex_getTimestamp = /^(?:\d)+;/;
                   1810:                     var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
                   1811:                     var oldest_key;
                   1812: 
                   1813:                     for(var i = 1; i < localStorage.length; i++){
                   1814:                         if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
                   1815:                             oldest_key = localStorage.key(i);
                   1816:                             oldest_timestamp = regex_getTimestamp.exec(oldest_key);
                   1817:                         }
                   1818:                     }
                   1819:                     localStorage.removeItem(oldest_key);
                   1820:                 }
                   1821:             }
                   1822:             localStorage.setItem(key,value);
                   1823:         }
                   1824:     }
                   1825: 
                   1826:     // restore folding status of blocks (on page load)
                   1827:     function restoreState (lastresource) {
                   1828:         if(localStorage.getItem(lastresource) != null){
                   1829:             var key = lastresource;
                   1830:             var value = localStorage.getItem(key);
                   1831:             var regex_delTimestamp = /^\d+;/;
                   1832: 
                   1833:             value.replace(regex_delTimestamp, '');
                   1834: 
                   1835:             var valueArr = value.split(';');
                   1836:             var pairs;
                   1837:             var elements;
                   1838:             for (var i = 0; i < valueArr.length; i++){
                   1839:                 pairs = valueArr[i].split(',');
                   1840:                 elements = document.getElementsByName(pairs[0]);
                   1841: 
                   1842:                 for (var j = 0; j < elements.length; j++){
                   1843:                     elements[j].style.display = pairs[1];
                   1844:                     if (pairs[1] == "none"){
                   1845:                         var regex_id = /([_\\d]+)\$/;
                   1846:                         regex_id.exec(pairs[0]);
                   1847:                         document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
                   1848:                     }
                   1849:                 }
                   1850:             }
                   1851:         }
                   1852:     }
                   1853: 
                   1854:     function getTagList () {
                   1855: 
                   1856:         var stringToSearch = document.lonhomework.innerHTML;
                   1857: 
                   1858:         var ret = new Array();
                   1859:         var regex_findBlock = /(foldblock_.*?)"/g;
                   1860:         var tag_list = stringToSearch.match(regex_findBlock);
                   1861: 
                   1862:         if(tag_list != null){
                   1863:             for(var i = 0; i < tag_list.length; i++){
                   1864:                 ret.push(tag_list[i].replace(/"/, ''));
                   1865:             }
                   1866:         }
                   1867:         return ret;
                   1868:     }
                   1869: 
                   1870:     function saveScrollPosition (resource) {
                   1871:         var tag_list = getTagList();
                   1872: 
                   1873:         // we dont always want to jump to the first block
                   1874:         // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
                   1875:         if(\$(window).scrollTop() > 170){
                   1876:             if(tag_list != null){
                   1877:                 var result;
                   1878:                 for(var i = 0; i < tag_list.length; i++){
                   1879:                     if(isElementInViewport(tag_list[i])){
                   1880:                         result += tag_list[i]+';';
                   1881:                     }
                   1882:                 }
                   1883:                 sessionStorage.setItem('anchor_'+resource, result);
                   1884:             }
                   1885:         } else {
                   1886:             // we dont need to save zero, just delete the item to leave everything tidy
                   1887:             sessionStorage.removeItem('anchor_'+resource);
                   1888:         }
                   1889:     }
                   1890: 
                   1891:     function restoreScrollPosition(resource){
                   1892: 
                   1893:         var elem = sessionStorage.getItem('anchor_'+resource);
                   1894:         if(elem != null){
                   1895:             var tag_list = elem.split(';');
                   1896:             var elem_list;
                   1897: 
                   1898:             for(var i = 0; i < tag_list.length; i++){
                   1899:                 elem_list = document.getElementsByName(tag_list[i]);
                   1900: 
                   1901:                 if(elem_list.length > 0){
                   1902:                     elem = elem_list[0];
                   1903:                     break;
                   1904:                 }
                   1905:             }
                   1906:             elem.scrollIntoView();
                   1907:         }
                   1908:     }
                   1909: 
                   1910:     function isElementInViewport(el) {
                   1911: 
                   1912:         // change to last element instead of first
                   1913:         var elem = document.getElementsByName(el);
                   1914:         var rect = elem[0].getBoundingClientRect();
                   1915: 
                   1916:         return (
                   1917:             rect.top >= 0 &&
                   1918:             rect.left >= 0 &&
                   1919:             rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
                   1920:             rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
                   1921:         );
                   1922:     }
                   1923: 
                   1924:     function autosize(depth){
                   1925:         var cmInst = window['cm'+depth];
                   1926:         var fitsizeButton = document.getElementById('fitsize'+depth);
                   1927: 
                   1928:         // is fixed size, switching to dynamic
                   1929:         if (sessionStorage.getItem("autosized_"+depth) == null) {
                   1930:             cmInst.setSize("","auto");
                   1931:             fitsizeButton.value = "@{[&mt('Fixed size')]}";
                   1932:             sessionStorage.setItem("autosized_"+depth, "yes");
                   1933: 
                   1934:         // is dynamic size, switching to fixed
                   1935:         } else {
                   1936:             cmInst.setSize("","300px");
                   1937:             fitsizeButton.value = "@{[&mt('Dynamic size')]}";
                   1938:             sessionStorage.removeItem("autosized_"+depth);
                   1939:         }
                   1940:     }
                   1941: 
                   1942: 
                   1943: 
                   1944: // ]]>
                   1945: </script>
                   1946: COLORFULEDIT
                   1947: }
                   1948: 
                   1949: sub xmleditor_js {
                   1950:     return <<XMLEDIT
                   1951: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
                   1952: <script type="text/javascript">
                   1953: // <![CDATA[>
                   1954: 
                   1955:     function saveScrollPosition (resource) {
                   1956: 
                   1957:         var scrollPos = \$(window).scrollTop();
                   1958:         sessionStorage.setItem(resource,scrollPos);
                   1959:     }
                   1960: 
                   1961:     function restoreScrollPosition(resource){
                   1962: 
                   1963:         var scrollPos = sessionStorage.getItem(resource);
                   1964:         \$(window).scrollTop(scrollPos);
                   1965:     }
                   1966: 
                   1967:     // unless internet explorer
                   1968:     if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
                   1969: 
                   1970:         \$(document).ready(function() {
                   1971:              \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
                   1972:         });
                   1973:     }
                   1974: 
                   1975:     // inserts text at cursor position into codemirror (xml editor only)
                   1976:     function insertText(text){
                   1977:         cm.focus();
                   1978:         var curPos = cm.getCursor();
                   1979:         cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
                   1980:     }
                   1981: // ]]>
                   1982: </script>
                   1983: XMLEDIT
                   1984: }
                   1985: 
                   1986: sub insert_folding_button {
                   1987:     my $curDepth = $Apache::lonxml::curdepth;
                   1988:     my $lastresource = $env{'request.ambiguous'};
                   1989: 
                   1990:     return "<input type=\"button\" id=\"folding_btn_$curDepth\"
                   1991:             value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
                   1992: }
                   1993: 
                   1994: 
1.565     albertel 1995: =pod
                   1996: 
1.256     matthew  1997: =head1 Excel and CSV file utility routines
                   1998: 
                   1999: =cut
                   2000: 
                   2001: ###############################################################
                   2002: ###############################################################
                   2003: 
                   2004: =pod
                   2005: 
1.1075.2.56  raeburn  2006: =over 4
                   2007: 
1.648     raeburn  2008: =item * &csv_translate($text) 
1.37      matthew  2009: 
1.185     www      2010: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  2011: format.
                   2012: 
                   2013: =cut
                   2014: 
1.180     matthew  2015: ###############################################################
                   2016: ###############################################################
1.37      matthew  2017: sub csv_translate {
                   2018:     my $text = shift;
                   2019:     $text =~ s/\"/\"\"/g;
1.209     albertel 2020:     $text =~ s/\n/ /g;
1.37      matthew  2021:     return $text;
                   2022: }
1.180     matthew  2023: 
                   2024: ###############################################################
                   2025: ###############################################################
                   2026: 
                   2027: =pod
                   2028: 
1.648     raeburn  2029: =item * &define_excel_formats()
1.180     matthew  2030: 
                   2031: Define some commonly used Excel cell formats.
                   2032: 
                   2033: Currently supported formats:
                   2034: 
                   2035: =over 4
                   2036: 
                   2037: =item header
                   2038: 
                   2039: =item bold
                   2040: 
                   2041: =item h1
                   2042: 
                   2043: =item h2
                   2044: 
                   2045: =item h3
                   2046: 
1.256     matthew  2047: =item h4
                   2048: 
                   2049: =item i
                   2050: 
1.180     matthew  2051: =item date
                   2052: 
                   2053: =back
                   2054: 
                   2055: Inputs: $workbook
                   2056: 
                   2057: Returns: $format, a hash reference.
                   2058: 
1.1057    foxr     2059: 
1.180     matthew  2060: =cut
                   2061: 
                   2062: ###############################################################
                   2063: ###############################################################
                   2064: sub define_excel_formats {
                   2065:     my ($workbook) = @_;
                   2066:     my $format;
                   2067:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   2068:                                                 bottom    => 1,
                   2069:                                                 align     => 'center');
                   2070:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   2071:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   2072:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   2073:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  2074:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  2075:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  2076:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  2077:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  2078:     return $format;
                   2079: }
                   2080: 
                   2081: ###############################################################
                   2082: ###############################################################
1.113     bowersj2 2083: 
                   2084: =pod
                   2085: 
1.648     raeburn  2086: =item * &create_workbook()
1.255     matthew  2087: 
                   2088: Create an Excel worksheet.  If it fails, output message on the
                   2089: request object and return undefs.
                   2090: 
                   2091: Inputs: Apache request object
                   2092: 
                   2093: Returns (undef) on failure, 
                   2094:     Excel worksheet object, scalar with filename, and formats 
                   2095:     from &Apache::loncommon::define_excel_formats on success
                   2096: 
                   2097: =cut
                   2098: 
                   2099: ###############################################################
                   2100: ###############################################################
                   2101: sub create_workbook {
                   2102:     my ($r) = @_;
                   2103:         #
                   2104:     # Create the excel spreadsheet
                   2105:     my $filename = '/prtspool/'.
1.258     albertel 2106:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  2107:         time.'_'.rand(1000000000).'.xls';
                   2108:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   2109:     if (! defined($workbook)) {
                   2110:         $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928     bisitz   2111:         $r->print(
                   2112:             '<p class="LC_error">'
                   2113:            .&mt('Problems occurred in creating the new Excel file.')
                   2114:            .' '.&mt('This error has been logged.')
                   2115:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2116:            .'</p>'
                   2117:         );
1.255     matthew  2118:         return (undef);
                   2119:     }
                   2120:     #
1.1014    foxr     2121:     $workbook->set_tempdir(LONCAPA::tempdir());
1.255     matthew  2122:     #
                   2123:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   2124:     return ($workbook,$filename,$format);
                   2125: }
                   2126: 
                   2127: ###############################################################
                   2128: ###############################################################
                   2129: 
                   2130: =pod
                   2131: 
1.648     raeburn  2132: =item * &create_text_file()
1.113     bowersj2 2133: 
1.542     raeburn  2134: Create a file to write to and eventually make available to the user.
1.256     matthew  2135: If file creation fails, outputs an error message on the request object and 
                   2136: return undefs.
1.113     bowersj2 2137: 
1.256     matthew  2138: Inputs: Apache request object, and file suffix
1.113     bowersj2 2139: 
1.256     matthew  2140: Returns (undef) on failure, 
                   2141:     Filehandle and filename on success.
1.113     bowersj2 2142: 
                   2143: =cut
                   2144: 
1.256     matthew  2145: ###############################################################
                   2146: ###############################################################
                   2147: sub create_text_file {
                   2148:     my ($r,$suffix) = @_;
                   2149:     if (! defined($suffix)) { $suffix = 'txt'; };
                   2150:     my $fh;
                   2151:     my $filename = '/prtspool/'.
1.258     albertel 2152:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  2153:         time.'_'.rand(1000000000).'.'.$suffix;
                   2154:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   2155:     if (! defined($fh)) {
                   2156:         $r->log_error("Couldn't open $filename for output $!");
1.928     bisitz   2157:         $r->print(
                   2158:             '<p class="LC_error">'
                   2159:            .&mt('Problems occurred in creating the output file.')
                   2160:            .' '.&mt('This error has been logged.')
                   2161:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2162:            .'</p>'
                   2163:         );
1.113     bowersj2 2164:     }
1.256     matthew  2165:     return ($fh,$filename)
1.113     bowersj2 2166: }
                   2167: 
                   2168: 
1.256     matthew  2169: =pod 
1.113     bowersj2 2170: 
                   2171: =back
                   2172: 
                   2173: =cut
1.37      matthew  2174: 
                   2175: ###############################################################
1.33      matthew  2176: ##        Home server <option> list generating code          ##
                   2177: ###############################################################
1.35      matthew  2178: 
1.169     www      2179: # ------------------------------------------
                   2180: 
                   2181: sub domain_select {
                   2182:     my ($name,$value,$multiple)=@_;
                   2183:     my %domains=map { 
1.514     albertel 2184: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 2185:     } &Apache::lonnet::all_domains();
1.169     www      2186:     if ($multiple) {
                   2187: 	$domains{''}=&mt('Any domain');
1.550     albertel 2188: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 2189: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      2190:     } else {
1.550     albertel 2191: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970     raeburn  2192: 	return &select_form($name,$value,\%domains);
1.169     www      2193:     }
                   2194: }
                   2195: 
1.282     albertel 2196: #-------------------------------------------
                   2197: 
                   2198: =pod
                   2199: 
1.519     raeburn  2200: =head1 Routines for form select boxes
                   2201: 
                   2202: =over 4
                   2203: 
1.648     raeburn  2204: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 2205: 
                   2206: Returns a string containing a <select> element int multiple mode
                   2207: 
                   2208: 
                   2209: Args:
                   2210:   $name - name of the <select> element
1.506     raeburn  2211:   $value - scalar or array ref of values that should already be selected
1.282     albertel 2212:   $size - number of rows long the select element is
1.283     albertel 2213:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 2214:           (shown text should already have been &mt())
1.506     raeburn  2215:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 2216: 
1.282     albertel 2217: =cut
                   2218: 
                   2219: #-------------------------------------------
1.169     www      2220: sub multiple_select_form {
1.284     albertel 2221:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      2222:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   2223:     my $output='';
1.191     matthew  2224:     if (! defined($size)) {
                   2225:         $size = 4;
1.283     albertel 2226:         if (scalar(keys(%$hash))<4) {
                   2227:             $size = scalar(keys(%$hash));
1.191     matthew  2228:         }
                   2229:     }
1.734     bisitz   2230:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 2231:     my @order;
1.506     raeburn  2232:     if (ref($order) eq 'ARRAY')  {
                   2233:         @order = @{$order};
                   2234:     } else {
                   2235:         @order = sort(keys(%$hash));
1.501     banghart 2236:     }
                   2237:     if (exists($$hash{'select_form_order'})) {
                   2238:         @order = @{$$hash{'select_form_order'}};
                   2239:     }
                   2240:         
1.284     albertel 2241:     foreach my $key (@order) {
1.356     albertel 2242:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 2243:         $output.='selected="selected" ' if ($selected{$key});
                   2244:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      2245:     }
                   2246:     $output.="</select>\n";
                   2247:     return $output;
                   2248: }
                   2249: 
1.88      www      2250: #-------------------------------------------
                   2251: 
                   2252: =pod
                   2253: 
1.1075.2.115  raeburn  2254: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88      www      2255: 
                   2256: Returns a string containing a <select name='$name' size='1'> form to 
1.970     raeburn  2257: allow a user to select options from a ref to a hash containing:
                   2258: option_name => displayed text. An optional $onchange can include
1.1075.2.115  raeburn  2259: a javascript onchange item, e.g., onchange="this.form.submit();".
                   2260: An optional arg -- $readonly -- if true will cause the select form
                   2261: to be disabled, e.g., for the case where an instructor has a section-
                   2262: specific role, and is viewing/modifying parameters.  
1.970     raeburn  2263: 
1.88      www      2264: See lonrights.pm for an example invocation and use.
                   2265: 
                   2266: =cut
                   2267: 
                   2268: #-------------------------------------------
                   2269: sub select_form {
1.1075.2.115  raeburn  2270:     my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970     raeburn  2271:     return unless (ref($hashref) eq 'HASH');
                   2272:     if ($onchange) {
                   2273:         $onchange = ' onchange="'.$onchange.'"';
                   2274:     }
1.1075.2.129  raeburn  2275:     my $disabled;
                   2276:     if ($readonly) {
                   2277:         $disabled = ' disabled="disabled"';
                   2278:     }
                   2279:     my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128     albertel 2280:     my @keys;
1.970     raeburn  2281:     if (exists($hashref->{'select_form_order'})) {
                   2282: 	@keys=@{$hashref->{'select_form_order'}};
1.128     albertel 2283:     } else {
1.970     raeburn  2284: 	@keys=sort(keys(%{$hashref}));
1.128     albertel 2285:     }
1.356     albertel 2286:     foreach my $key (@keys) {
                   2287:         $selectform.=
                   2288: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   2289:             ($key eq $def ? 'selected="selected" ' : '').
1.970     raeburn  2290:                 ">".$hashref->{$key}."</option>\n";
1.88      www      2291:     }
                   2292:     $selectform.="</select>";
                   2293:     return $selectform;
                   2294: }
                   2295: 
1.475     www      2296: # For display filters
                   2297: 
                   2298: sub display_filter {
1.1074    raeburn  2299:     my ($context) = @_;
1.475     www      2300:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      2301:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074    raeburn  2302:     my $phraseinput = 'hidden';
                   2303:     my $includeinput = 'hidden';
                   2304:     my ($checked,$includetypestext);
                   2305:     if ($env{'form.displayfilter'} eq 'containing') {
                   2306:         $phraseinput = 'text'; 
                   2307:         if ($context eq 'parmslog') {
                   2308:             $includeinput = 'checkbox';
                   2309:             if ($env{'form.includetypes'}) {
                   2310:                 $checked = ' checked="checked"';
                   2311:             }
                   2312:             $includetypestext = &mt('Include parameter types');
                   2313:         }
                   2314:     } else {
                   2315:         $includetypestext = '&nbsp;';
                   2316:     }
                   2317:     my ($additional,$secondid,$thirdid);
                   2318:     if ($context eq 'parmslog') {
                   2319:         $additional = 
                   2320:             '<label><input type="'.$includeinput.'" name="includetypes"'. 
                   2321:             $checked.' name="includetypes" value="1" id="includetypes" />'.
                   2322:             '&nbsp;<span id="includetypestext">'.$includetypestext.'</span>'.
                   2323:             '</label>';
                   2324:         $secondid = 'includetypes';
                   2325:         $thirdid = 'includetypestext';
                   2326:     }
                   2327:     my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
                   2328:                                                     '$secondid','$thirdid')";
                   2329:     return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475     www      2330: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   2331: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   2332: 	   '</label></span> <span class="LC_nobreak">'.
1.1074    raeburn  2333:            &mt('Filter: [_1]',
1.477     www      2334: 	   &select_form($env{'form.displayfilter'},
                   2335: 			'displayfilter',
1.970     raeburn  2336: 			{'currentfolder' => 'Current folder/page',
1.477     www      2337: 			 'containing' => 'Containing phrase',
1.1074    raeburn  2338: 			 'none' => 'None'},$onchange)).'&nbsp;'.
                   2339: 			 '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
                   2340:                          &HTML::Entities::encode($env{'form.containingphrase'}).
                   2341:                          '" />'.$additional;
                   2342: }
                   2343: 
                   2344: sub display_filter_js {
                   2345:     my $includetext = &mt('Include parameter types');
                   2346:     return <<"ENDJS";
                   2347:   
                   2348: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
                   2349:     var firstType = 'hidden';
                   2350:     if (setter.options[setter.selectedIndex].value == 'containing') {
                   2351:         firstType = 'text';
                   2352:     }
                   2353:     firstObject = document.getElementById(firstid);
                   2354:     if (typeof(firstObject) == 'object') {
                   2355:         if (firstObject.type != firstType) {
                   2356:             changeInputType(firstObject,firstType);
                   2357:         }
                   2358:     }
                   2359:     if (context == 'parmslog') {
                   2360:         var secondType = 'hidden';
                   2361:         if (firstType == 'text') {
                   2362:             secondType = 'checkbox';
                   2363:         }
                   2364:         secondObject = document.getElementById(secondid);  
                   2365:         if (typeof(secondObject) == 'object') {
                   2366:             if (secondObject.type != secondType) {
                   2367:                 changeInputType(secondObject,secondType);
                   2368:             }
                   2369:         }
                   2370:         var textItem = document.getElementById(thirdid);
                   2371:         var currtext = textItem.innerHTML;
                   2372:         var newtext;
                   2373:         if (firstType == 'text') {
                   2374:             newtext = '$includetext';
                   2375:         } else {
                   2376:             newtext = '&nbsp;';
                   2377:         }
                   2378:         if (currtext != newtext) {
                   2379:             textItem.innerHTML = newtext;
                   2380:         }
                   2381:     }
                   2382:     return;
                   2383: }
                   2384: 
                   2385: function changeInputType(oldObject,newType) {
                   2386:     var newObject = document.createElement('input');
                   2387:     newObject.type = newType;
                   2388:     if (oldObject.size) {
                   2389:         newObject.size = oldObject.size;
                   2390:     }
                   2391:     if (oldObject.value) {
                   2392:         newObject.value = oldObject.value;
                   2393:     }
                   2394:     if (oldObject.name) {
                   2395:         newObject.name = oldObject.name;
                   2396:     }
                   2397:     if (oldObject.id) {
                   2398:         newObject.id = oldObject.id;
                   2399:     }
                   2400:     oldObject.parentNode.replaceChild(newObject,oldObject);
                   2401:     return;
                   2402: }
                   2403: 
                   2404: ENDJS
1.475     www      2405: }
                   2406: 
1.167     www      2407: sub gradeleveldescription {
                   2408:     my $gradelevel=shift;
                   2409:     my %gradelevels=(0 => 'Not specified',
                   2410: 		     1 => 'Grade 1',
                   2411: 		     2 => 'Grade 2',
                   2412: 		     3 => 'Grade 3',
                   2413: 		     4 => 'Grade 4',
                   2414: 		     5 => 'Grade 5',
                   2415: 		     6 => 'Grade 6',
                   2416: 		     7 => 'Grade 7',
                   2417: 		     8 => 'Grade 8',
                   2418: 		     9 => 'Grade 9',
                   2419: 		     10 => 'Grade 10',
                   2420: 		     11 => 'Grade 11',
                   2421: 		     12 => 'Grade 12',
                   2422: 		     13 => 'Grade 13',
                   2423: 		     14 => '100 Level',
                   2424: 		     15 => '200 Level',
                   2425: 		     16 => '300 Level',
                   2426: 		     17 => '400 Level',
                   2427: 		     18 => 'Graduate Level');
                   2428:     return &mt($gradelevels{$gradelevel});
                   2429: }
                   2430: 
1.163     www      2431: sub select_level_form {
                   2432:     my ($deflevel,$name)=@_;
                   2433:     unless ($deflevel) { $deflevel=0; }
1.167     www      2434:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   2435:     for (my $i=0; $i<=18; $i++) {
                   2436:         $selectform.="<option value=\"$i\" ".
1.253     albertel 2437:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      2438:                 ">".&gradeleveldescription($i)."</option>\n";
                   2439:     }
                   2440:     $selectform.="</select>";
                   2441:     return $selectform;
1.163     www      2442: }
1.167     www      2443: 
1.35      matthew  2444: #-------------------------------------------
                   2445: 
1.45      matthew  2446: =pod
                   2447: 
1.1075.2.115  raeburn  2448: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35      matthew  2449: 
                   2450: Returns a string containing a <select name='$name' size='1'> form to 
                   2451: allow a user to select the domain to preform an operation in.  
                   2452: See loncreateuser.pm for an example invocation and use.
                   2453: 
1.90      www      2454: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   2455: selected");
                   2456: 
1.743     raeburn  2457: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   2458: 
1.910     raeburn  2459: 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.
                   2460: 
1.1075.2.36  raeburn  2461: The optional $incdoms is a reference to an array of domains which will be the only available options.
                   2462: 
1.1075.2.115  raeburn  2463: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
                   2464: 
                   2465: The optional $disabled argument, if true, adds the disabled attribute to the select tag. 
1.563     raeburn  2466: 
1.35      matthew  2467: =cut
                   2468: 
                   2469: #-------------------------------------------
1.34      matthew  2470: sub select_dom_form {
1.1075.2.115  raeburn  2471:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872     raeburn  2472:     if ($onchange) {
1.874     raeburn  2473:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  2474:     }
1.1075.2.115  raeburn  2475:     if ($disabled) {
                   2476:         $disabled = ' disabled="disabled"';
                   2477:     }
1.1075.2.36  raeburn  2478:     my (@domains,%exclude);
1.910     raeburn  2479:     if (ref($incdoms) eq 'ARRAY') {
                   2480:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   2481:     } else {
                   2482:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   2483:     }
1.90      www      2484:     if ($includeempty) { @domains=('',@domains); }
1.1075.2.36  raeburn  2485:     if (ref($excdoms) eq 'ARRAY') {
                   2486:         map { $exclude{$_} = 1; } @{$excdoms};
                   2487:     }
1.1075.2.115  raeburn  2488:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356     albertel 2489:     foreach my $dom (@domains) {
1.1075.2.36  raeburn  2490:         next if ($exclude{$dom});
1.356     albertel 2491:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  2492:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   2493:         if ($showdomdesc) {
                   2494:             if ($dom ne '') {
                   2495:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   2496:                 if ($domdesc ne '') {
                   2497:                     $selectdomain .= ' ('.$domdesc.')';
                   2498:                 }
                   2499:             } 
                   2500:         }
                   2501:         $selectdomain .= "</option>\n";
1.34      matthew  2502:     }
                   2503:     $selectdomain.="</select>";
                   2504:     return $selectdomain;
                   2505: }
                   2506: 
1.35      matthew  2507: #-------------------------------------------
                   2508: 
1.45      matthew  2509: =pod
                   2510: 
1.648     raeburn  2511: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2512: 
1.586     raeburn  2513: input: 4 arguments (two required, two optional) - 
                   2514:     $domain - domain of new user
                   2515:     $name - name of form element
                   2516:     $default - Value of 'default' causes a default item to be first 
                   2517:                             option, and selected by default. 
                   2518:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2519:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2520: output: returns 2 items: 
1.586     raeburn  2521: (a) form element which contains either:
                   2522:    (i) <select name="$name">
                   2523:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2524:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2525:        </select>
                   2526:        form item if there are multiple library servers in $domain, or
                   2527:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2528:        if there is only one library server in $domain.
                   2529: 
                   2530: (b) number of library servers found.
                   2531: 
                   2532: See loncreateuser.pm for example of use.
1.35      matthew  2533: 
                   2534: =cut
                   2535: 
                   2536: #-------------------------------------------
1.586     raeburn  2537: sub home_server_form_item {
                   2538:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2539:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2540:     my $result;
                   2541:     my $numlib = keys(%servers);
                   2542:     if ($numlib > 1) {
                   2543:         $result .= '<select name="'.$name.'" />'."\n";
                   2544:         if ($default) {
1.804     bisitz   2545:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2546:                        '</option>'."\n";
                   2547:         }
                   2548:         foreach my $hostid (sort(keys(%servers))) {
                   2549:             $result.= '<option value="'.$hostid.'">'.
                   2550: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2551:         }
                   2552:         $result .= '</select>'."\n";
                   2553:     } elsif ($numlib == 1) {
                   2554:         my $hostid;
                   2555:         foreach my $item (keys(%servers)) {
                   2556:             $hostid = $item;
                   2557:         }
                   2558:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2559:                    $hostid.'" />';
                   2560:                    if (!$hide) {
                   2561:                        $result .= $hostid.' '.$servers{$hostid};
                   2562:                    }
                   2563:                    $result .= "\n";
                   2564:     } elsif ($default) {
                   2565:         $result .= '<input type="hidden" name="'.$name.
                   2566:                    '" value="default" />';
                   2567:                    if (!$hide) {
                   2568:                        $result .= &mt('default');
                   2569:                    }
                   2570:                    $result .= "\n";
1.33      matthew  2571:     }
1.586     raeburn  2572:     return ($result,$numlib);
1.33      matthew  2573: }
1.112     bowersj2 2574: 
                   2575: =pod
                   2576: 
1.534     albertel 2577: =back 
                   2578: 
1.112     bowersj2 2579: =cut
1.87      matthew  2580: 
                   2581: ###############################################################
1.112     bowersj2 2582: ##                  Decoding User Agent                      ##
1.87      matthew  2583: ###############################################################
                   2584: 
                   2585: =pod
                   2586: 
1.112     bowersj2 2587: =head1 Decoding the User Agent
                   2588: 
                   2589: =over 4
                   2590: 
                   2591: =item * &decode_user_agent()
1.87      matthew  2592: 
                   2593: Inputs: $r
                   2594: 
                   2595: Outputs:
                   2596: 
                   2597: =over 4
                   2598: 
1.112     bowersj2 2599: =item * $httpbrowser
1.87      matthew  2600: 
1.112     bowersj2 2601: =item * $clientbrowser
1.87      matthew  2602: 
1.112     bowersj2 2603: =item * $clientversion
1.87      matthew  2604: 
1.112     bowersj2 2605: =item * $clientmathml
1.87      matthew  2606: 
1.112     bowersj2 2607: =item * $clientunicode
1.87      matthew  2608: 
1.112     bowersj2 2609: =item * $clientos
1.87      matthew  2610: 
1.1075.2.42  raeburn  2611: =item * $clientmobile
                   2612: 
                   2613: =item * $clientinfo
                   2614: 
1.1075.2.77  raeburn  2615: =item * $clientosversion
                   2616: 
1.87      matthew  2617: =back
                   2618: 
1.157     matthew  2619: =back 
                   2620: 
1.87      matthew  2621: =cut
                   2622: 
                   2623: ###############################################################
                   2624: ###############################################################
                   2625: sub decode_user_agent {
1.247     albertel 2626:     my ($r)=@_;
1.87      matthew  2627:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2628:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2629:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2630:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2631:     my $clientbrowser='unknown';
                   2632:     my $clientversion='0';
                   2633:     my $clientmathml='';
                   2634:     my $clientunicode='0';
1.1075.2.42  raeburn  2635:     my $clientmobile=0;
1.1075.2.77  raeburn  2636:     my $clientosversion='';
1.87      matthew  2637:     for (my $i=0;$i<=$#browsertype;$i++) {
1.1075.2.76  raeburn  2638:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87      matthew  2639: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2640: 	    $clientbrowser=$bname;
                   2641:             $httpbrowser=~/$vreg/i;
                   2642: 	    $clientversion=$1;
                   2643:             $clientmathml=($clientversion>=$minv);
                   2644:             $clientunicode=($clientversion>=$univ);
                   2645: 	}
                   2646:     }
                   2647:     my $clientos='unknown';
1.1075.2.42  raeburn  2648:     my $clientinfo;
1.87      matthew  2649:     if (($httpbrowser=~/linux/i) ||
                   2650:         ($httpbrowser=~/unix/i) ||
                   2651:         ($httpbrowser=~/ux/i) ||
                   2652:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2653:     if (($httpbrowser=~/vax/i) ||
                   2654:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2655:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2656:     if (($httpbrowser=~/mac/i) ||
                   2657:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1075.2.77  raeburn  2658:     if ($httpbrowser=~/win/i) {
                   2659:         $clientos='win';
                   2660:         if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
                   2661:             $clientosversion = $1;
                   2662:         }
                   2663:     }
1.87      matthew  2664:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1075.2.42  raeburn  2665:     if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
                   2666:         $clientmobile=lc($1);
                   2667:     }
                   2668:     if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
                   2669:         $clientinfo = 'firefox-'.$1;
                   2670:     } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
                   2671:         $clientinfo = 'chromeframe-'.$1;
                   2672:     }
1.87      matthew  2673:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1075.2.77  raeburn  2674:             $clientunicode,$clientos,$clientmobile,$clientinfo,
                   2675:             $clientosversion);
1.87      matthew  2676: }
                   2677: 
1.32      matthew  2678: ###############################################################
                   2679: ##    Authentication changing form generation subroutines    ##
                   2680: ###############################################################
                   2681: ##
                   2682: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2683: ## hash, and have reasonable default values.
                   2684: ##
                   2685: ##    formname = the name given in the <form> tag.
1.35      matthew  2686: #-------------------------------------------
                   2687: 
1.45      matthew  2688: =pod
                   2689: 
1.112     bowersj2 2690: =head1 Authentication Routines
                   2691: 
                   2692: =over 4
                   2693: 
1.648     raeburn  2694: =item * &authform_xxxxxx()
1.35      matthew  2695: 
                   2696: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2697: handle some of the conveniences required for authentication forms.  
                   2698: This is not an optimal method, but it works.  
                   2699: 
                   2700: =over 4
                   2701: 
1.112     bowersj2 2702: =item * authform_header
1.35      matthew  2703: 
1.112     bowersj2 2704: =item * authform_authorwarning
1.35      matthew  2705: 
1.112     bowersj2 2706: =item * authform_nochange
1.35      matthew  2707: 
1.112     bowersj2 2708: =item * authform_kerberos
1.35      matthew  2709: 
1.112     bowersj2 2710: =item * authform_internal
1.35      matthew  2711: 
1.112     bowersj2 2712: =item * authform_filesystem
1.35      matthew  2713: 
                   2714: =back
                   2715: 
1.648     raeburn  2716: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2717: 
1.35      matthew  2718: =cut
                   2719: 
                   2720: #-------------------------------------------
1.32      matthew  2721: sub authform_header{  
                   2722:     my %in = (
                   2723:         formname => 'cu',
1.80      albertel 2724:         kerb_def_dom => '',
1.32      matthew  2725:         @_,
                   2726:     );
                   2727:     $in{'formname'} = 'document.' . $in{'formname'};
                   2728:     my $result='';
1.80      albertel 2729: 
                   2730: #---------------------------------------------- Code for upper case translation
                   2731:     my $Javascript_toUpperCase;
                   2732:     unless ($in{kerb_def_dom}) {
                   2733:         $Javascript_toUpperCase =<<"END";
                   2734:         switch (choice) {
                   2735:            case 'krb': currentform.elements[choicearg].value =
                   2736:                currentform.elements[choicearg].value.toUpperCase();
                   2737:                break;
                   2738:            default:
                   2739:         }
                   2740: END
                   2741:     } else {
                   2742:         $Javascript_toUpperCase = "";
                   2743:     }
                   2744: 
1.165     raeburn  2745:     my $radioval = "'nochange'";
1.591     raeburn  2746:     if (defined($in{'curr_authtype'})) {
                   2747:         if ($in{'curr_authtype'} ne '') {
                   2748:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2749:         }
1.174     matthew  2750:     }
1.165     raeburn  2751:     my $argfield = 'null';
1.591     raeburn  2752:     if (defined($in{'mode'})) {
1.165     raeburn  2753:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2754:             if (defined($in{'curr_autharg'})) {
                   2755:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2756:                     $argfield = "'$in{'curr_autharg'}'";
                   2757:                 }
                   2758:             }
                   2759:         }
                   2760:     }
                   2761: 
1.32      matthew  2762:     $result.=<<"END";
                   2763: var current = new Object();
1.165     raeburn  2764: current.radiovalue = $radioval;
                   2765: current.argfield = $argfield;
1.32      matthew  2766: 
                   2767: function changed_radio(choice,currentform) {
                   2768:     var choicearg = choice + 'arg';
                   2769:     // If a radio button in changed, we need to change the argfield
                   2770:     if (current.radiovalue != choice) {
                   2771:         current.radiovalue = choice;
                   2772:         if (current.argfield != null) {
                   2773:             currentform.elements[current.argfield].value = '';
                   2774:         }
                   2775:         if (choice == 'nochange') {
                   2776:             current.argfield = null;
                   2777:         } else {
                   2778:             current.argfield = choicearg;
                   2779:             switch(choice) {
                   2780:                 case 'krb': 
                   2781:                     currentform.elements[current.argfield].value = 
                   2782:                         "$in{'kerb_def_dom'}";
                   2783:                 break;
                   2784:               default:
                   2785:                 break;
                   2786:             }
                   2787:         }
                   2788:     }
                   2789:     return;
                   2790: }
1.22      www      2791: 
1.32      matthew  2792: function changed_text(choice,currentform) {
                   2793:     var choicearg = choice + 'arg';
                   2794:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2795:         $Javascript_toUpperCase
1.32      matthew  2796:         // clear old field
                   2797:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2798:             currentform.elements[current.argfield].value = '';
                   2799:         }
                   2800:         current.argfield = choicearg;
                   2801:     }
                   2802:     set_auth_radio_buttons(choice,currentform);
                   2803:     return;
1.20      www      2804: }
1.32      matthew  2805: 
                   2806: function set_auth_radio_buttons(newvalue,currentform) {
1.986     raeburn  2807:     var numauthchoices = currentform.login.length;
                   2808:     if (typeof numauthchoices  == "undefined") {
                   2809:         return;
                   2810:     } 
1.32      matthew  2811:     var i=0;
1.986     raeburn  2812:     while (i < numauthchoices) {
1.32      matthew  2813:         if (currentform.login[i].value == newvalue) { break; }
                   2814:         i++;
                   2815:     }
1.986     raeburn  2816:     if (i == numauthchoices) {
1.32      matthew  2817:         return;
                   2818:     }
                   2819:     current.radiovalue = newvalue;
                   2820:     currentform.login[i].checked = true;
                   2821:     return;
                   2822: }
                   2823: END
                   2824:     return $result;
                   2825: }
                   2826: 
1.1075.2.20  raeburn  2827: sub authform_authorwarning {
1.32      matthew  2828:     my $result='';
1.144     matthew  2829:     $result='<i>'.
                   2830:         &mt('As a general rule, only authors or co-authors should be '.
                   2831:             'filesystem authenticated '.
                   2832:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2833:     return $result;
                   2834: }
                   2835: 
1.1075.2.20  raeburn  2836: sub authform_nochange {
1.32      matthew  2837:     my %in = (
                   2838:               formname => 'document.cu',
                   2839:               kerb_def_dom => 'MSU.EDU',
                   2840:               @_,
                   2841:           );
1.1075.2.20  raeburn  2842:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'}); 
1.586     raeburn  2843:     my $result;
1.1075.2.20  raeburn  2844:     if (!$authnum) {
                   2845:         $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586     raeburn  2846:     } else {
                   2847:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2848:                   '<input type="radio" name="login" value="nochange" '.
                   2849:                   'checked="checked" onclick="'.
1.281     albertel 2850:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2851: 	    '</label>';
1.586     raeburn  2852:     }
1.32      matthew  2853:     return $result;
                   2854: }
                   2855: 
1.591     raeburn  2856: sub authform_kerberos {
1.32      matthew  2857:     my %in = (
                   2858:               formname => 'document.cu',
                   2859:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2860:               kerb_def_auth => 'krb4',
1.32      matthew  2861:               @_,
                   2862:               );
1.586     raeburn  2863:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1075.2.117  raeburn  2864:         $autharg,$jscall,$disabled);
1.1075.2.20  raeburn  2865:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80      albertel 2866:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2867:        $check5 = ' checked="checked"';
1.80      albertel 2868:     } else {
1.772     bisitz   2869:        $check4 = ' checked="checked"';
1.80      albertel 2870:     }
1.1075.2.117  raeburn  2871:     if ($in{'readonly'}) {
                   2872:         $disabled = ' disabled="disabled"';
                   2873:     }
1.165     raeburn  2874:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2875:     if (defined($in{'curr_authtype'})) {
                   2876:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2877:             $krbcheck = ' checked="checked"';
1.623     raeburn  2878:             if (defined($in{'mode'})) {
                   2879:                 if ($in{'mode'} eq 'modifyuser') {
                   2880:                     $krbcheck = '';
                   2881:                 }
                   2882:             }
1.591     raeburn  2883:             if (defined($in{'curr_kerb_ver'})) {
                   2884:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2885:                     $check5 = ' checked="checked"';
1.591     raeburn  2886:                     $check4 = '';
                   2887:                 } else {
1.772     bisitz   2888:                     $check4 = ' checked="checked"';
1.591     raeburn  2889:                     $check5 = '';
                   2890:                 }
1.586     raeburn  2891:             }
1.591     raeburn  2892:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2893:                 $krbarg = $in{'curr_autharg'};
                   2894:             }
1.586     raeburn  2895:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2896:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2897:                     $result = 
                   2898:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2899:         $in{'curr_autharg'},$krbver);
                   2900:                 } else {
                   2901:                     $result =
                   2902:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2903:                 }
                   2904:                 return $result; 
                   2905:             }
                   2906:         }
                   2907:     } else {
                   2908:         if ($authnum == 1) {
1.784     bisitz   2909:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2910:         }
                   2911:     }
1.586     raeburn  2912:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2913:         return;
1.587     raeburn  2914:     } elsif ($authtype eq '') {
1.591     raeburn  2915:         if (defined($in{'mode'})) {
1.587     raeburn  2916:             if ($in{'mode'} eq 'modifycourse') {
                   2917:                 if ($authnum == 1) {
1.1075.2.117  raeburn  2918:                     $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587     raeburn  2919:                 }
                   2920:             }
                   2921:         }
1.586     raeburn  2922:     }
                   2923:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2924:     if ($authtype eq '') {
                   2925:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2926:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1075.2.117  raeburn  2927:                     $krbcheck.$disabled.' />';
1.586     raeburn  2928:     }
                   2929:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1075.2.20  raeburn  2930:         ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586     raeburn  2931:          $in{'curr_authtype'} eq 'krb5') ||
1.1075.2.20  raeburn  2932:         (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586     raeburn  2933:          $in{'curr_authtype'} eq 'krb4')) {
                   2934:         $result .= &mt
1.144     matthew  2935:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2936:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2937:          '<label>'.$authtype,
1.281     albertel 2938:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2939:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2940:              'onchange="'.$jscall.'"'.$disabled.' />',
                   2941:          '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
                   2942:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281     albertel 2943: 	 '</label>');
1.586     raeburn  2944:     } elsif ($can_assign{'krb4'}) {
                   2945:         $result .= &mt
                   2946:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2947:          '[_3] Version 4 [_4]',
                   2948:          '<label>'.$authtype,
                   2949:          '</label><input type="text" size="10" name="krbarg" '.
                   2950:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2951:              'onchange="'.$jscall.'"'.$disabled.' />',
1.586     raeburn  2952:          '<label><input type="hidden" name="krbver" value="4" />',
                   2953:          '</label>');
                   2954:     } elsif ($can_assign{'krb5'}) {
                   2955:         $result .= &mt
                   2956:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2957:          '[_3] Version 5 [_4]',
                   2958:          '<label>'.$authtype,
                   2959:          '</label><input type="text" size="10" name="krbarg" '.
                   2960:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2961:              'onchange="'.$jscall.'"'.$disabled.' />',
1.586     raeburn  2962:          '<label><input type="hidden" name="krbver" value="5" />',
                   2963:          '</label>');
                   2964:     }
1.32      matthew  2965:     return $result;
                   2966: }
                   2967: 
1.1075.2.20  raeburn  2968: sub authform_internal {
1.586     raeburn  2969:     my %in = (
1.32      matthew  2970:                 formname => 'document.cu',
                   2971:                 kerb_def_dom => 'MSU.EDU',
                   2972:                 @_,
                   2973:                 );
1.1075.2.117  raeburn  2974:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  2975:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  2976:     if ($in{'readonly'}) {
                   2977:         $disabled = ' disabled="disabled"';
                   2978:     }
1.591     raeburn  2979:     if (defined($in{'curr_authtype'})) {
                   2980:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2981:             if ($can_assign{'int'}) {
1.772     bisitz   2982:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2983:                 if (defined($in{'mode'})) {
                   2984:                     if ($in{'mode'} eq 'modifyuser') {
                   2985:                         $intcheck = '';
                   2986:                     }
                   2987:                 }
1.591     raeburn  2988:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2989:                     $intarg = $in{'curr_autharg'};
                   2990:                 }
                   2991:             } else {
                   2992:                 $result = &mt('Currently internally authenticated.');
                   2993:                 return $result;
1.165     raeburn  2994:             }
                   2995:         }
1.586     raeburn  2996:     } else {
                   2997:         if ($authnum == 1) {
1.784     bisitz   2998:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2999:         }
                   3000:     }
                   3001:     if (!$can_assign{'int'}) {
                   3002:         return;
1.587     raeburn  3003:     } elsif ($authtype eq '') {
1.591     raeburn  3004:         if (defined($in{'mode'})) {
1.587     raeburn  3005:             if ($in{'mode'} eq 'modifycourse') {
                   3006:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3007:                     $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587     raeburn  3008:                 }
                   3009:             }
                   3010:         }
1.165     raeburn  3011:     }
1.586     raeburn  3012:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   3013:     if ($authtype eq '') {
                   3014:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1075.2.117  raeburn  3015:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3016:     }
1.605     bisitz   3017:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1075.2.117  raeburn  3018:                $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3019:     $result = &mt
1.144     matthew  3020:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  3021:          '<label>'.$authtype,'</label>'.$autharg);
1.1075.2.118  raeburn  3022:     $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  3023:     return $result;
                   3024: }
                   3025: 
1.1075.2.20  raeburn  3026: sub authform_local {
1.32      matthew  3027:     my %in = (
                   3028:               formname => 'document.cu',
                   3029:               kerb_def_dom => 'MSU.EDU',
                   3030:               @_,
                   3031:               );
1.1075.2.117  raeburn  3032:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  3033:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  3034:     if ($in{'readonly'}) {
                   3035:         $disabled = ' disabled="disabled"';
                   3036:     }
1.591     raeburn  3037:     if (defined($in{'curr_authtype'})) {
                   3038:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  3039:             if ($can_assign{'loc'}) {
1.772     bisitz   3040:                 $loccheck = 'checked="checked" ';
1.623     raeburn  3041:                 if (defined($in{'mode'})) {
                   3042:                     if ($in{'mode'} eq 'modifyuser') {
                   3043:                         $loccheck = '';
                   3044:                     }
                   3045:                 }
1.591     raeburn  3046:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  3047:                     $locarg = $in{'curr_autharg'};
                   3048:                 }
                   3049:             } else {
                   3050:                 $result = &mt('Currently using local (institutional) authentication.');
                   3051:                 return $result;
1.165     raeburn  3052:             }
                   3053:         }
1.586     raeburn  3054:     } else {
                   3055:         if ($authnum == 1) {
1.784     bisitz   3056:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  3057:         }
                   3058:     }
                   3059:     if (!$can_assign{'loc'}) {
                   3060:         return;
1.587     raeburn  3061:     } elsif ($authtype eq '') {
1.591     raeburn  3062:         if (defined($in{'mode'})) {
1.587     raeburn  3063:             if ($in{'mode'} eq 'modifycourse') {
                   3064:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3065:                     $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587     raeburn  3066:                 }
                   3067:             }
                   3068:         }
1.165     raeburn  3069:     }
1.586     raeburn  3070:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   3071:     if ($authtype eq '') {
                   3072:         $authtype = '<input type="radio" name="login" value="loc" '.
                   3073:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1075.2.117  raeburn  3074:                     $jscall.'"'.$disabled.' />';
1.586     raeburn  3075:     }
                   3076:     $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1075.2.117  raeburn  3077:                $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3078:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   3079:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  3080:     return $result;
                   3081: }
                   3082: 
1.1075.2.20  raeburn  3083: sub authform_filesystem {
1.32      matthew  3084:     my %in = (
                   3085:               formname => 'document.cu',
                   3086:               kerb_def_dom => 'MSU.EDU',
                   3087:               @_,
                   3088:               );
1.1075.2.117  raeburn  3089:     my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  3090:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  3091:     if ($in{'readonly'}) {
                   3092:         $disabled = ' disabled="disabled"';
                   3093:     }
1.591     raeburn  3094:     if (defined($in{'curr_authtype'})) {
                   3095:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  3096:             if ($can_assign{'fsys'}) {
1.772     bisitz   3097:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  3098:                 if (defined($in{'mode'})) {
                   3099:                     if ($in{'mode'} eq 'modifyuser') {
                   3100:                         $fsyscheck = '';
                   3101:                     }
                   3102:                 }
1.586     raeburn  3103:             } else {
                   3104:                 $result = &mt('Currently Filesystem Authenticated.');
                   3105:                 return $result;
                   3106:             }           
                   3107:         }
                   3108:     } else {
                   3109:         if ($authnum == 1) {
1.784     bisitz   3110:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  3111:         }
                   3112:     }
                   3113:     if (!$can_assign{'fsys'}) {
                   3114:         return;
1.587     raeburn  3115:     } elsif ($authtype eq '') {
1.591     raeburn  3116:         if (defined($in{'mode'})) {
1.587     raeburn  3117:             if ($in{'mode'} eq 'modifycourse') {
                   3118:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3119:                     $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587     raeburn  3120:                 }
                   3121:             }
                   3122:         }
1.586     raeburn  3123:     }
                   3124:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   3125:     if ($authtype eq '') {
                   3126:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   3127:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1075.2.117  raeburn  3128:                     $jscall.'"'.$disabled.' />';
1.586     raeburn  3129:     }
                   3130:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
1.1075.2.117  raeburn  3131:                ' onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3132:     $result = &mt
1.144     matthew  3133:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 3134:          '<label><input type="radio" name="login" value="fsys" '.
1.1075.2.117  raeburn  3135:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />',
1.605     bisitz   3136:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.1075.2.117  raeburn  3137:                   'onchange="'.$jscall.'"'.$disabled.' />');
1.32      matthew  3138:     return $result;
                   3139: }
                   3140: 
1.586     raeburn  3141: sub get_assignable_auth {
                   3142:     my ($dom) = @_;
                   3143:     if ($dom eq '') {
                   3144:         $dom = $env{'request.role.domain'};
                   3145:     }
                   3146:     my %can_assign = (
                   3147:                           krb4 => 1,
                   3148:                           krb5 => 1,
                   3149:                           int  => 1,
                   3150:                           loc  => 1,
                   3151:                      );
                   3152:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   3153:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   3154:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   3155:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   3156:             my $context;
                   3157:             if ($env{'request.role'} =~ /^au/) {
                   3158:                 $context = 'author';
1.1075.2.117  raeburn  3159:             } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586     raeburn  3160:                 $context = 'domain';
                   3161:             } elsif ($env{'request.course.id'}) {
                   3162:                 $context = 'course';
                   3163:             }
                   3164:             if ($context) {
                   3165:                 if (ref($authhash->{$context}) eq 'HASH') {
                   3166:                    %can_assign = %{$authhash->{$context}}; 
                   3167:                 }
                   3168:             }
                   3169:         }
                   3170:     }
                   3171:     my $authnum = 0;
                   3172:     foreach my $key (keys(%can_assign)) {
                   3173:         if ($can_assign{$key}) {
                   3174:             $authnum ++;
                   3175:         }
                   3176:     }
                   3177:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   3178:         $authnum --;
                   3179:     }
                   3180:     return ($authnum,%can_assign);
                   3181: }
                   3182: 
1.1075.2.137  raeburn  3183: sub check_passwd_rules {
                   3184:     my ($domain,$plainpass) = @_;
                   3185:     my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
                   3186:     my ($min,$max,@chars,@brokerule,$warning);
1.1075.2.138  raeburn  3187:     $min = $Apache::lonnet::passwdmin;
1.1075.2.137  raeburn  3188:     if (ref($passwdconf{'chars'}) eq 'ARRAY') {
                   3189:         if ($passwdconf{'min'} =~ /^\d+$/) {
1.1075.2.138  raeburn  3190:             if ($passwdconf{'min'} > $min) {
                   3191:                 $min = $passwdconf{'min'};
                   3192:             }
1.1075.2.137  raeburn  3193:         }
                   3194:         if ($passwdconf{'max'} =~ /^\d+$/) {
                   3195:             $max = $passwdconf{'max'};
                   3196:         }
                   3197:         @chars = @{$passwdconf{'chars'}};
                   3198:     }
                   3199:     if (($min) && (length($plainpass) < $min)) {
                   3200:         push(@brokerule,'min');
                   3201:     }
                   3202:     if (($max) && (length($plainpass) > $max)) {
                   3203:         push(@brokerule,'max');
                   3204:     }
                   3205:     if (@chars) {
                   3206:         my %rules;
                   3207:         map { $rules{$_} = 1; } @chars;
                   3208:         if ($rules{'uc'}) {
                   3209:             unless ($plainpass =~ /[A-Z]/) {
                   3210:                 push(@brokerule,'uc');
                   3211:             }
                   3212:         }
                   3213:         if ($rules{'lc'}) {
                   3214:             unless ($plainpass =~ /[a-z]/) {
                   3215:                 push(@brokerule,'lc');
                   3216:             }
                   3217:         }
                   3218:         if ($rules{'num'}) {
                   3219:             unless ($plainpass =~ /\d/) {
                   3220:                 push(@brokerule,'num');
                   3221:             }
                   3222:         }
                   3223:         if ($rules{'spec'}) {
                   3224:             unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
                   3225:                 push(@brokerule,'spec');
                   3226:             }
                   3227:         }
                   3228:     }
                   3229:     if (@brokerule) {
                   3230:         my %rulenames = &Apache::lonlocal::texthash(
                   3231:             uc   => 'At least one upper case letter',
                   3232:             lc   => 'At least one lower case letter',
                   3233:             num  => 'At least one number',
                   3234:             spec => 'At least one non-alphanumeric',
                   3235:         );
                   3236:         $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
                   3237:         $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
                   3238:         $rulenames{'num'} .= ': 0123456789';
                   3239:         $rulenames{'spec'} .= ': !&quot;\#$%&amp;\'()*+,-./:;&lt;=&gt;?@[\]^_\`{|}~';
                   3240:         $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
                   3241:         $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
                   3242:         $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1075.2.143  raeburn  3243:         foreach my $rule ('min','max','uc','lc','num','spec') {
1.1075.2.137  raeburn  3244:             if (grep(/^$rule$/,@brokerule)) {
                   3245:                 $warning .= '<li>'.$rulenames{$rule}.'</li>';
                   3246:             }
                   3247:         }
                   3248:         $warning .= '</ul>';
                   3249:     }
                   3250:     if (wantarray) {
                   3251:         return @brokerule;
                   3252:     }
                   3253:     return $warning;
                   3254: }
                   3255: 
1.80      albertel 3256: ###############################################################
                   3257: ##    Get Kerberos Defaults for Domain                 ##
                   3258: ###############################################################
                   3259: ##
                   3260: ## Returns default kerberos version and an associated argument
                   3261: ## as listed in file domain.tab. If not listed, provides
                   3262: ## appropriate default domain and kerberos version.
                   3263: ##
                   3264: #-------------------------------------------
                   3265: 
                   3266: =pod
                   3267: 
1.648     raeburn  3268: =item * &get_kerberos_defaults()
1.80      albertel 3269: 
                   3270: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  3271: version and domain. If not found, it defaults to version 4 and the 
                   3272: domain of the server.
1.80      albertel 3273: 
1.648     raeburn  3274: =over 4
                   3275: 
1.80      albertel 3276: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   3277: 
1.648     raeburn  3278: =back
                   3279: 
                   3280: =back
                   3281: 
1.80      albertel 3282: =cut
                   3283: 
                   3284: #-------------------------------------------
                   3285: sub get_kerberos_defaults {
                   3286:     my $domain=shift;
1.641     raeburn  3287:     my ($krbdef,$krbdefdom);
                   3288:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   3289:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   3290:         $krbdef = $domdefaults{'auth_def'};
                   3291:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   3292:     } else {
1.80      albertel 3293:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   3294:         my $krbdefdom=$1;
                   3295:         $krbdefdom=~tr/a-z/A-Z/;
                   3296:         $krbdef = "krb4";
                   3297:     }
                   3298:     return ($krbdef,$krbdefdom);
                   3299: }
1.112     bowersj2 3300: 
1.32      matthew  3301: 
1.46      matthew  3302: ###############################################################
                   3303: ##                Thesaurus Functions                        ##
                   3304: ###############################################################
1.20      www      3305: 
1.46      matthew  3306: =pod
1.20      www      3307: 
1.112     bowersj2 3308: =head1 Thesaurus Functions
                   3309: 
                   3310: =over 4
                   3311: 
1.648     raeburn  3312: =item * &initialize_keywords()
1.46      matthew  3313: 
                   3314: Initializes the package variable %Keywords if it is empty.  Uses the
                   3315: package variable $thesaurus_db_file.
                   3316: 
                   3317: =cut
                   3318: 
                   3319: ###################################################
                   3320: 
                   3321: sub initialize_keywords {
                   3322:     return 1 if (scalar keys(%Keywords));
                   3323:     # If we are here, %Keywords is empty, so fill it up
                   3324:     #   Make sure the file we need exists...
                   3325:     if (! -e $thesaurus_db_file) {
                   3326:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   3327:                                  " failed because it does not exist");
                   3328:         return 0;
                   3329:     }
                   3330:     #   Set up the hash as a database
                   3331:     my %thesaurus_db;
                   3332:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3333:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3334:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   3335:                                  $thesaurus_db_file);
                   3336:         return 0;
                   3337:     } 
                   3338:     #  Get the average number of appearances of a word.
                   3339:     my $avecount = $thesaurus_db{'average.count'};
                   3340:     #  Put keywords (those that appear > average) into %Keywords
                   3341:     while (my ($word,$data)=each (%thesaurus_db)) {
                   3342:         my ($count,undef) = split /:/,$data;
                   3343:         $Keywords{$word}++ if ($count > $avecount);
                   3344:     }
                   3345:     untie %thesaurus_db;
                   3346:     # Remove special values from %Keywords.
1.356     albertel 3347:     foreach my $value ('total.count','average.count') {
                   3348:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  3349:   }
1.46      matthew  3350:     return 1;
                   3351: }
                   3352: 
                   3353: ###################################################
                   3354: 
                   3355: =pod
                   3356: 
1.648     raeburn  3357: =item * &keyword($word)
1.46      matthew  3358: 
                   3359: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   3360: than the average number of times in the thesaurus database.  Calls 
                   3361: &initialize_keywords
                   3362: 
                   3363: =cut
                   3364: 
                   3365: ###################################################
1.20      www      3366: 
                   3367: sub keyword {
1.46      matthew  3368:     return if (!&initialize_keywords());
                   3369:     my $word=lc(shift());
                   3370:     $word=~s/\W//g;
                   3371:     return exists($Keywords{$word});
1.20      www      3372: }
1.46      matthew  3373: 
                   3374: ###############################################################
                   3375: 
                   3376: =pod 
1.20      www      3377: 
1.648     raeburn  3378: =item * &get_related_words()
1.46      matthew  3379: 
1.160     matthew  3380: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  3381: an array of words.  If the keyword is not in the thesaurus, an empty array
                   3382: will be returned.  The order of the words returned is determined by the
                   3383: database which holds them.
                   3384: 
                   3385: Uses global $thesaurus_db_file.
                   3386: 
1.1057    foxr     3387: 
1.46      matthew  3388: =cut
                   3389: 
                   3390: ###############################################################
                   3391: sub get_related_words {
                   3392:     my $keyword = shift;
                   3393:     my %thesaurus_db;
                   3394:     if (! -e $thesaurus_db_file) {
                   3395:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   3396:                                  "failed because the file does not exist");
                   3397:         return ();
                   3398:     }
                   3399:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3400:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3401:         return ();
                   3402:     } 
                   3403:     my @Words=();
1.429     www      3404:     my $count=0;
1.46      matthew  3405:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 3406: 	# The first element is the number of times
                   3407: 	# the word appears.  We do not need it now.
1.429     www      3408: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   3409: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   3410: 	my $threshold=$mostfrequentcount/10;
                   3411:         foreach my $possibleword (@RelatedWords) {
                   3412:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   3413:             if ($wordcount>$threshold) {
                   3414: 		push(@Words,$word);
                   3415:                 $count++;
                   3416:                 if ($count>10) { last; }
                   3417: 	    }
1.20      www      3418:         }
                   3419:     }
1.46      matthew  3420:     untie %thesaurus_db;
                   3421:     return @Words;
1.14      harris41 3422: }
1.46      matthew  3423: 
1.112     bowersj2 3424: =pod
                   3425: 
                   3426: =back
                   3427: 
                   3428: =cut
1.61      www      3429: 
                   3430: # -------------------------------------------------------------- Plaintext name
1.81      albertel 3431: =pod
                   3432: 
1.112     bowersj2 3433: =head1 User Name Functions
                   3434: 
                   3435: =over 4
                   3436: 
1.648     raeburn  3437: =item * &plainname($uname,$udom,$first)
1.81      albertel 3438: 
1.112     bowersj2 3439: Takes a users logon name and returns it as a string in
1.226     albertel 3440: "first middle last generation" form 
                   3441: if $first is set to 'lastname' then it returns it as
                   3442: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 3443: 
                   3444: =cut
1.61      www      3445: 
1.295     www      3446: 
1.81      albertel 3447: ###############################################################
1.61      www      3448: sub plainname {
1.226     albertel 3449:     my ($uname,$udom,$first)=@_;
1.537     albertel 3450:     return if (!defined($uname) || !defined($udom));
1.295     www      3451:     my %names=&getnames($uname,$udom);
1.226     albertel 3452:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   3453: 					  $names{'middlename'},
                   3454: 					  $names{'lastname'},
                   3455: 					  $names{'generation'},$first);
                   3456:     $name=~s/^\s+//;
1.62      www      3457:     $name=~s/\s+$//;
                   3458:     $name=~s/\s+/ /g;
1.353     albertel 3459:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      3460:     return $name;
1.61      www      3461: }
1.66      www      3462: 
                   3463: # -------------------------------------------------------------------- Nickname
1.81      albertel 3464: =pod
                   3465: 
1.648     raeburn  3466: =item * &nickname($uname,$udom)
1.81      albertel 3467: 
                   3468: Gets a users name and returns it as a string as
                   3469: 
                   3470: "&quot;nickname&quot;"
1.66      www      3471: 
1.81      albertel 3472: if the user has a nickname or
                   3473: 
                   3474: "first middle last generation"
                   3475: 
                   3476: if the user does not
                   3477: 
                   3478: =cut
1.66      www      3479: 
                   3480: sub nickname {
                   3481:     my ($uname,$udom)=@_;
1.537     albertel 3482:     return if (!defined($uname) || !defined($udom));
1.295     www      3483:     my %names=&getnames($uname,$udom);
1.68      albertel 3484:     my $name=$names{'nickname'};
1.66      www      3485:     if ($name) {
                   3486:        $name='&quot;'.$name.'&quot;'; 
                   3487:     } else {
                   3488:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   3489: 	     $names{'lastname'}.' '.$names{'generation'};
                   3490:        $name=~s/\s+$//;
                   3491:        $name=~s/\s+/ /g;
                   3492:     }
                   3493:     return $name;
                   3494: }
                   3495: 
1.295     www      3496: sub getnames {
                   3497:     my ($uname,$udom)=@_;
1.537     albertel 3498:     return if (!defined($uname) || !defined($udom));
1.433     albertel 3499:     if ($udom eq 'public' && $uname eq 'public') {
                   3500: 	return ('lastname' => &mt('Public'));
                   3501:     }
1.295     www      3502:     my $id=$uname.':'.$udom;
                   3503:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   3504:     if ($cached) {
                   3505: 	return %{$names};
                   3506:     } else {
                   3507: 	my %loadnames=&Apache::lonnet::get('environment',
                   3508:                     ['firstname','middlename','lastname','generation','nickname'],
                   3509: 					 $udom,$uname);
                   3510: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   3511: 	return %loadnames;
                   3512:     }
                   3513: }
1.61      www      3514: 
1.542     raeburn  3515: # -------------------------------------------------------------------- getemails
1.648     raeburn  3516: 
1.542     raeburn  3517: =pod
                   3518: 
1.648     raeburn  3519: =item * &getemails($uname,$udom)
1.542     raeburn  3520: 
                   3521: Gets a user's email information and returns it as a hash with keys:
                   3522: notification, critnotification, permanentemail
                   3523: 
                   3524: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  3525: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  3526:  
1.648     raeburn  3527: 
1.542     raeburn  3528: =cut
                   3529: 
1.648     raeburn  3530: 
1.466     albertel 3531: sub getemails {
                   3532:     my ($uname,$udom)=@_;
                   3533:     if ($udom eq 'public' && $uname eq 'public') {
                   3534: 	return;
                   3535:     }
1.467     www      3536:     if (!$udom) { $udom=$env{'user.domain'}; }
                   3537:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 3538:     my $id=$uname.':'.$udom;
                   3539:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   3540:     if ($cached) {
                   3541: 	return %{$names};
                   3542:     } else {
                   3543: 	my %loadnames=&Apache::lonnet::get('environment',
                   3544:                     			   ['notification','critnotification',
                   3545: 					    'permanentemail'],
                   3546: 					   $udom,$uname);
                   3547: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   3548: 	return %loadnames;
                   3549:     }
                   3550: }
                   3551: 
1.551     albertel 3552: sub flush_email_cache {
                   3553:     my ($uname,$udom)=@_;
                   3554:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3555:     if (!$uname) { $uname=$env{'user.name'};   }
                   3556:     return if ($udom eq 'public' && $uname eq 'public');
                   3557:     my $id=$uname.':'.$udom;
                   3558:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   3559: }
                   3560: 
1.728     raeburn  3561: # -------------------------------------------------------------------- getlangs
                   3562: 
                   3563: =pod
                   3564: 
                   3565: =item * &getlangs($uname,$udom)
                   3566: 
                   3567: Gets a user's language preference and returns it as a hash with key:
                   3568: language.
                   3569: 
                   3570: =cut
                   3571: 
                   3572: 
                   3573: sub getlangs {
                   3574:     my ($uname,$udom) = @_;
                   3575:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3576:     if (!$uname) { $uname=$env{'user.name'};   }
                   3577:     my $id=$uname.':'.$udom;
                   3578:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   3579:     if ($cached) {
                   3580:         return %{$langs};
                   3581:     } else {
                   3582:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   3583:                                            $udom,$uname);
                   3584:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   3585:         return %loadlangs;
                   3586:     }
                   3587: }
                   3588: 
                   3589: sub flush_langs_cache {
                   3590:     my ($uname,$udom)=@_;
                   3591:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3592:     if (!$uname) { $uname=$env{'user.name'};   }
                   3593:     return if ($udom eq 'public' && $uname eq 'public');
                   3594:     my $id=$uname.':'.$udom;
                   3595:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   3596: }
                   3597: 
1.61      www      3598: # ------------------------------------------------------------------ Screenname
1.81      albertel 3599: 
                   3600: =pod
                   3601: 
1.648     raeburn  3602: =item * &screenname($uname,$udom)
1.81      albertel 3603: 
                   3604: Gets a users screenname and returns it as a string
                   3605: 
                   3606: =cut
1.61      www      3607: 
                   3608: sub screenname {
                   3609:     my ($uname,$udom)=@_;
1.258     albertel 3610:     if ($uname eq $env{'user.name'} &&
                   3611: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 3612:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 3613:     return $names{'screenname'};
1.62      www      3614: }
                   3615: 
1.212     albertel 3616: 
1.802     bisitz   3617: # ------------------------------------------------------------- Confirm Wrapper
                   3618: =pod
                   3619: 
1.1075.2.42  raeburn  3620: =item * &confirmwrapper($message)
1.802     bisitz   3621: 
                   3622: Wrap messages about completion of operation in box
                   3623: 
                   3624: =cut
                   3625: 
                   3626: sub confirmwrapper {
                   3627:     my ($message)=@_;
                   3628:     if ($message) {
                   3629:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3630:                .$message."\n"
                   3631:                .'</div>'."\n";
                   3632:     } else {
                   3633:         return $message;
                   3634:     }
                   3635: }
                   3636: 
1.62      www      3637: # ------------------------------------------------------------- Message Wrapper
                   3638: 
                   3639: sub messagewrapper {
1.369     www      3640:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3641:     return 
1.441     albertel 3642:         '<a href="/adm/email?compose=individual&amp;'.
                   3643:         'recname='.$username.'&amp;recdom='.$domain.
                   3644: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3645:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3646: }
1.802     bisitz   3647: 
1.74      www      3648: # --------------------------------------------------------------- Notes Wrapper
                   3649: 
                   3650: sub noteswrapper {
                   3651:     my ($link,$un,$do)=@_;
                   3652:     return 
1.896     amueller 3653: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3654: }
1.802     bisitz   3655: 
1.62      www      3656: # ------------------------------------------------------------- Aboutme Wrapper
                   3657: 
                   3658: sub aboutmewrapper {
1.1070    raeburn  3659:     my ($link,$username,$domain,$target,$class)=@_;
1.447     raeburn  3660:     if (!defined($username)  && !defined($domain)) {
                   3661:         return;
                   3662:     }
1.1075.2.15  raeburn  3663:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070    raeburn  3664: 	($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3665: }
                   3666: 
                   3667: # ------------------------------------------------------------ Syllabus Wrapper
                   3668: 
                   3669: sub syllabuswrapper {
1.707     bisitz   3670:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3671:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3672: }
1.14      harris41 3673: 
1.802     bisitz   3674: # -----------------------------------------------------------------------------
                   3675: 
1.208     matthew  3676: sub track_student_link {
1.887     raeburn  3677:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3678:     my $link ="/adm/trackstudent?";
1.208     matthew  3679:     my $title = 'View recent activity';
                   3680:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3681:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3682:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3683:         $title .= ' of this student';
1.268     albertel 3684:     } 
1.208     matthew  3685:     if (defined($target) && $target !~ /^\s*$/) {
                   3686:         $target = qq{target="$target"};
                   3687:     } else {
                   3688:         $target = '';
                   3689:     }
1.268     albertel 3690:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3691:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3692:     $title = &mt($title);
                   3693:     $linktext = &mt($linktext);
1.448     albertel 3694:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3695: 	&help_open_topic('View_recent_activity');
1.208     matthew  3696: }
                   3697: 
1.781     raeburn  3698: sub slot_reservations_link {
                   3699:     my ($linktext,$sname,$sdom,$target) = @_;
                   3700:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3701:     my $title = 'View slot reservation history';
                   3702:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3703:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3704:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3705:         $title .= ' of this student';
                   3706:     }
                   3707:     if (defined($target) && $target !~ /^\s*$/) {
                   3708:         $target = qq{target="$target"};
                   3709:     } else {
                   3710:         $target = '';
                   3711:     }
                   3712:     $title = &mt($title);
                   3713:     $linktext = &mt($linktext);
                   3714:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3715: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3716: 
                   3717: }
                   3718: 
1.508     www      3719: # ===================================================== Display a student photo
                   3720: 
                   3721: 
1.509     albertel 3722: sub student_image_tag {
1.508     www      3723:     my ($domain,$user)=@_;
                   3724:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3725:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3726: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3727:     } else {
                   3728: 	return '';
                   3729:     }
                   3730: }
                   3731: 
1.112     bowersj2 3732: =pod
                   3733: 
                   3734: =back
                   3735: 
                   3736: =head1 Access .tab File Data
                   3737: 
                   3738: =over 4
                   3739: 
1.648     raeburn  3740: =item * &languageids() 
1.112     bowersj2 3741: 
                   3742: returns list of all language ids
                   3743: 
                   3744: =cut
                   3745: 
1.14      harris41 3746: sub languageids {
1.16      harris41 3747:     return sort(keys(%language));
1.14      harris41 3748: }
                   3749: 
1.112     bowersj2 3750: =pod
                   3751: 
1.648     raeburn  3752: =item * &languagedescription() 
1.112     bowersj2 3753: 
                   3754: returns description of a specified language id
                   3755: 
                   3756: =cut
                   3757: 
1.14      harris41 3758: sub languagedescription {
1.125     www      3759:     my $code=shift;
                   3760:     return  ($supported_language{$code}?'* ':'').
                   3761:             $language{$code}.
1.126     www      3762: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3763: }
                   3764: 
1.1048    foxr     3765: =pod
                   3766: 
                   3767: =item * &plainlanguagedescription
                   3768: 
                   3769: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
                   3770: and the language character encoding (e.g. ISO) separated by a ' - ' string.
                   3771: 
                   3772: =cut
                   3773: 
1.145     www      3774: sub plainlanguagedescription {
                   3775:     my $code=shift;
                   3776:     return $language{$code};
                   3777: }
                   3778: 
1.1048    foxr     3779: =pod
                   3780: 
                   3781: =item * &supportedlanguagecode
                   3782: 
                   3783: Returns the supported language code (e.g. sptutf maps to pt) given a language
                   3784: code.
                   3785: 
                   3786: =cut
                   3787: 
1.145     www      3788: sub supportedlanguagecode {
                   3789:     my $code=shift;
                   3790:     return $supported_language{$code};
1.97      www      3791: }
                   3792: 
1.112     bowersj2 3793: =pod
                   3794: 
1.1048    foxr     3795: =item * &latexlanguage()
                   3796: 
                   3797: Given a language key code returns the correspondnig language to use
                   3798: to select the correct hyphenation on LaTeX printouts.  This is undef if there
                   3799: is no supported hyphenation for the language code.
                   3800: 
                   3801: =cut
                   3802: 
                   3803: sub latexlanguage {
                   3804:     my $code = shift;
                   3805:     return $latex_language{$code};
                   3806: }
                   3807: 
                   3808: =pod
                   3809: 
                   3810: =item * &latexhyphenation()
                   3811: 
                   3812: Same as above but what's supplied is the language as it might be stored
                   3813: in the metadata.
                   3814: 
                   3815: =cut
                   3816: 
                   3817: sub latexhyphenation {
                   3818:     my $key = shift;
                   3819:     return $latex_language_bykey{$key};
                   3820: }
                   3821: 
                   3822: =pod
                   3823: 
1.648     raeburn  3824: =item * &copyrightids() 
1.112     bowersj2 3825: 
                   3826: returns list of all copyrights
                   3827: 
                   3828: =cut
                   3829: 
                   3830: sub copyrightids {
                   3831:     return sort(keys(%cprtag));
                   3832: }
                   3833: 
                   3834: =pod
                   3835: 
1.648     raeburn  3836: =item * &copyrightdescription() 
1.112     bowersj2 3837: 
                   3838: returns description of a specified copyright id
                   3839: 
                   3840: =cut
                   3841: 
                   3842: sub copyrightdescription {
1.166     www      3843:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3844: }
1.197     matthew  3845: 
                   3846: =pod
                   3847: 
1.648     raeburn  3848: =item * &source_copyrightids() 
1.192     taceyjo1 3849: 
                   3850: returns list of all source copyrights
                   3851: 
                   3852: =cut
                   3853: 
                   3854: sub source_copyrightids {
                   3855:     return sort(keys(%scprtag));
                   3856: }
                   3857: 
                   3858: =pod
                   3859: 
1.648     raeburn  3860: =item * &source_copyrightdescription() 
1.192     taceyjo1 3861: 
                   3862: returns description of a specified source copyright id
                   3863: 
                   3864: =cut
                   3865: 
                   3866: sub source_copyrightdescription {
                   3867:     return &mt($scprtag{shift(@_)});
                   3868: }
1.112     bowersj2 3869: 
                   3870: =pod
                   3871: 
1.648     raeburn  3872: =item * &filecategories() 
1.112     bowersj2 3873: 
                   3874: returns list of all file categories
                   3875: 
                   3876: =cut
                   3877: 
                   3878: sub filecategories {
                   3879:     return sort(keys(%category_extensions));
                   3880: }
                   3881: 
                   3882: =pod
                   3883: 
1.648     raeburn  3884: =item * &filecategorytypes() 
1.112     bowersj2 3885: 
                   3886: returns list of file types belonging to a given file
                   3887: category
                   3888: 
                   3889: =cut
                   3890: 
                   3891: sub filecategorytypes {
1.356     albertel 3892:     my ($cat) = @_;
                   3893:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3894: }
                   3895: 
                   3896: =pod
                   3897: 
1.648     raeburn  3898: =item * &fileembstyle() 
1.112     bowersj2 3899: 
                   3900: returns embedding style for a specified file type
                   3901: 
                   3902: =cut
                   3903: 
                   3904: sub fileembstyle {
                   3905:     return $fe{lc(shift(@_))};
1.169     www      3906: }
                   3907: 
1.351     www      3908: sub filemimetype {
                   3909:     return $fm{lc(shift(@_))};
                   3910: }
                   3911: 
1.169     www      3912: 
                   3913: sub filecategoryselect {
                   3914:     my ($name,$value)=@_;
1.189     matthew  3915:     return &select_form($value,$name,
1.970     raeburn  3916:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112     bowersj2 3917: }
                   3918: 
                   3919: =pod
                   3920: 
1.648     raeburn  3921: =item * &filedescription() 
1.112     bowersj2 3922: 
                   3923: returns description for a specified file type
                   3924: 
                   3925: =cut
                   3926: 
                   3927: sub filedescription {
1.188     matthew  3928:     my $file_description = $fd{lc(shift())};
                   3929:     $file_description =~ s:([\[\]]):~$1:g;
                   3930:     return &mt($file_description);
1.112     bowersj2 3931: }
                   3932: 
                   3933: =pod
                   3934: 
1.648     raeburn  3935: =item * &filedescriptionex() 
1.112     bowersj2 3936: 
                   3937: returns description for a specified file type with
                   3938: extra formatting
                   3939: 
                   3940: =cut
                   3941: 
                   3942: sub filedescriptionex {
                   3943:     my $ex=shift;
1.188     matthew  3944:     my $file_description = $fd{lc($ex)};
                   3945:     $file_description =~ s:([\[\]]):~$1:g;
                   3946:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3947: }
                   3948: 
                   3949: # End of .tab access
                   3950: =pod
                   3951: 
                   3952: =back
                   3953: 
                   3954: =cut
                   3955: 
                   3956: # ------------------------------------------------------------------ File Types
                   3957: sub fileextensions {
                   3958:     return sort(keys(%fe));
                   3959: }
                   3960: 
1.97      www      3961: # ----------------------------------------------------------- Display Languages
                   3962: # returns a hash with all desired display languages
                   3963: #
                   3964: 
                   3965: sub display_languages {
                   3966:     my %languages=();
1.695     raeburn  3967:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3968: 	$languages{$lang}=1;
1.97      www      3969:     }
                   3970:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3971:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3972: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3973: 	    $languages{$lang}=1;
1.97      www      3974:         }
                   3975:     }
                   3976:     return %languages;
1.14      harris41 3977: }
                   3978: 
1.582     albertel 3979: sub languages {
                   3980:     my ($possible_langs) = @_;
1.695     raeburn  3981:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3982:     if (!ref($possible_langs)) {
                   3983: 	if( wantarray ) {
                   3984: 	    return @preferred_langs;
                   3985: 	} else {
                   3986: 	    return $preferred_langs[0];
                   3987: 	}
                   3988:     }
                   3989:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3990:     my @preferred_possibilities;
                   3991:     foreach my $preferred_lang (@preferred_langs) {
                   3992: 	if (exists($possibilities{$preferred_lang})) {
                   3993: 	    push(@preferred_possibilities, $preferred_lang);
                   3994: 	}
                   3995:     }
                   3996:     if( wantarray ) {
                   3997: 	return @preferred_possibilities;
                   3998:     }
                   3999:     return $preferred_possibilities[0];
                   4000: }
                   4001: 
1.742     raeburn  4002: sub user_lang {
                   4003:     my ($touname,$toudom,$fromcid) = @_;
                   4004:     my @userlangs;
                   4005:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   4006:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   4007:                     $env{'course.'.$fromcid.'.languages'}));
                   4008:     } else {
                   4009:         my %langhash = &getlangs($touname,$toudom);
                   4010:         if ($langhash{'languages'} ne '') {
                   4011:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   4012:         } else {
                   4013:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   4014:             if ($domdefs{'lang_def'} ne '') {
                   4015:                 @userlangs = ($domdefs{'lang_def'});
                   4016:             }
                   4017:         }
                   4018:     }
                   4019:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   4020:     my $user_lh = Apache::localize->get_handle(@languages);
                   4021:     return $user_lh;
                   4022: }
                   4023: 
                   4024: 
1.112     bowersj2 4025: ###############################################################
                   4026: ##               Student Answer Attempts                     ##
                   4027: ###############################################################
                   4028: 
                   4029: =pod
                   4030: 
                   4031: =head1 Alternate Problem Views
                   4032: 
                   4033: =over 4
                   4034: 
1.648     raeburn  4035: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1075.2.86  raeburn  4036:     $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112     bowersj2 4037: 
                   4038: Return string with previous attempt on problem. Arguments:
                   4039: 
                   4040: =over 4
                   4041: 
                   4042: =item * $symb: Problem, including path
                   4043: 
                   4044: =item * $username: username of the desired student
                   4045: 
                   4046: =item * $domain: domain of the desired student
1.14      harris41 4047: 
1.112     bowersj2 4048: =item * $course: Course ID
1.14      harris41 4049: 
1.112     bowersj2 4050: =item * $getattempt: Leave blank for all attempts, otherwise put
                   4051:     something
1.14      harris41 4052: 
1.112     bowersj2 4053: =item * $regexp: if string matches this regexp, the string will be
                   4054:     sent to $gradesub
1.14      harris41 4055: 
1.112     bowersj2 4056: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 4057: 
1.1075.2.86  raeburn  4058: =item * $usec: section of the desired student
                   4059: 
                   4060: =item * $identifier: counter for student (multiple students one problem) or
                   4061:     problem (one student; whole sequence).
                   4062: 
1.112     bowersj2 4063: =back
1.14      harris41 4064: 
1.112     bowersj2 4065: The output string is a table containing all desired attempts, if any.
1.16      harris41 4066: 
1.112     bowersj2 4067: =cut
1.1       albertel 4068: 
                   4069: sub get_previous_attempt {
1.1075.2.86  raeburn  4070:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1       albertel 4071:   my $prevattempts='';
1.43      ng       4072:   no strict 'refs';
1.1       albertel 4073:   if ($symb) {
1.3       albertel 4074:     my (%returnhash)=
                   4075:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 4076:     if ($returnhash{'version'}) {
                   4077:       my %lasthash=();
                   4078:       my $version;
                   4079:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.91  raeburn  4080:         foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
                   4081:             if ($key =~ /\.rawrndseed$/) {
                   4082:                 my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
                   4083:                 $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
                   4084:             } else {
                   4085:                 $lasthash{$key}=$returnhash{$version.':'.$key};
                   4086:             }
1.19      harris41 4087:         }
1.1       albertel 4088:       }
1.596     albertel 4089:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   4090:       $prevattempts.='<th>'.&mt('History').'</th>';
1.1075.2.86  raeburn  4091:       my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945     raeburn  4092:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 4093:       foreach my $key (sort(keys(%lasthash))) {
                   4094: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       4095: 	if ($#parts > 0) {
1.31      albertel 4096: 	  my $data=$parts[-1];
1.989     raeburn  4097:           next if ($data eq 'foilorder');
1.31      albertel 4098: 	  pop(@parts);
1.1010    www      4099:           $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.945     raeburn  4100:           if ($data eq 'type') {
                   4101:               unless ($showsurv) {
                   4102:                   my $id = join(',',@parts);
                   4103:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978     raeburn  4104:                   if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                   4105:                       $lasthidden{$ign.'.'.$id} = 1;
                   4106:                   }
1.945     raeburn  4107:               }
1.1075.2.86  raeburn  4108:               if ($identifier ne '') {
                   4109:                   my $id = join(',',@parts);
                   4110:                   if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
                   4111:                                                $domain,$username,$usec,undef,$course) =~ /^no/) {
                   4112:                       $hidestatus{$ign.'.'.$id} = 1;
                   4113:                   }
                   4114:               }
                   4115:           } elsif ($data eq 'regrader') {
                   4116:               if (($identifier ne '') && (@parts)) {
                   4117:                   my $id = join(',',@parts);
                   4118:                   $regraded{$ign.'.'.$id} = 1;
                   4119:               }
1.1010    www      4120:           } 
1.31      albertel 4121: 	} else {
1.41      ng       4122: 	  if ($#parts == 0) {
                   4123: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   4124: 	  } else {
                   4125: 	    $prevattempts.='<th>'.$ign.'</th>';
                   4126: 	  }
1.31      albertel 4127: 	}
1.16      harris41 4128:       }
1.596     albertel 4129:       $prevattempts.=&end_data_table_header_row();
1.40      ng       4130:       if ($getattempt eq '') {
1.1075.2.86  raeburn  4131:         my (%solved,%resets,%probstatus);
                   4132:         if (($identifier ne '') && (keys(%regraded) > 0)) {
                   4133:             for ($version=1;$version<=$returnhash{'version'};$version++) {
                   4134:                 foreach my $id (keys(%regraded)) {
                   4135:                     if (($returnhash{$version.':'.$id.'.regrader'}) &&
                   4136:                         ($returnhash{$version.':'.$id.'.tries'} eq '') &&
                   4137:                         ($returnhash{$version.':'.$id.'.award'} eq '')) {
                   4138:                         push(@{$resets{$id}},$version);
                   4139:                     }
                   4140:                 }
                   4141:             }
                   4142:         }
1.40      ng       4143: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.86  raeburn  4144:             my (@hidden,@unsolved);
1.945     raeburn  4145:             if (%typeparts) {
                   4146:                 foreach my $id (keys(%typeparts)) {
1.1075.2.86  raeburn  4147:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
                   4148:                         ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945     raeburn  4149:                         push(@hidden,$id);
1.1075.2.86  raeburn  4150:                     } elsif ($identifier ne '') {
                   4151:                         unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
                   4152:                                 ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
                   4153:                                 ($hidestatus{$id})) {
                   4154:                             next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
                   4155:                             if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
                   4156:                                 push(@{$solved{$id}},$version);
                   4157:                             } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
                   4158:                                      (ref($solved{$id}) eq 'ARRAY')) {
                   4159:                                 my $skip;
                   4160:                                 if (ref($resets{$id}) eq 'ARRAY') {
                   4161:                                     foreach my $reset (@{$resets{$id}}) {
                   4162:                                         if ($reset > $solved{$id}[-1]) {
                   4163:                                             $skip=1;
                   4164:                                             last;
                   4165:                                         }
                   4166:                                     }
                   4167:                                 }
                   4168:                                 unless ($skip) {
                   4169:                                     my ($ign,$partslist) = split(/\./,$id,2);
                   4170:                                     push(@unsolved,$partslist);
                   4171:                                 }
                   4172:                             }
                   4173:                         }
1.945     raeburn  4174:                     }
                   4175:                 }
                   4176:             }
                   4177:             $prevattempts.=&start_data_table_row().
1.1075.2.86  raeburn  4178:                            '<td>'.&mt('Transaction [_1]',$version);
                   4179:             if (@unsolved) {
                   4180:                 $prevattempts .= '<span class="LC_nobreak"><label>'.
                   4181:                                  '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
                   4182:                                  &mt('Hide').'</label></span>';
                   4183:             }
                   4184:             $prevattempts .= '</td>';
1.945     raeburn  4185:             if (@hidden) {
                   4186:                 foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4187:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  4188:                     my $hide;
                   4189:                     foreach my $id (@hidden) {
                   4190:                         if ($key =~ /^\Q$id\E/) {
                   4191:                             $hide = 1;
                   4192:                             last;
                   4193:                         }
                   4194:                     }
                   4195:                     if ($hide) {
                   4196:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   4197:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   4198:                             my $value = &format_previous_attempt_value($key,
                   4199:                                              $returnhash{$version.':'.$key});
                   4200:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4201:                         } else {
                   4202:                             $prevattempts.='<td>&nbsp;</td>';
                   4203:                         }
                   4204:                     } else {
                   4205:                         if ($key =~ /\./) {
1.1075.2.91  raeburn  4206:                             my $value = $returnhash{$version.':'.$key};
                   4207:                             if ($key =~ /\.rndseed$/) {
                   4208:                                 my ($id) = ($key =~ /^(.+)\.rndseed$/);
                   4209:                                 if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   4210:                                     $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   4211:                                 }
                   4212:                             }
                   4213:                             $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   4214:                                            '&nbsp;</td>';
1.945     raeburn  4215:                         } else {
                   4216:                             $prevattempts.='<td>&nbsp;</td>';
                   4217:                         }
                   4218:                     }
                   4219:                 }
                   4220:             } else {
                   4221: 	        foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4222:                     next if ($key =~ /\.foilorder$/);
1.1075.2.91  raeburn  4223:                     my $value = $returnhash{$version.':'.$key};
                   4224:                     if ($key =~ /\.rndseed$/) {
                   4225:                         my ($id) = ($key =~ /^(.+)\.rndseed$/);
                   4226:                         if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   4227:                             $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   4228:                         }
                   4229:                     }
                   4230:                     $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   4231:                                    '&nbsp;</td>';
1.945     raeburn  4232: 	        }
                   4233:             }
                   4234: 	    $prevattempts.=&end_data_table_row();
1.40      ng       4235: 	 }
1.1       albertel 4236:       }
1.945     raeburn  4237:       my @currhidden = keys(%lasthidden);
1.596     albertel 4238:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 4239:       foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4240:           next if ($key =~ /\.foilorder$/);
1.945     raeburn  4241:           if (%typeparts) {
                   4242:               my $hidden;
                   4243:               foreach my $id (@currhidden) {
                   4244:                   if ($key =~ /^\Q$id\E/) {
                   4245:                       $hidden = 1;
                   4246:                       last;
                   4247:                   }
                   4248:               }
                   4249:               if ($hidden) {
                   4250:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   4251:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   4252:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4253:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4254:                           $value = &$gradesub($value);
                   4255:                       }
                   4256:                       $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4257:                   } else {
                   4258:                       $prevattempts.='<td>&nbsp;</td>';
                   4259:                   }
                   4260:               } else {
                   4261:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4262:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4263:                       $value = &$gradesub($value);
                   4264:                   }
                   4265:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4266:               }
                   4267:           } else {
                   4268: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4269: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4270:                   $value = &$gradesub($value);
                   4271:               }
                   4272: 	      $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4273:           }
1.16      harris41 4274:       }
1.596     albertel 4275:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 4276:     } else {
1.596     albertel 4277:       $prevattempts=
                   4278: 	  &start_data_table().&start_data_table_row().
                   4279: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   4280: 	  &end_data_table_row().&end_data_table();
1.1       albertel 4281:     }
                   4282:   } else {
1.596     albertel 4283:     $prevattempts=
                   4284: 	  &start_data_table().&start_data_table_row().
                   4285: 	  '<td>'.&mt('No data.').'</td>'.
                   4286: 	  &end_data_table_row().&end_data_table();
1.1       albertel 4287:   }
1.10      albertel 4288: }
                   4289: 
1.581     albertel 4290: sub format_previous_attempt_value {
                   4291:     my ($key,$value) = @_;
1.1011    www      4292:     if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581     albertel 4293: 	$value = &Apache::lonlocal::locallocaltime($value);
                   4294:     } elsif (ref($value) eq 'ARRAY') {
                   4295: 	$value = '('.join(', ', @{ $value }).')';
1.988     raeburn  4296:     } elsif ($key =~ /answerstring$/) {
                   4297:         my %answers = &Apache::lonnet::str2hash($value);
                   4298:         my @anskeys = sort(keys(%answers));
                   4299:         if (@anskeys == 1) {
                   4300:             my $answer = $answers{$anskeys[0]};
1.1001    raeburn  4301:             if ($answer =~ m{\0}) {
                   4302:                 $answer =~ s{\0}{,}g;
1.988     raeburn  4303:             }
                   4304:             my $tag_internal_answer_name = 'INTERNAL';
                   4305:             if ($anskeys[0] eq $tag_internal_answer_name) {
                   4306:                 $value = $answer; 
                   4307:             } else {
                   4308:                 $value = $anskeys[0].'='.$answer;
                   4309:             }
                   4310:         } else {
                   4311:             foreach my $ans (@anskeys) {
                   4312:                 my $answer = $answers{$ans};
1.1001    raeburn  4313:                 if ($answer =~ m{\0}) {
                   4314:                     $answer =~ s{\0}{,}g;
1.988     raeburn  4315:                 }
                   4316:                 $value .=  $ans.'='.$answer.'<br />';;
                   4317:             } 
                   4318:         }
1.581     albertel 4319:     } else {
                   4320: 	$value = &unescape($value);
                   4321:     }
                   4322:     return $value;
                   4323: }
                   4324: 
                   4325: 
1.107     albertel 4326: sub relative_to_absolute {
                   4327:     my ($url,$output)=@_;
                   4328:     my $parser=HTML::TokeParser->new(\$output);
                   4329:     my $token;
                   4330:     my $thisdir=$url;
                   4331:     my @rlinks=();
                   4332:     while ($token=$parser->get_token) {
                   4333: 	if ($token->[0] eq 'S') {
                   4334: 	    if ($token->[1] eq 'a') {
                   4335: 		if ($token->[2]->{'href'}) {
                   4336: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   4337: 		}
                   4338: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   4339: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   4340: 	    } elsif ($token->[1] eq 'base') {
                   4341: 		$thisdir=$token->[2]->{'href'};
                   4342: 	    }
                   4343: 	}
                   4344:     }
                   4345:     $thisdir=~s-/[^/]*$--;
1.356     albertel 4346:     foreach my $link (@rlinks) {
1.726     raeburn  4347: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 4348: 		($link=~/^\//) ||
                   4349: 		($link=~/^javascript:/i) ||
                   4350: 		($link=~/^mailto:/i) ||
                   4351: 		($link=~/^\#/)) {
                   4352: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   4353: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 4354: 	}
                   4355:     }
                   4356: # -------------------------------------------------- Deal with Applet codebases
                   4357:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   4358:     return $output;
                   4359: }
                   4360: 
1.112     bowersj2 4361: =pod
                   4362: 
1.648     raeburn  4363: =item * &get_student_view()
1.112     bowersj2 4364: 
                   4365: show a snapshot of what student was looking at
                   4366: 
                   4367: =cut
                   4368: 
1.10      albertel 4369: sub get_student_view {
1.186     albertel 4370:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      4371:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4372:   my (%form);
1.10      albertel 4373:   my @elements=('symb','courseid','domain','username');
                   4374:   foreach my $element (@elements) {
1.186     albertel 4375:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4376:   }
1.186     albertel 4377:   if (defined($moreenv)) {
                   4378:       %form=(%form,%{$moreenv});
                   4379:   }
1.236     albertel 4380:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 4381:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      4382:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 4383:   $userview=~s/\<body[^\>]*\>//gi;
                   4384:   $userview=~s/\<\/body\>//gi;
                   4385:   $userview=~s/\<html\>//gi;
                   4386:   $userview=~s/\<\/html\>//gi;
                   4387:   $userview=~s/\<head\>//gi;
                   4388:   $userview=~s/\<\/head\>//gi;
                   4389:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 4390:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      4391:   if (wantarray) {
                   4392:      return ($userview,$response);
                   4393:   } else {
                   4394:      return $userview;
                   4395:   }
                   4396: }
                   4397: 
                   4398: sub get_student_view_with_retries {
                   4399:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   4400: 
                   4401:     my $ok = 0;                 # True if we got a good response.
                   4402:     my $content;
                   4403:     my $response;
                   4404: 
                   4405:     # Try to get the student_view done. within the retries count:
                   4406:     
                   4407:     do {
                   4408:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   4409:          $ok      = $response->is_success;
                   4410:          if (!$ok) {
                   4411:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   4412:          }
                   4413:          $retries--;
                   4414:     } while (!$ok && ($retries > 0));
                   4415:     
                   4416:     if (!$ok) {
                   4417:        $content = '';          # On error return an empty content.
                   4418:     }
1.651     www      4419:     if (wantarray) {
                   4420:        return ($content, $response);
                   4421:     } else {
                   4422:        return $content;
                   4423:     }
1.11      albertel 4424: }
                   4425: 
1.1075.2.149  raeburn  4426: sub css_links {
                   4427:     my ($currsymb,$level) = @_;
                   4428:     my ($links,@symbs,%cssrefs,%httpref);
                   4429:     if ($level eq 'map') {
                   4430:         my $navmap = Apache::lonnavmaps::navmap->new();
                   4431:         if (ref($navmap)) {
                   4432:             my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
                   4433:             my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
                   4434:             foreach my $res (@resources) {
                   4435:                 if (ref($res) && $res->symb()) {
                   4436:                     push(@symbs,$res->symb());
                   4437:                 }
                   4438:             }
                   4439:         }
                   4440:     } else {
                   4441:         @symbs = ($currsymb);
                   4442:     }
                   4443:     foreach my $symb (@symbs) {
                   4444:         my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
                   4445:         if ($css_href =~ /\S/) {
                   4446:             unless ($css_href =~ m{https?://}) {
                   4447:                 my $url = (&Apache::lonnet::decode_symb($symb))[-1];
                   4448:                 my $proburl =  &Apache::lonnet::clutter($url);
                   4449:                 my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
                   4450:                 unless ($css_href =~ m{^/}) {
                   4451:                     $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
                   4452:                 }
                   4453:                 if ($css_href =~ m{^/(res|uploaded)/}) {
                   4454:                     unless (($httpref{'httpref.'.$css_href}) ||
                   4455:                             (&Apache::lonnet::is_on_map($css_href))) {
                   4456:                         my $thisurl = $proburl;
                   4457:                         if ($env{'httpref.'.$proburl}) {
                   4458:                             $thisurl = $env{'httpref.'.$proburl};
                   4459:                         }
                   4460:                         $httpref{'httpref.'.$css_href} = $thisurl;
                   4461:                     }
                   4462:                 }
                   4463:             }
                   4464:             $cssrefs{$css_href} = 1;
                   4465:         }
                   4466:     }
                   4467:     if (keys(%httpref)) {
                   4468:         &Apache::lonnet::appenv(\%httpref);
                   4469:     }
                   4470:     if (keys(%cssrefs)) {
                   4471:         foreach my $css_href (keys(%cssrefs)) {
                   4472:             next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
                   4473:             $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
                   4474:         }
                   4475:     }
                   4476:     return $links;
                   4477: }
                   4478: 
1.112     bowersj2 4479: =pod
                   4480: 
1.648     raeburn  4481: =item * &get_student_answers() 
1.112     bowersj2 4482: 
                   4483: show a snapshot of how student was answering problem
                   4484: 
                   4485: =cut
                   4486: 
1.11      albertel 4487: sub get_student_answers {
1.100     sakharuk 4488:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      4489:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4490:   my (%moreenv);
1.11      albertel 4491:   my @elements=('symb','courseid','domain','username');
                   4492:   foreach my $element (@elements) {
1.186     albertel 4493:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4494:   }
1.186     albertel 4495:   $moreenv{'grade_target'}='answer';
                   4496:   %moreenv=(%form,%moreenv);
1.497     raeburn  4497:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   4498:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 4499:   return $userview;
1.1       albertel 4500: }
1.116     albertel 4501: 
                   4502: =pod
                   4503: 
                   4504: =item * &submlink()
                   4505: 
1.242     albertel 4506: Inputs: $text $uname $udom $symb $target
1.116     albertel 4507: 
                   4508: Returns: A link to grades.pm such as to see the SUBM view of a student
                   4509: 
                   4510: =cut
                   4511: 
                   4512: ###############################################
                   4513: sub submlink {
1.242     albertel 4514:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 4515:     if (!($uname && $udom)) {
                   4516: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4517: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 4518: 	if (!$symb) { $symb=$cursymb; }
                   4519:     }
1.254     matthew  4520:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4521:     $symb=&escape($symb);
1.960     bisitz   4522:     if ($target) { $target=" target=\"$target\""; }
                   4523:     return
                   4524:         '<a href="/adm/grades?command=submission'.
                   4525:         '&amp;symb='.$symb.
                   4526:         '&amp;student='.$uname.
                   4527:         '&amp;userdom='.$udom.'"'.
                   4528:         $target.'>'.$text.'</a>';
1.242     albertel 4529: }
                   4530: ##############################################
                   4531: 
                   4532: =pod
                   4533: 
                   4534: =item * &pgrdlink()
                   4535: 
                   4536: Inputs: $text $uname $udom $symb $target
                   4537: 
                   4538: Returns: A link to grades.pm such as to see the PGRD view of a student
                   4539: 
                   4540: =cut
                   4541: 
                   4542: ###############################################
                   4543: sub pgrdlink {
                   4544:     my $link=&submlink(@_);
                   4545:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   4546:     return $link;
                   4547: }
                   4548: ##############################################
                   4549: 
                   4550: =pod
                   4551: 
                   4552: =item * &pprmlink()
                   4553: 
                   4554: Inputs: $text $uname $udom $symb $target
                   4555: 
                   4556: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 4557: student and a specific resource
1.242     albertel 4558: 
                   4559: =cut
                   4560: 
                   4561: ###############################################
                   4562: sub pprmlink {
                   4563:     my ($text,$uname,$udom,$symb,$target)=@_;
                   4564:     if (!($uname && $udom)) {
                   4565: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4566: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 4567: 	if (!$symb) { $symb=$cursymb; }
                   4568:     }
1.254     matthew  4569:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4570:     $symb=&escape($symb);
1.242     albertel 4571:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 4572:     return '<a href="/adm/parmset?command=set&amp;'.
                   4573: 	'symb='.$symb.'&amp;uname='.$uname.
                   4574: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 4575: }
                   4576: ##############################################
1.37      matthew  4577: 
1.112     bowersj2 4578: =pod
                   4579: 
                   4580: =back
                   4581: 
                   4582: =cut
                   4583: 
1.37      matthew  4584: ###############################################
1.51      www      4585: 
                   4586: 
                   4587: sub timehash {
1.687     raeburn  4588:     my ($thistime) = @_;
                   4589:     my $timezone = &Apache::lonlocal::gettimezone();
                   4590:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   4591:                      ->set_time_zone($timezone);
                   4592:     my $wday = $dt->day_of_week();
                   4593:     if ($wday == 7) { $wday = 0; }
                   4594:     return ( 'second' => $dt->second(),
                   4595:              'minute' => $dt->minute(),
                   4596:              'hour'   => $dt->hour(),
                   4597:              'day'     => $dt->day_of_month(),
                   4598:              'month'   => $dt->month(),
                   4599:              'year'    => $dt->year(),
                   4600:              'weekday' => $wday,
                   4601:              'dayyear' => $dt->day_of_year(),
                   4602:              'dlsav'   => $dt->is_dst() );
1.51      www      4603: }
                   4604: 
1.370     www      4605: sub utc_string {
                   4606:     my ($date)=@_;
1.371     www      4607:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      4608: }
                   4609: 
1.51      www      4610: sub maketime {
                   4611:     my %th=@_;
1.687     raeburn  4612:     my ($epoch_time,$timezone,$dt);
                   4613:     $timezone = &Apache::lonlocal::gettimezone();
                   4614:     eval {
                   4615:         $dt = DateTime->new( year   => $th{'year'},
                   4616:                              month  => $th{'month'},
                   4617:                              day    => $th{'day'},
                   4618:                              hour   => $th{'hour'},
                   4619:                              minute => $th{'minute'},
                   4620:                              second => $th{'second'},
                   4621:                              time_zone => $timezone,
                   4622:                          );
                   4623:     };
                   4624:     if (!$@) {
                   4625:         $epoch_time = $dt->epoch;
                   4626:         if ($epoch_time) {
                   4627:             return $epoch_time;
                   4628:         }
                   4629:     }
1.51      www      4630:     return POSIX::mktime(
                   4631:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      4632:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      4633: }
                   4634: 
                   4635: #########################################
1.51      www      4636: 
                   4637: sub findallcourses {
1.482     raeburn  4638:     my ($roles,$uname,$udom) = @_;
1.355     albertel 4639:     my %roles;
                   4640:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 4641:     my %courses;
1.51      www      4642:     my $now=time;
1.482     raeburn  4643:     if (!defined($uname)) {
                   4644:         $uname = $env{'user.name'};
                   4645:     }
                   4646:     if (!defined($udom)) {
                   4647:         $udom = $env{'user.domain'};
                   4648:     }
                   4649:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073    raeburn  4650:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482     raeburn  4651:         if (!%roles) {
                   4652:             %roles = (
                   4653:                        cc => 1,
1.907     raeburn  4654:                        co => 1,
1.482     raeburn  4655:                        in => 1,
                   4656:                        ep => 1,
                   4657:                        ta => 1,
                   4658:                        cr => 1,
                   4659:                        st => 1,
                   4660:              );
                   4661:         }
                   4662:         foreach my $entry (keys(%roleshash)) {
                   4663:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   4664:             if ($trole =~ /^cr/) { 
                   4665:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   4666:             } else {
                   4667:                 next if (!exists($roles{$trole}));
                   4668:             }
                   4669:             if ($tend) {
                   4670:                 next if ($tend < $now);
                   4671:             }
                   4672:             if ($tstart) {
                   4673:                 next if ($tstart > $now);
                   4674:             }
1.1058    raeburn  4675:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482     raeburn  4676:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058    raeburn  4677:             my $value = $trole.'/'.$cdom.'/';
1.482     raeburn  4678:             if ($secpart eq '') {
                   4679:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   4680:                 $sec = 'none';
1.1058    raeburn  4681:                 $value .= $cnum.'/';
1.482     raeburn  4682:             } else {
                   4683:                 $cnum = $cnumpart;
                   4684:                 ($sec,$role) = split(/_/,$secpart);
1.1058    raeburn  4685:                 $value .= $cnum.'/'.$sec;
                   4686:             }
                   4687:             if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4688:                 unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4689:                     push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4690:                 }
                   4691:             } else {
                   4692:                 @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490     raeburn  4693:             }
1.482     raeburn  4694:         }
                   4695:     } else {
                   4696:         foreach my $key (keys(%env)) {
1.483     albertel 4697: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   4698:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  4699: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   4700: 	        next if ($role eq 'ca' || $role eq 'aa');
                   4701: 	        next if (%roles && !exists($roles{$role}));
                   4702: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   4703:                 my $active=1;
                   4704:                 if ($starttime) {
                   4705: 		    if ($now<$starttime) { $active=0; }
                   4706:                 }
                   4707:                 if ($endtime) {
                   4708:                     if ($now>$endtime) { $active=0; }
                   4709:                 }
                   4710:                 if ($active) {
1.1058    raeburn  4711:                     my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482     raeburn  4712:                     if ($sec eq '') {
                   4713:                         $sec = 'none';
1.1058    raeburn  4714:                     } else {
                   4715:                         $value .= $sec;
                   4716:                     }
                   4717:                     if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4718:                         unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4719:                             push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4720:                         }
                   4721:                     } else {
                   4722:                         @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482     raeburn  4723:                     }
1.474     raeburn  4724:                 }
                   4725:             }
1.51      www      4726:         }
                   4727:     }
1.474     raeburn  4728:     return %courses;
1.51      www      4729: }
1.37      matthew  4730: 
1.54      www      4731: ###############################################
1.474     raeburn  4732: 
                   4733: sub blockcheck {
1.1075.2.147  raeburn  4734:     my ($setters,$activity,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.490     raeburn  4735: 
1.1075.2.73  raeburn  4736:     if (defined($udom) && defined($uname)) {
                   4737:         # If uname and udom are for a course, check for blocks in the course.
                   4738:         if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
                   4739:             my ($startblock,$endblock,$triggerblock) =
1.1075.2.147  raeburn  4740:                 &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1075.2.73  raeburn  4741:             return ($startblock,$endblock,$triggerblock);
                   4742:         }
                   4743:     } else {
1.490     raeburn  4744:         $udom = $env{'user.domain'};
                   4745:         $uname = $env{'user.name'};
                   4746:     }
                   4747: 
1.502     raeburn  4748:     my $startblock = 0;
                   4749:     my $endblock = 0;
1.1062    raeburn  4750:     my $triggerblock = '';
1.482     raeburn  4751:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  4752: 
1.490     raeburn  4753:     # If uname is for a user, and activity is course-specific, i.e.,
                   4754:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  4755: 
1.490     raeburn  4756:     if (($activity eq 'boards' || $activity eq 'chat' ||
1.1075.2.73  raeburn  4757:          $activity eq 'groups' || $activity eq 'printout') &&
                   4758:         ($env{'request.course.id'})) {
1.490     raeburn  4759:         foreach my $key (keys(%live_courses)) {
                   4760:             if ($key ne $env{'request.course.id'}) {
                   4761:                 delete($live_courses{$key});
                   4762:             }
                   4763:         }
                   4764:     }
                   4765: 
                   4766:     my $otheruser = 0;
                   4767:     my %own_courses;
                   4768:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   4769:         # Resource belongs to user other than current user.
                   4770:         $otheruser = 1;
                   4771:         # Gather courses for current user
                   4772:         %own_courses = 
                   4773:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   4774:     }
                   4775: 
                   4776:     # Gather active course roles - course coordinator, instructor, 
                   4777:     # exam proctor, ta, student, or custom role.
1.474     raeburn  4778: 
                   4779:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  4780:         my ($cdom,$cnum);
                   4781:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   4782:             $cdom = $env{'course.'.$course.'.domain'};
                   4783:             $cnum = $env{'course.'.$course.'.num'};
                   4784:         } else {
1.490     raeburn  4785:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  4786:         }
                   4787:         my $no_ownblock = 0;
                   4788:         my $no_userblock = 0;
1.533     raeburn  4789:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  4790:             # Check if current user has 'evb' priv for this
                   4791:             if (defined($own_courses{$course})) {
                   4792:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   4793:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   4794:                     if ($sec ne 'none') {
                   4795:                         $checkrole .= '/'.$sec;
                   4796:                     }
                   4797:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4798:                         $no_ownblock = 1;
                   4799:                         last;
                   4800:                     }
                   4801:                 }
                   4802:             }
                   4803:             # if they have 'evb' priv and are currently not playing student
                   4804:             next if (($no_ownblock) &&
                   4805:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   4806:         }
1.474     raeburn  4807:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  4808:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  4809:             if ($sec ne 'none') {
1.482     raeburn  4810:                 $checkrole .= '/'.$sec;
1.474     raeburn  4811:             }
1.490     raeburn  4812:             if ($otheruser) {
                   4813:                 # Resource belongs to user other than current user.
                   4814:                 # Assemble privs for that user, and check for 'evb' priv.
1.1058    raeburn  4815:                 my (%allroles,%userroles);
                   4816:                 if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
                   4817:                     foreach my $entry (@{$live_courses{$course}{$sec}}) { 
                   4818:                         my ($trole,$tdom,$tnum,$tsec);
                   4819:                         if ($entry =~ /^cr/) {
                   4820:                             ($trole,$tdom,$tnum,$tsec) = 
                   4821:                                 ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   4822:                         } else {
                   4823:                            ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   4824:                         }
                   4825:                         my ($spec,$area,$trest);
                   4826:                         $area = '/'.$tdom.'/'.$tnum;
                   4827:                         $trest = $tnum;
                   4828:                         if ($tsec ne '') {
                   4829:                             $area .= '/'.$tsec;
                   4830:                             $trest .= '/'.$tsec;
                   4831:                         }
                   4832:                         $spec = $trole.'.'.$area;
                   4833:                         if ($trole =~ /^cr/) {
                   4834:                             &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   4835:                                                               $tdom,$spec,$trest,$area);
                   4836:                         } else {
                   4837:                             &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   4838:                                                                 $tdom,$spec,$trest,$area);
                   4839:                         }
                   4840:                     }
1.1075.2.124  raeburn  4841:                     my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058    raeburn  4842:                     if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   4843:                         if ($1) {
                   4844:                             $no_userblock = 1;
                   4845:                             last;
                   4846:                         }
1.486     raeburn  4847:                     }
                   4848:                 }
1.490     raeburn  4849:             } else {
                   4850:                 # Resource belongs to current user
                   4851:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  4852:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4853:                     $no_ownblock = 1;
                   4854:                     last;
                   4855:                 }
1.474     raeburn  4856:             }
                   4857:         }
                   4858:         # if they have the evb priv and are currently not playing student
1.482     raeburn  4859:         next if (($no_ownblock) &&
1.491     albertel 4860:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  4861:         next if ($no_userblock);
1.474     raeburn  4862: 
1.1075.2.128  raeburn  4863:         # Retrieve blocking times and identity of blocker for course
1.490     raeburn  4864:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  4865:         
1.1062    raeburn  4866:         my ($start,$end,$trigger) = 
1.1075.2.147  raeburn  4867:             &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502     raeburn  4868:         if (($start != 0) && 
                   4869:             (($startblock == 0) || ($startblock > $start))) {
                   4870:             $startblock = $start;
1.1062    raeburn  4871:             if ($trigger ne '') {
                   4872:                 $triggerblock = $trigger;
                   4873:             }
1.502     raeburn  4874:         }
                   4875:         if (($end != 0)  &&
                   4876:             (($endblock == 0) || ($endblock < $end))) {
                   4877:             $endblock = $end;
1.1062    raeburn  4878:             if ($trigger ne '') {
                   4879:                 $triggerblock = $trigger;
                   4880:             }
1.502     raeburn  4881:         }
1.490     raeburn  4882:     }
1.1062    raeburn  4883:     return ($startblock,$endblock,$triggerblock);
1.490     raeburn  4884: }
                   4885: 
                   4886: sub get_blocks {
1.1075.2.147  raeburn  4887:     my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490     raeburn  4888:     my $startblock = 0;
                   4889:     my $endblock = 0;
1.1062    raeburn  4890:     my $triggerblock = '';
1.490     raeburn  4891:     my $course = $cdom.'_'.$cnum;
                   4892:     $setters->{$course} = {};
                   4893:     $setters->{$course}{'staff'} = [];
                   4894:     $setters->{$course}{'times'} = [];
1.1062    raeburn  4895:     $setters->{$course}{'triggers'} = [];
                   4896:     my (@blockers,%triggered);
                   4897:     my $now = time;
                   4898:     my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
                   4899:     if ($activity eq 'docs') {
1.1075.2.148  raeburn  4900:         my ($blocked,$nosymbcache,$noenccheck);
1.1075.2.147  raeburn  4901:         if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
                   4902:             $blocked = 1;
                   4903:             $nosymbcache = 1;
1.1075.2.148  raeburn  4904:             $noenccheck = 1;
1.1075.2.147  raeburn  4905:         }
1.1075.2.148  raeburn  4906:         @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062    raeburn  4907:         foreach my $block (@blockers) {
                   4908:             if ($block =~ /^firstaccess____(.+)$/) {
                   4909:                 my $item = $1;
                   4910:                 my $type = 'map';
                   4911:                 my $timersymb = $item;
                   4912:                 if ($item eq 'course') {
                   4913:                     $type = 'course';
                   4914:                 } elsif ($item =~ /___\d+___/) {
                   4915:                     $type = 'resource';
                   4916:                 } else {
                   4917:                     $timersymb = &Apache::lonnet::symbread($item);
                   4918:                 }
                   4919:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4920:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
                   4921:                 $triggered{$block} = {
                   4922:                                        start => $start,
                   4923:                                        end   => $end,
                   4924:                                        type  => $type,
                   4925:                                      };
                   4926:             }
                   4927:         }
                   4928:     } else {
                   4929:         foreach my $block (keys(%commblocks)) {
                   4930:             if ($block =~ m/^(\d+)____(\d+)$/) { 
                   4931:                 my ($start,$end) = ($1,$2);
                   4932:                 if ($start <= time && $end >= time) {
                   4933:                     if (ref($commblocks{$block}) eq 'HASH') {
                   4934:                         if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   4935:                             if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   4936:                                 unless(grep(/^\Q$block\E$/,@blockers)) {
                   4937:                                     push(@blockers,$block);
                   4938:                                 }
                   4939:                             }
                   4940:                         }
                   4941:                     }
                   4942:                 }
                   4943:             } elsif ($block =~ /^firstaccess____(.+)$/) {
                   4944:                 my $item = $1;
                   4945:                 my $timersymb = $item; 
                   4946:                 my $type = 'map';
                   4947:                 if ($item eq 'course') {
                   4948:                     $type = 'course';
                   4949:                 } elsif ($item =~ /___\d+___/) {
                   4950:                     $type = 'resource';
                   4951:                 } else {
                   4952:                     $timersymb = &Apache::lonnet::symbread($item);
                   4953:                 }
                   4954:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4955:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb}; 
                   4956:                 if ($start && $end) {
                   4957:                     if (($start <= time) && ($end >= time)) {
                   4958:                         unless (grep(/^\Q$block\E$/,@blockers)) {
                   4959:                             push(@blockers,$block);
                   4960:                             $triggered{$block} = {
                   4961:                                                    start => $start,
                   4962:                                                    end   => $end,
                   4963:                                                    type  => $type,
                   4964:                                                  };
                   4965:                         }
                   4966:                     }
1.490     raeburn  4967:                 }
1.1062    raeburn  4968:             }
                   4969:         }
                   4970:     }
                   4971:     foreach my $blocker (@blockers) {
                   4972:         my ($staff_name,$staff_dom,$title,$blocks) =
                   4973:             &parse_block_record($commblocks{$blocker});
                   4974:         push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   4975:         my ($start,$end,$triggertype);
                   4976:         if ($blocker =~ m/^(\d+)____(\d+)$/) {
                   4977:             ($start,$end) = ($1,$2);
                   4978:         } elsif (ref($triggered{$blocker}) eq 'HASH') {
                   4979:             $start = $triggered{$blocker}{'start'};
                   4980:             $end = $triggered{$blocker}{'end'};
                   4981:             $triggertype = $triggered{$blocker}{'type'};
                   4982:         }
                   4983:         if ($start) {
                   4984:             push(@{$$setters{$course}{'times'}}, [$start,$end]);
                   4985:             if ($triggertype) {
                   4986:                 push(@{$$setters{$course}{'triggers'}},$triggertype);
                   4987:             } else {
                   4988:                 push(@{$$setters{$course}{'triggers'}},0);
                   4989:             }
                   4990:             if ( ($startblock == 0) || ($startblock > $start) ) {
                   4991:                 $startblock = $start;
                   4992:                 if ($triggertype) {
                   4993:                     $triggerblock = $blocker;
1.474     raeburn  4994:                 }
                   4995:             }
1.1062    raeburn  4996:             if ( ($endblock == 0) || ($endblock < $end) ) {
                   4997:                $endblock = $end;
                   4998:                if ($triggertype) {
                   4999:                    $triggerblock = $blocker;
                   5000:                }
                   5001:             }
1.474     raeburn  5002:         }
                   5003:     }
1.1062    raeburn  5004:     return ($startblock,$endblock,$triggerblock);
1.474     raeburn  5005: }
                   5006: 
                   5007: sub parse_block_record {
                   5008:     my ($record) = @_;
                   5009:     my ($setuname,$setudom,$title,$blocks);
                   5010:     if (ref($record) eq 'HASH') {
                   5011:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   5012:         $title = &unescape($record->{'event'});
                   5013:         $blocks = $record->{'blocks'};
                   5014:     } else {
                   5015:         my @data = split(/:/,$record,3);
                   5016:         if (scalar(@data) eq 2) {
                   5017:             $title = $data[1];
                   5018:             ($setuname,$setudom) = split(/@/,$data[0]);
                   5019:         } else {
                   5020:             ($setuname,$setudom,$title) = @data;
                   5021:         }
                   5022:         $blocks = { 'com' => 'on' };
                   5023:     }
                   5024:     return ($setuname,$setudom,$title,$blocks);
                   5025: }
                   5026: 
1.854     kalberla 5027: sub blocking_status {
1.1075.2.147  raeburn  5028:     my ($activity,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061    raeburn  5029:     my %setters;
1.890     droeschl 5030: 
1.1061    raeburn  5031: # check for active blocking
1.1062    raeburn  5032:     my ($startblock,$endblock,$triggerblock) = 
1.1075.2.147  raeburn  5033:         &blockcheck(\%setters,$activity,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062    raeburn  5034:     my $blocked = 0;
                   5035:     if ($startblock && $endblock) {
                   5036:         $blocked = 1;
                   5037:     }
1.890     droeschl 5038: 
1.1061    raeburn  5039: # caller just wants to know whether a block is active
                   5040:     if (!wantarray) { return $blocked; }
                   5041: 
                   5042: # build a link to a popup window containing the details
                   5043:     my $querystring  = "?activity=$activity";
                   5044: # $uname and $udom decide whose portfolio the user is trying to look at
1.1075.2.97  raeburn  5045:     if (($activity eq 'port') || ($activity eq 'passwd')) {
                   5046:         $querystring .= "&amp;udom=$udom"      if ($udom =~ /^$match_domain$/);
                   5047:         $querystring .= "&amp;uname=$uname"    if ($uname =~ /^$match_username$/);
1.1062    raeburn  5048:     } elsif ($activity eq 'docs') {
1.1075.2.147  raeburn  5049:         my $showurl = &Apache::lonenc::check_encrypt($url);
                   5050:         $querystring .= '&amp;url='.&HTML::Entities::encode($showurl,'\'&"<>');
                   5051:         if ($symb) {
                   5052:             my $showsymb = &Apache::lonenc::check_encrypt($symb);
                   5053:             $querystring .= '&amp;symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
                   5054:         }
1.1062    raeburn  5055:     }
1.1061    raeburn  5056: 
                   5057:     my $output .= <<'END_MYBLOCK';
                   5058: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   5059:     var options = "width=" + w + ",height=" + h + ",";
                   5060:     options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   5061:     options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   5062:     var newWin = window.open(url, wdwName, options);
                   5063:     newWin.focus();
                   5064: }
1.890     droeschl 5065: END_MYBLOCK
1.854     kalberla 5066: 
1.1061    raeburn  5067:     $output = Apache::lonhtmlcommon::scripttag($output);
1.890     droeschl 5068:   
1.1061    raeburn  5069:     my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062    raeburn  5070:     my $text = &mt('Communication Blocked');
1.1075.2.93  raeburn  5071:     my $class = 'LC_comblock';
1.1062    raeburn  5072:     if ($activity eq 'docs') {
                   5073:         $text = &mt('Content Access Blocked');
1.1075.2.93  raeburn  5074:         $class = '';
1.1063    raeburn  5075:     } elsif ($activity eq 'printout') {
                   5076:         $text = &mt('Printing Blocked');
1.1075.2.97  raeburn  5077:     } elsif ($activity eq 'passwd') {
                   5078:         $text = &mt('Password Changing Blocked');
1.1062    raeburn  5079:     }
1.1061    raeburn  5080:     $output .= <<"END_BLOCK";
1.1075.2.93  raeburn  5081: <div class='$class'>
1.869     kalberla 5082:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 5083:   title='$text'>
                   5084:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 5085:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 5086:   title='$text'>$text</a>
1.867     kalberla 5087: </div>
                   5088: 
                   5089: END_BLOCK
1.474     raeburn  5090: 
1.1061    raeburn  5091:     return ($blocked, $output);
1.854     kalberla 5092: }
1.490     raeburn  5093: 
1.60      matthew  5094: ###############################################
                   5095: 
1.682     raeburn  5096: sub check_ip_acc {
1.1075.2.105  raeburn  5097:     my ($acc,$clientip)=@_;
1.682     raeburn  5098:     &Apache::lonxml::debug("acc is $acc");
                   5099:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   5100:         return 1;
                   5101:     }
                   5102:     my $allowed=0;
1.1075.2.144  raeburn  5103:     my $ip;
                   5104:     if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
                   5105:         ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
                   5106:         $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
                   5107:     } else {
1.1075.2.150  raeburn  5108:         my $remote_ip = &Apache::lonnet::get_requestor_ip();
                   5109:         $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1075.2.144  raeburn  5110:     }
1.682     raeburn  5111: 
                   5112:     my $name;
                   5113:     foreach my $pattern (split(',',$acc)) {
                   5114:         $pattern =~ s/^\s*//;
                   5115:         $pattern =~ s/\s*$//;
                   5116:         if ($pattern =~ /\*$/) {
                   5117:             #35.8.*
                   5118:             $pattern=~s/\*//;
                   5119:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   5120:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   5121:             #35.8.3.[34-56]
                   5122:             my $low=$2;
                   5123:             my $high=$3;
                   5124:             $pattern=$1;
                   5125:             if ($ip =~ /^\Q$pattern\E/) {
                   5126:                 my $last=(split(/\./,$ip))[3];
                   5127:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   5128:             }
                   5129:         } elsif ($pattern =~ /^\*/) {
                   5130:             #*.msu.edu
                   5131:             $pattern=~s/\*//;
                   5132:             if (!defined($name)) {
                   5133:                 use Socket;
                   5134:                 my $netaddr=inet_aton($ip);
                   5135:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   5136:             }
                   5137:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   5138:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   5139:             #127.0.0.1
                   5140:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   5141:         } else {
                   5142:             #some.name.com
                   5143:             if (!defined($name)) {
                   5144:                 use Socket;
                   5145:                 my $netaddr=inet_aton($ip);
                   5146:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   5147:             }
                   5148:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   5149:         }
                   5150:         if ($allowed) { last; }
                   5151:     }
                   5152:     return $allowed;
                   5153: }
                   5154: 
                   5155: ###############################################
                   5156: 
1.60      matthew  5157: =pod
                   5158: 
1.112     bowersj2 5159: =head1 Domain Template Functions
                   5160: 
                   5161: =over 4
                   5162: 
                   5163: =item * &determinedomain()
1.60      matthew  5164: 
                   5165: Inputs: $domain (usually will be undef)
                   5166: 
1.63      www      5167: Returns: Determines which domain should be used for designs
1.60      matthew  5168: 
                   5169: =cut
1.54      www      5170: 
1.60      matthew  5171: ###############################################
1.63      www      5172: sub determinedomain {
                   5173:     my $domain=shift;
1.531     albertel 5174:     if (! $domain) {
1.60      matthew  5175:         # Determine domain if we have not been given one
1.893     raeburn  5176:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 5177:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   5178:         if ($env{'request.role.domain'}) { 
                   5179:             $domain=$env{'request.role.domain'}; 
1.60      matthew  5180:         }
                   5181:     }
1.63      www      5182:     return $domain;
                   5183: }
                   5184: ###############################################
1.517     raeburn  5185: 
1.518     albertel 5186: sub devalidate_domconfig_cache {
                   5187:     my ($udom)=@_;
                   5188:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   5189: }
                   5190: 
                   5191: # ---------------------- Get domain configuration for a domain
                   5192: sub get_domainconf {
                   5193:     my ($udom) = @_;
                   5194:     my $cachetime=1800;
                   5195:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   5196:     if (defined($cached)) { return %{$result}; }
                   5197: 
                   5198:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  5199: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  5200:     my (%designhash,%legacy);
1.518     albertel 5201:     if (keys(%domconfig) > 0) {
                   5202:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  5203:             if (keys(%{$domconfig{'login'}})) {
                   5204:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  5205:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1075.2.87  raeburn  5206:                         if (($key eq 'loginvia') || ($key eq 'headtag')) {
                   5207:                             if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   5208:                                 foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
                   5209:                                     if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
                   5210:                                         if ($key eq 'loginvia') {
                   5211:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   5212:                                                 my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   5213:                                                 $designhash{$udom.'.login.loginvia'} = $server;
                   5214:                                                 if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   5215:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   5216:                                                 } else {
                   5217:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
                   5218:                                                 }
1.948     raeburn  5219:                                             }
1.1075.2.87  raeburn  5220:                                         } elsif ($key eq 'headtag') {
                   5221:                                             if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
                   5222:                                                 $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948     raeburn  5223:                                             }
1.946     raeburn  5224:                                         }
1.1075.2.87  raeburn  5225:                                         if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
                   5226:                                             $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
                   5227:                                         }
1.946     raeburn  5228:                                     }
                   5229:                                 }
                   5230:                             }
                   5231:                         } else {
                   5232:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   5233:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   5234:                                     $domconfig{'login'}{$key}{$img};
                   5235:                             }
1.699     raeburn  5236:                         }
                   5237:                     } else {
                   5238:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   5239:                     }
1.632     raeburn  5240:                 }
                   5241:             } else {
                   5242:                 $legacy{'login'} = 1;
1.518     albertel 5243:             }
1.632     raeburn  5244:         } else {
                   5245:             $legacy{'login'} = 1;
1.518     albertel 5246:         }
                   5247:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  5248:             if (keys(%{$domconfig{'rolecolors'}})) {
                   5249:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   5250:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   5251:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   5252:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   5253:                         }
1.518     albertel 5254:                     }
                   5255:                 }
1.632     raeburn  5256:             } else {
                   5257:                 $legacy{'rolecolors'} = 1;
1.518     albertel 5258:             }
1.632     raeburn  5259:         } else {
                   5260:             $legacy{'rolecolors'} = 1;
1.518     albertel 5261:         }
1.948     raeburn  5262:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   5263:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   5264:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   5265:             }
                   5266:         }
1.632     raeburn  5267:         if (keys(%legacy) > 0) {
                   5268:             my %legacyhash = &get_legacy_domconf($udom);
                   5269:             foreach my $item (keys(%legacyhash)) {
                   5270:                 if ($item =~ /^\Q$udom\E\.login/) {
                   5271:                     if ($legacy{'login'}) { 
                   5272:                         $designhash{$item} = $legacyhash{$item};
                   5273:                     }
                   5274:                 } else {
                   5275:                     if ($legacy{'rolecolors'}) {
                   5276:                         $designhash{$item} = $legacyhash{$item};
                   5277:                     }
1.518     albertel 5278:                 }
                   5279:             }
                   5280:         }
1.632     raeburn  5281:     } else {
                   5282:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 5283:     }
                   5284:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   5285: 				  $cachetime);
                   5286:     return %designhash;
                   5287: }
                   5288: 
1.632     raeburn  5289: sub get_legacy_domconf {
                   5290:     my ($udom) = @_;
                   5291:     my %legacyhash;
                   5292:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   5293:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   5294:     if (-e $designfile) {
1.1075.2.128  raeburn  5295:         if ( open (my $fh,'<',$designfile) ) {
1.632     raeburn  5296:             while (my $line = <$fh>) {
                   5297:                 next if ($line =~ /^\#/);
                   5298:                 chomp($line);
                   5299:                 my ($key,$val)=(split(/\=/,$line));
                   5300:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   5301:             }
                   5302:             close($fh);
                   5303:         }
                   5304:     }
1.1026    raeburn  5305:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  5306:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   5307:     }
                   5308:     return %legacyhash;
                   5309: }
                   5310: 
1.63      www      5311: =pod
                   5312: 
1.112     bowersj2 5313: =item * &domainlogo()
1.63      www      5314: 
                   5315: Inputs: $domain (usually will be undef)
                   5316: 
                   5317: Returns: A link to a domain logo, if the domain logo exists.
                   5318: If the domain logo does not exist, a description of the domain.
                   5319: 
                   5320: =cut
1.112     bowersj2 5321: 
1.63      www      5322: ###############################################
                   5323: sub domainlogo {
1.517     raeburn  5324:     my $domain = &determinedomain(shift);
1.518     albertel 5325:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  5326:     # See if there is a logo
                   5327:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  5328:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 5329:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   5330: 	    if ($imgsrc =~ m{^/res/}) {
                   5331: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   5332: 		&Apache::lonnet::repcopy($local_name);
                   5333: 	    }
                   5334: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  5335:         } 
                   5336:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 5337:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   5338:         return &Apache::lonnet::domain($domain,'description');
1.59      www      5339:     } else {
1.60      matthew  5340:         return '';
1.59      www      5341:     }
                   5342: }
1.63      www      5343: ##############################################
                   5344: 
                   5345: =pod
                   5346: 
1.112     bowersj2 5347: =item * &designparm()
1.63      www      5348: 
                   5349: Inputs: $which parameter; $domain (usually will be undef)
                   5350: 
                   5351: Returns: value of designparamter $which
                   5352: 
                   5353: =cut
1.112     bowersj2 5354: 
1.397     albertel 5355: 
1.400     albertel 5356: ##############################################
1.397     albertel 5357: sub designparm {
                   5358:     my ($which,$domain)=@_;
                   5359:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   5360:         return $env{'environment.color.'.$which};
1.96      www      5361:     }
1.63      www      5362:     $domain=&determinedomain($domain);
1.1016    raeburn  5363:     my %domdesign;
                   5364:     unless ($domain eq 'public') {
                   5365:         %domdesign = &get_domainconf($domain);
                   5366:     }
1.520     raeburn  5367:     my $output;
1.517     raeburn  5368:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   5369:         $output = $domdesign{$domain.'.'.$which};
1.63      www      5370:     } else {
1.520     raeburn  5371:         $output = $defaultdesign{$which};
                   5372:     }
                   5373:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  5374:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 5375:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   5376:             if ($output =~ m{^/res/}) {
                   5377:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   5378:                 &Apache::lonnet::repcopy($local_name);
                   5379:             }
1.520     raeburn  5380:             $output = &lonhttpdurl($output);
                   5381:         }
1.63      www      5382:     }
1.520     raeburn  5383:     return $output;
1.63      www      5384: }
1.59      www      5385: 
1.822     bisitz   5386: ##############################################
                   5387: =pod
                   5388: 
1.832     bisitz   5389: =item * &authorspace()
                   5390: 
1.1028    raeburn  5391: Inputs: $url (usually will be undef).
1.832     bisitz   5392: 
1.1075.2.40  raeburn  5393: Returns: Path to Authoring Space containing the resource or 
1.1028    raeburn  5394:          directory being viewed (or for which action is being taken). 
                   5395:          If $url is provided, and begins /priv/<domain>/<uname>
                   5396:          the path will be that portion of the $context argument.
                   5397:          Otherwise the path will be for the author space of the current
                   5398:          user when the current role is author, or for that of the 
                   5399:          co-author/assistant co-author space when the current role 
                   5400:          is co-author or assistant co-author.
1.832     bisitz   5401: 
                   5402: =cut
                   5403: 
                   5404: sub authorspace {
1.1028    raeburn  5405:     my ($url) = @_;
                   5406:     if ($url ne '') {
                   5407:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   5408:            return $1;
                   5409:         }
                   5410:     }
1.832     bisitz   5411:     my $caname = '';
1.1024    www      5412:     my $cadom = '';
1.1028    raeburn  5413:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      5414:         ($cadom,$caname) =
1.832     bisitz   5415:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  5416:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   5417:         $caname = $env{'user.name'};
1.1024    www      5418:         $cadom = $env{'user.domain'};
1.832     bisitz   5419:     }
1.1028    raeburn  5420:     if (($caname ne '') && ($cadom ne '')) {
                   5421:         return "/priv/$cadom/$caname/";
                   5422:     }
                   5423:     return;
1.832     bisitz   5424: }
                   5425: 
                   5426: ##############################################
                   5427: =pod
                   5428: 
1.822     bisitz   5429: =item * &head_subbox()
                   5430: 
                   5431: Inputs: $content (contains HTML code with page functions, etc.)
                   5432: 
                   5433: Returns: HTML div with $content
                   5434:          To be included in page header
                   5435: 
                   5436: =cut
                   5437: 
                   5438: sub head_subbox {
                   5439:     my ($content)=@_;
                   5440:     my $output =
1.993     raeburn  5441:         '<div class="LC_head_subbox">'
1.822     bisitz   5442:        .$content
                   5443:        .'</div>'
                   5444: }
                   5445: 
                   5446: ##############################################
                   5447: =pod
                   5448: 
                   5449: =item * &CSTR_pageheader()
                   5450: 
1.1026    raeburn  5451: Input: (optional) filename from which breadcrumb trail is built.
                   5452:        In most cases no input as needed, as $env{'request.filename'}
                   5453:        is appropriate for use in building the breadcrumb trail.
1.822     bisitz   5454: 
                   5455: Returns: HTML div with CSTR path and recent box
1.1075.2.40  raeburn  5456:          To be included on Authoring Space pages
1.822     bisitz   5457: 
                   5458: =cut
                   5459: 
                   5460: sub CSTR_pageheader {
1.1026    raeburn  5461:     my ($trailfile) = @_;
                   5462:     if ($trailfile eq '') {
                   5463:         $trailfile = $env{'request.filename'};
                   5464:     }
                   5465: 
                   5466: # this is for resources; directories have customtitle, and crumbs
                   5467: # and select recent are created in lonpubdir.pm
                   5468: 
                   5469:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      5470:     my ($udom,$uname,$thisdisfn)=
1.1075.2.29  raeburn  5471:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026    raeburn  5472:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   5473:     $formaction =~ s{/+}{/}g;
1.822     bisitz   5474: 
                   5475:     my $parentpath = '';
                   5476:     my $lastitem = '';
                   5477:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   5478:         $parentpath = $1;
                   5479:         $lastitem = $2;
                   5480:     } else {
                   5481:         $lastitem = $thisdisfn;
                   5482:     }
1.921     bisitz   5483: 
                   5484:     my $output =
1.822     bisitz   5485:          '<div>'
                   5486:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1075.2.40  raeburn  5487:         .'<b>'.&mt('Authoring Space:').'</b> '
1.822     bisitz   5488:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   5489:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024    www      5490:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921     bisitz   5491: 
                   5492:     if ($lastitem) {
                   5493:         $output .=
                   5494:              '<span class="LC_filename">'
                   5495:             .$lastitem
                   5496:             .'</span>';
                   5497:     }
                   5498:     $output .=
                   5499:          '<br />'
1.822     bisitz   5500:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   5501:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   5502:         .'</form>'
                   5503:         .&Apache::lonmenu::constspaceform()
                   5504:         .'</div>';
1.921     bisitz   5505: 
                   5506:     return $output;
1.822     bisitz   5507: }
                   5508: 
1.60      matthew  5509: ###############################################
                   5510: ###############################################
                   5511: 
                   5512: =pod
                   5513: 
1.112     bowersj2 5514: =back
                   5515: 
1.549     albertel 5516: =head1 HTML Helpers
1.112     bowersj2 5517: 
                   5518: =over 4
                   5519: 
                   5520: =item * &bodytag()
1.60      matthew  5521: 
                   5522: Returns a uniform header for LON-CAPA web pages.
                   5523: 
                   5524: Inputs: 
                   5525: 
1.112     bowersj2 5526: =over 4
                   5527: 
                   5528: =item * $title, A title to be displayed on the page.
                   5529: 
                   5530: =item * $function, the current role (can be undef).
                   5531: 
                   5532: =item * $addentries, extra parameters for the <body> tag.
                   5533: 
                   5534: =item * $bodyonly, if defined, only return the <body> tag.
                   5535: 
                   5536: =item * $domain, if defined, force a given domain.
                   5537: 
                   5538: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      5539:             text interface only)
1.60      matthew  5540: 
1.814     bisitz   5541: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   5542:                      navigational links
1.317     albertel 5543: 
1.338     albertel 5544: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   5545: 
1.1075.2.12  raeburn  5546: =item * $no_inline_link, if true and in remote mode, don't show the
                   5547:          'Switch To Inline Menu' link
                   5548: 
1.460     albertel 5549: =item * $args, optional argument valid values are
                   5550:             no_auto_mt_title -> prevents &mt()ing the title arg
1.1075.2.133  raeburn  5551:             use_absolute     -> for external resource or syllabus, this will
                   5552:                                 contain https://<hostname> if server uses
                   5553:                                 https (as per hosts.tab), but request is for http
                   5554:             hostname         -> hostname, from $r->hostname().
1.460     albertel 5555: 
1.1075.2.15  raeburn  5556: =item * $advtoolsref, optional argument, ref to an array containing
                   5557:             inlineremote items to be added in "Functions" menu below
                   5558:             breadcrumbs.
                   5559: 
1.112     bowersj2 5560: =back
                   5561: 
1.60      matthew  5562: Returns: A uniform header for LON-CAPA web pages.  
                   5563: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   5564: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   5565: other decorations will be returned.
                   5566: 
                   5567: =cut
                   5568: 
1.54      www      5569: sub bodytag {
1.831     bisitz   5570:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1075.2.15  raeburn  5571:         $no_nav_bar,$bgcolor,$no_inline_link,$args,$advtoolsref)=@_;
1.339     albertel 5572: 
1.954     raeburn  5573:     my $public;
                   5574:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   5575:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   5576:         $public = 1;
                   5577:     }
1.460     albertel 5578:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1075.2.52  raeburn  5579:     my $httphost = $args->{'use_absolute'};
1.1075.2.133  raeburn  5580:     my $hostname = $args->{'hostname'};
1.339     albertel 5581: 
1.183     matthew  5582:     $function = &get_users_function() if (!$function);
1.339     albertel 5583:     my $img =    &designparm($function.'.img',$domain);
                   5584:     my $font =   &designparm($function.'.font',$domain);
                   5585:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   5586: 
1.803     bisitz   5587:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 5588: 		   'bgcolor' => $pgbg,
1.339     albertel 5589: 		   'text'    => $font,
                   5590:                    'alink'   => &designparm($function.'.alink',$domain),
                   5591: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   5592: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 5593:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 5594: 
1.63      www      5595:  # role and realm
1.1075.2.68  raeburn  5596:     my ($role,$realm) = split(m{\./},$env{'request.role'},2);
                   5597:     if ($realm) {
                   5598:         $realm = '/'.$realm;
                   5599:     }
1.378     raeburn  5600:     if ($role  eq 'ca') {
1.479     albertel 5601:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 5602:         $realm = &plainname($rname,$rdom);
1.378     raeburn  5603:     } 
1.55      www      5604: # realm
1.258     albertel 5605:     if ($env{'request.course.id'}) {
1.378     raeburn  5606:         if ($env{'request.role'} !~ /^cr/) {
                   5607:             $role = &Apache::lonnet::plaintext($role,&course_type());
1.1075.2.115  raeburn  5608:         } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1075.2.121  raeburn  5609:             if ($env{'request.role.desc'}) {
                   5610:                 $role = $env{'request.role.desc'};
                   5611:             } else {
                   5612:                 $role = &mt('Helpdesk[_1]','&nbsp;'.$2);
                   5613:             }
1.1075.2.115  raeburn  5614:         } else {
                   5615:             $role = (split(/\//,$role,4))[-1];
1.378     raeburn  5616:         }
1.898     raeburn  5617:         if ($env{'request.course.sec'}) {
                   5618:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   5619:         }   
1.359     albertel 5620: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  5621:     } else {
                   5622:         $role = &Apache::lonnet::plaintext($role);
1.54      www      5623:     }
1.433     albertel 5624: 
1.359     albertel 5625:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 5626: 
1.438     albertel 5627:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 5628: 
1.101     www      5629: # construct main body tag
1.359     albertel 5630:     my $bodytag = "<body $extra_body_attr>".
1.1075.2.100  raeburn  5631: 	&Apache::lontexconvert::init_math_support();
1.252     albertel 5632: 
1.1075.2.38  raeburn  5633:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   5634: 
                   5635:     if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60      matthew  5636:         return $bodytag;
1.1075.2.38  raeburn  5637:     }
1.359     albertel 5638: 
1.954     raeburn  5639:     if ($public) {
1.433     albertel 5640: 	undef($role);
                   5641:     }
1.359     albertel 5642:     
1.762     bisitz   5643:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 5644:     #
                   5645:     # Extra info if you are the DC
                   5646:     my $dc_info = '';
                   5647:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   5648:                         $env{'course.'.$env{'request.course.id'}.
                   5649:                                  '.domain'}.'/'})) {
                   5650:         my $cid = $env{'request.course.id'};
1.917     raeburn  5651:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      5652:         $dc_info =~ s/\s+$//;
1.359     albertel 5653:     }
                   5654: 
1.1075.2.108  raeburn  5655:     $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.903     droeschl 5656: 
1.1075.2.13  raeburn  5657:     if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   5658: 
1.1075.2.38  raeburn  5659: 
                   5660: 
1.1075.2.21  raeburn  5661:     my $funclist;
                   5662:     if (($env{'environment.remote'} eq 'on') && ($env{'request.state'} ne 'construct')) {
1.1075.2.52  raeburn  5663:         $bodytag .= Apache::lonhtmlcommon::scripttag(Apache::lonmenu::utilityfunctions($httphost), 'start')."\n".
1.1075.2.21  raeburn  5664:                     Apache::lonmenu::serverform();
                   5665:         my $forbodytag;
                   5666:         &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5667:                                             $forcereg,$args->{'group'},
                   5668:                                             $args->{'bread_crumbs'},
1.1075.2.133  raeburn  5669:                                             $advtoolsref,'','',\$forbodytag);
1.1075.2.21  raeburn  5670:         unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5671:             $funclist = $forbodytag;
                   5672:         }
                   5673:     } else {
1.903     droeschl 5674: 
                   5675:         #    if ($env{'request.state'} eq 'construct') {
                   5676:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   5677:         #    }
                   5678: 
1.1075.2.38  raeburn  5679:         $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  5680:             Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359     albertel 5681: 
1.1075.2.38  raeburn  5682:         my ($left,$right) = Apache::lonmenu::primary_menu();
1.1075.2.2  raeburn  5683: 
1.916     droeschl 5684:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.1075.2.22  raeburn  5685:             if ($dc_info) {
                   5686:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
1.1075.2.1  raeburn  5687:             }
1.1075.2.38  raeburn  5688:             $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
1.1075.2.22  raeburn  5689:                            <em>$realm</em> $dc_info</div>|;
1.903     droeschl 5690:             return $bodytag;
                   5691:         }
1.894     droeschl 5692: 
1.927     raeburn  5693:         unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
1.1075.2.38  raeburn  5694:             $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
1.927     raeburn  5695:         }
1.916     droeschl 5696: 
1.1075.2.38  raeburn  5697:         $bodytag .= $right;
1.852     droeschl 5698: 
1.917     raeburn  5699:         if ($dc_info) {
                   5700:             $dc_info = &dc_courseid_toggle($dc_info);
                   5701:         }
                   5702:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 5703: 
1.1075.2.61  raeburn  5704:         #if directed to not display the secondary menu, don't.
                   5705:         if ($args->{'no_secondary_menu'}) {
                   5706:             return $bodytag;
                   5707:         }
1.903     droeschl 5708:         #don't show menus for public users
1.954     raeburn  5709:         if (!$public){
1.1075.2.52  raeburn  5710:             $bodytag .= Apache::lonmenu::secondary_menu($httphost);
1.903     droeschl 5711:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  5712:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   5713:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 5714:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1075.2.133  raeburn  5715:                                 $args->{'bread_crumbs'},'','',$hostname);
1.1075.2.116  raeburn  5716:             } elsif ($forcereg) {
1.1075.2.22  raeburn  5717:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1075.2.116  raeburn  5718:                                                             $args->{'group'},
1.1075.2.133  raeburn  5719:                                                             $args->{'hide_buttons',
                   5720:                                                             $hostname});
1.1075.2.15  raeburn  5721:             } else {
1.1075.2.21  raeburn  5722:                 my $forbodytag;
                   5723:                 &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5724:                                                     $forcereg,$args->{'group'},
                   5725:                                                     $args->{'bread_crumbs'},
1.1075.2.133  raeburn  5726:                                                     $advtoolsref,'',$hostname,
                   5727:                                                     \$forbodytag);
1.1075.2.21  raeburn  5728:                 unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5729:                     $bodytag .= $forbodytag;
                   5730:                 }
1.920     raeburn  5731:             }
1.903     droeschl 5732:         }else{
                   5733:             # this is to seperate menu from content when there's no secondary
                   5734:             # menu. Especially needed for public accessible ressources.
                   5735:             $bodytag .= '<hr style="clear:both" />';
                   5736:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  5737:         }
1.903     droeschl 5738: 
1.235     raeburn  5739:         return $bodytag;
1.1075.2.12  raeburn  5740:     }
                   5741: 
                   5742: #
                   5743: # Top frame rendering, Remote is up
                   5744: #
                   5745: 
                   5746:     my $imgsrc = $img;
                   5747:     if ($img =~ /^\/adm/) {
                   5748:         $imgsrc = &lonhttpdurl($img);
                   5749:     }
                   5750:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
                   5751: 
1.1075.2.60  raeburn  5752:     my $help=($no_inline_link?''
                   5753:               :&Apache::loncommon::top_nav_help('Help'));
                   5754: 
1.1075.2.12  raeburn  5755:     # Explicit link to get inline menu
                   5756:     my $menu= ($no_inline_link?''
                   5757:                :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
                   5758: 
                   5759:     if ($dc_info) {
                   5760:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   5761:     }
                   5762: 
1.1075.2.38  raeburn  5763:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
                   5764:     unless ($public) {
                   5765:         $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
                   5766:                                 undef,'LC_menubuttons_link');
                   5767:     }
                   5768: 
1.1075.2.12  raeburn  5769:     unless ($env{'form.inhibitmenu'}) {
                   5770:         $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.1075.2.38  raeburn  5771:                        <ol class="LC_primary_menu LC_floatright LC_right">
1.1075.2.60  raeburn  5772:                        <li>$help</li>
1.1075.2.12  raeburn  5773:                        <li>$menu</li>
                   5774:                        </ol><div id="LC_realm"> $realm $dc_info</div>|;
                   5775:     }
1.1075.2.13  raeburn  5776:     if ($env{'request.state'} eq 'construct') {
                   5777:         if (!$public){
                   5778:             if ($env{'request.state'} eq 'construct') {
                   5779:                 $funclist = &Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  5780:                                 &Apache::lonmenu::utilityfunctions($httphost), 'start').
1.1075.2.13  raeburn  5781:                             &Apache::lonhtmlcommon::scripttag('','end').
                   5782:                             &Apache::lonmenu::innerregister($forcereg,
                   5783:                                                             $args->{'bread_crumbs'});
                   5784:             }
                   5785:         }
                   5786:     }
1.1075.2.21  raeburn  5787:     return $bodytag."\n".$funclist;
1.182     matthew  5788: }
                   5789: 
1.917     raeburn  5790: sub dc_courseid_toggle {
                   5791:     my ($dc_info) = @_;
1.980     raeburn  5792:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  5793:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  5794:            &mt('(More ...)').'</a></span>'.
                   5795:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5796: }
                   5797: 
1.330     albertel 5798: sub make_attr_string {
                   5799:     my ($register,$attr_ref) = @_;
                   5800: 
                   5801:     if ($attr_ref && !ref($attr_ref)) {
                   5802: 	die("addentries Must be a hash ref ".
                   5803: 	    join(':',caller(1))." ".
                   5804: 	    join(':',caller(0))." ");
                   5805:     }
                   5806: 
                   5807:     if ($register) {
1.339     albertel 5808: 	my ($on_load,$on_unload);
                   5809: 	foreach my $key (keys(%{$attr_ref})) {
                   5810: 	    if      (lc($key) eq 'onload') {
                   5811: 		$on_load.=$attr_ref->{$key}.';';
                   5812: 		delete($attr_ref->{$key});
                   5813: 
                   5814: 	    } elsif (lc($key) eq 'onunload') {
                   5815: 		$on_unload.=$attr_ref->{$key}.';';
                   5816: 		delete($attr_ref->{$key});
                   5817: 	    }
                   5818: 	}
1.1075.2.12  raeburn  5819:         if ($env{'environment.remote'} eq 'on') {
                   5820:             $attr_ref->{'onload'}  =
                   5821:                 &Apache::lonmenu::loadevents().  $on_load;
                   5822:             $attr_ref->{'onunload'}=
                   5823:                 &Apache::lonmenu::unloadevents().$on_unload;
                   5824:         } else {  
                   5825: 	    $attr_ref->{'onload'}  = $on_load;
                   5826: 	    $attr_ref->{'onunload'}= $on_unload;
                   5827:         }
1.330     albertel 5828:     }
1.339     albertel 5829: 
1.330     albertel 5830:     my $attr_string;
1.1075.2.56  raeburn  5831:     foreach my $attr (sort(keys(%$attr_ref))) {
1.330     albertel 5832: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   5833:     }
                   5834:     return $attr_string;
                   5835: }
                   5836: 
                   5837: 
1.182     matthew  5838: ###############################################
1.251     albertel 5839: ###############################################
                   5840: 
                   5841: =pod
                   5842: 
                   5843: =item * &endbodytag()
                   5844: 
                   5845: Returns a uniform footer for LON-CAPA web pages.
                   5846: 
1.635     raeburn  5847: Inputs: 1 - optional reference to an args hash
                   5848: If in the hash, key for noredirectlink has a value which evaluates to true,
                   5849: a 'Continue' link is not displayed if the page contains an
                   5850: internal redirect in the <head></head> section,
                   5851: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 5852: 
                   5853: =cut
                   5854: 
                   5855: sub endbodytag {
1.635     raeburn  5856:     my ($args) = @_;
1.1075.2.6  raeburn  5857:     my $endbodytag;
                   5858:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   5859:         $endbodytag='</body>';
                   5860:     }
1.315     albertel 5861:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  5862:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   5863: 	    $endbodytag=
                   5864: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   5865: 	        &mt('Continue').'</a>'.
                   5866: 	        $endbodytag;
                   5867:         }
1.315     albertel 5868:     }
1.251     albertel 5869:     return $endbodytag;
                   5870: }
                   5871: 
1.352     albertel 5872: =pod
                   5873: 
                   5874: =item * &standard_css()
                   5875: 
                   5876: Returns a style sheet
                   5877: 
                   5878: Inputs: (all optional)
                   5879:             domain         -> force to color decorate a page for a specific
                   5880:                                domain
                   5881:             function       -> force usage of a specific rolish color scheme
                   5882:             bgcolor        -> override the default page bgcolor
                   5883: 
                   5884: =cut
                   5885: 
1.343     albertel 5886: sub standard_css {
1.345     albertel 5887:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 5888:     $function  = &get_users_function() if (!$function);
                   5889:     my $img    = &designparm($function.'.img',   $domain);
                   5890:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   5891:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 5892:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 5893: #second colour for later usage
1.345     albertel 5894:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 5895:     my $pgbg_or_bgcolor =
                   5896: 	         $bgcolor ||
1.352     albertel 5897: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 5898:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 5899:     my $alink  = &designparm($function.'.alink', $domain);
                   5900:     my $vlink  = &designparm($function.'.vlink', $domain);
                   5901:     my $link   = &designparm($function.'.link',  $domain);
                   5902: 
1.602     albertel 5903:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 5904:     my $mono                 = 'monospace';
1.850     bisitz   5905:     my $data_table_head      = $sidebg;
                   5906:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   5907:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 5908:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 5909:     my $data_table_highlight = '#FFFF00';
1.352     albertel 5910:     my $mail_new             = '#FFBB77';
                   5911:     my $mail_new_hover       = '#DD9955';
                   5912:     my $mail_read            = '#BBBB77';
                   5913:     my $mail_read_hover      = '#999944';
                   5914:     my $mail_replied         = '#AAAA88';
                   5915:     my $mail_replied_hover   = '#888855';
                   5916:     my $mail_other           = '#99BBBB';
                   5917:     my $mail_other_hover     = '#669999';
1.391     albertel 5918:     my $table_header         = '#DDDDDD';
1.489     raeburn  5919:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   5920:     my $lg_border_color      = '#C8C8C8';
1.952     onken    5921:     my $button_hover         = '#BF2317';
1.392     albertel 5922: 
1.608     albertel 5923:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   5924:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   5925:                                              : '0 3px 0 4px';
1.448     albertel 5926: 
1.523     albertel 5927: 
1.343     albertel 5928:     return <<END;
1.947     droeschl 5929: 
                   5930: /* needed for iframe to allow 100% height in FF */
                   5931: body, html { 
                   5932:     margin: 0;
                   5933:     padding: 0 0.5%;
                   5934:     height: 99%; /* to avoid scrollbars */
                   5935: }
                   5936: 
1.795     www      5937: body {
1.911     bisitz   5938:   font-family: $sans;
                   5939:   line-height:130%;
                   5940:   font-size:0.83em;
                   5941:   color:$font;
1.795     www      5942: }
                   5943: 
1.959     onken    5944: a:focus,
                   5945: a:focus img {
1.795     www      5946:   color: red;
                   5947: }
1.698     harmsja  5948: 
1.911     bisitz   5949: form, .inline {
                   5950:   display: inline;
1.795     www      5951: }
1.721     harmsja  5952: 
1.795     www      5953: .LC_right {
1.911     bisitz   5954:   text-align:right;
1.795     www      5955: }
                   5956: 
                   5957: .LC_middle {
1.911     bisitz   5958:   vertical-align:middle;
1.795     www      5959: }
1.721     harmsja  5960: 
1.1075.2.38  raeburn  5961: .LC_floatleft {
                   5962:   float: left;
                   5963: }
                   5964: 
                   5965: .LC_floatright {
                   5966:   float: right;
                   5967: }
                   5968: 
1.911     bisitz   5969: .LC_400Box {
                   5970:   width:400px;
                   5971: }
1.721     harmsja  5972: 
1.947     droeschl 5973: .LC_iframecontainer {
                   5974:     width: 98%;
                   5975:     margin: 0;
                   5976:     position: fixed;
                   5977:     top: 8.5em;
                   5978:     bottom: 0;
                   5979: }
                   5980: 
                   5981: .LC_iframecontainer iframe{
                   5982:     border: none;
                   5983:     width: 100%;
                   5984:     height: 100%;
                   5985: }
                   5986: 
1.778     bisitz   5987: .LC_filename {
                   5988:   font-family: $mono;
                   5989:   white-space:pre;
1.921     bisitz   5990:   font-size: 120%;
1.778     bisitz   5991: }
                   5992: 
                   5993: .LC_fileicon {
                   5994:   border: none;
                   5995:   height: 1.3em;
                   5996:   vertical-align: text-bottom;
                   5997:   margin-right: 0.3em;
                   5998:   text-decoration:none;
                   5999: }
                   6000: 
1.1008    www      6001: .LC_setting {
                   6002:   text-decoration:underline;
                   6003: }
                   6004: 
1.350     albertel 6005: .LC_error {
                   6006:   color: red;
                   6007: }
1.795     www      6008: 
1.1075.2.15  raeburn  6009: .LC_warning {
                   6010:   color: darkorange;
                   6011: }
                   6012: 
1.457     albertel 6013: .LC_diff_removed {
1.733     bisitz   6014:   color: red;
1.394     albertel 6015: }
1.532     albertel 6016: 
                   6017: .LC_info,
1.457     albertel 6018: .LC_success,
                   6019: .LC_diff_added {
1.350     albertel 6020:   color: green;
                   6021: }
1.795     www      6022: 
1.802     bisitz   6023: div.LC_confirm_box {
                   6024:   background-color: #FAFAFA;
                   6025:   border: 1px solid $lg_border_color;
                   6026:   margin-right: 0;
                   6027:   padding: 5px;
                   6028: }
                   6029: 
                   6030: div.LC_confirm_box .LC_error img,
                   6031: div.LC_confirm_box .LC_success img {
                   6032:   vertical-align: middle;
                   6033: }
                   6034: 
1.1075.2.108  raeburn  6035: .LC_maxwidth {
                   6036:   max-width: 100%;
                   6037:   height: auto;
                   6038: }
                   6039: 
                   6040: .LC_textsize_mobile {
                   6041:   \@media only screen and (max-device-width: 480px) {
                   6042:       -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
                   6043:   }
                   6044: }
                   6045: 
1.440     albertel 6046: .LC_icon {
1.771     droeschl 6047:   border: none;
1.790     droeschl 6048:   vertical-align: middle;
1.771     droeschl 6049: }
                   6050: 
1.543     albertel 6051: .LC_docs_spacer {
                   6052:   width: 25px;
                   6053:   height: 1px;
1.771     droeschl 6054:   border: none;
1.543     albertel 6055: }
1.346     albertel 6056: 
1.532     albertel 6057: .LC_internal_info {
1.735     bisitz   6058:   color: #999999;
1.532     albertel 6059: }
                   6060: 
1.794     www      6061: .LC_discussion {
1.1050    www      6062:   background: $data_table_dark;
1.911     bisitz   6063:   border: 1px solid black;
                   6064:   margin: 2px;
1.794     www      6065: }
                   6066: 
                   6067: .LC_disc_action_left {
1.1050    www      6068:   background: $sidebg;
1.911     bisitz   6069:   text-align: left;
1.1050    www      6070:   padding: 4px;
                   6071:   margin: 2px;
1.794     www      6072: }
                   6073: 
                   6074: .LC_disc_action_right {
1.1050    www      6075:   background: $sidebg;
1.911     bisitz   6076:   text-align: right;
1.1050    www      6077:   padding: 4px;
                   6078:   margin: 2px;
1.794     www      6079: }
                   6080: 
                   6081: .LC_disc_new_item {
1.911     bisitz   6082:   background: white;
                   6083:   border: 2px solid red;
1.1050    www      6084:   margin: 4px;
                   6085:   padding: 4px;
1.794     www      6086: }
                   6087: 
                   6088: .LC_disc_old_item {
1.911     bisitz   6089:   background: white;
1.1050    www      6090:   margin: 4px;
                   6091:   padding: 4px;
1.794     www      6092: }
                   6093: 
1.458     albertel 6094: table.LC_pastsubmission {
                   6095:   border: 1px solid black;
                   6096:   margin: 2px;
                   6097: }
                   6098: 
1.924     bisitz   6099: table#LC_menubuttons {
1.345     albertel 6100:   width: 100%;
                   6101:   background: $pgbg;
1.392     albertel 6102:   border: 2px;
1.402     albertel 6103:   border-collapse: separate;
1.803     bisitz   6104:   padding: 0;
1.345     albertel 6105: }
1.392     albertel 6106: 
1.801     tempelho 6107: table#LC_title_bar a {
                   6108:   color: $fontmenu;
                   6109: }
1.836     bisitz   6110: 
1.807     droeschl 6111: table#LC_title_bar {
1.819     tempelho 6112:   clear: both;
1.836     bisitz   6113:   display: none;
1.807     droeschl 6114: }
                   6115: 
1.795     www      6116: table#LC_title_bar,
1.933     droeschl 6117: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 6118: table#LC_title_bar.LC_with_remote {
1.359     albertel 6119:   width: 100%;
1.392     albertel 6120:   border-color: $pgbg;
                   6121:   border-style: solid;
                   6122:   border-width: $border;
1.379     albertel 6123:   background: $pgbg;
1.801     tempelho 6124:   color: $fontmenu;
1.392     albertel 6125:   border-collapse: collapse;
1.803     bisitz   6126:   padding: 0;
1.819     tempelho 6127:   margin: 0;
1.359     albertel 6128: }
1.795     www      6129: 
1.933     droeschl 6130: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 6131:     margin: 0;
                   6132:     padding: 0;
1.933     droeschl 6133:     position: relative;
                   6134:     list-style: none;
1.913     droeschl 6135: }
1.933     droeschl 6136: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 6137:     display: inline;
                   6138: }
1.933     droeschl 6139: 
                   6140: .LC_breadcrumb_tools_navigation {
1.913     droeschl 6141:     padding: 0;
1.933     droeschl 6142:     margin: 0;
                   6143:     float: left;
1.913     droeschl 6144: }
1.933     droeschl 6145: .LC_breadcrumb_tools_tools {
                   6146:     padding: 0;
                   6147:     margin: 0;
1.913     droeschl 6148:     float: right;
                   6149: }
                   6150: 
1.359     albertel 6151: table#LC_title_bar td {
                   6152:   background: $tabbg;
                   6153: }
1.795     www      6154: 
1.911     bisitz   6155: table#LC_menubuttons img {
1.803     bisitz   6156:   border: none;
1.346     albertel 6157: }
1.795     www      6158: 
1.842     droeschl 6159: .LC_breadcrumbs_component {
1.911     bisitz   6160:   float: right;
                   6161:   margin: 0 1em;
1.357     albertel 6162: }
1.842     droeschl 6163: .LC_breadcrumbs_component img {
1.911     bisitz   6164:   vertical-align: middle;
1.777     tempelho 6165: }
1.795     www      6166: 
1.1075.2.108  raeburn  6167: .LC_breadcrumbs_hoverable {
                   6168:   background: $sidebg;
                   6169: }
                   6170: 
1.383     albertel 6171: td.LC_table_cell_checkbox {
                   6172:   text-align: center;
                   6173: }
1.795     www      6174: 
                   6175: .LC_fontsize_small {
1.911     bisitz   6176:   font-size: 70%;
1.705     tempelho 6177: }
                   6178: 
1.844     bisitz   6179: #LC_breadcrumbs {
1.911     bisitz   6180:   clear:both;
                   6181:   background: $sidebg;
                   6182:   border-bottom: 1px solid $lg_border_color;
                   6183:   line-height: 2.5em;
1.933     droeschl 6184:   overflow: hidden;
1.911     bisitz   6185:   margin: 0;
                   6186:   padding: 0;
1.995     raeburn  6187:   text-align: left;
1.819     tempelho 6188: }
1.862     bisitz   6189: 
1.1075.2.16  raeburn  6190: .LC_head_subbox, .LC_actionbox {
1.911     bisitz   6191:   clear:both;
                   6192:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 6193:   border: 1px solid $sidebg;
1.1075.2.16  raeburn  6194:   margin: 0 0 10px 0;
1.966     bisitz   6195:   padding: 3px;
1.995     raeburn  6196:   text-align: left;
1.822     bisitz   6197: }
                   6198: 
1.795     www      6199: .LC_fontsize_medium {
1.911     bisitz   6200:   font-size: 85%;
1.705     tempelho 6201: }
                   6202: 
1.795     www      6203: .LC_fontsize_large {
1.911     bisitz   6204:   font-size: 120%;
1.705     tempelho 6205: }
                   6206: 
1.346     albertel 6207: .LC_menubuttons_inline_text {
                   6208:   color: $font;
1.698     harmsja  6209:   font-size: 90%;
1.701     harmsja  6210:   padding-left:3px;
1.346     albertel 6211: }
                   6212: 
1.934     droeschl 6213: .LC_menubuttons_inline_text img{
                   6214:   vertical-align: middle;
                   6215: }
                   6216: 
1.1051    www      6217: li.LC_menubuttons_inline_text img {
1.951     onken    6218:   cursor:pointer;
1.1002    droeschl 6219:   text-decoration: none;
1.951     onken    6220: }
                   6221: 
1.526     www      6222: .LC_menubuttons_link {
                   6223:   text-decoration: none;
                   6224: }
1.795     www      6225: 
1.522     albertel 6226: .LC_menubuttons_category {
1.521     www      6227:   color: $font;
1.526     www      6228:   background: $pgbg;
1.521     www      6229:   font-size: larger;
                   6230:   font-weight: bold;
                   6231: }
                   6232: 
1.346     albertel 6233: td.LC_menubuttons_text {
1.911     bisitz   6234:   color: $font;
1.346     albertel 6235: }
1.706     harmsja  6236: 
1.346     albertel 6237: .LC_current_location {
                   6238:   background: $tabbg;
                   6239: }
1.795     www      6240: 
1.1075.2.134  raeburn  6241: td.LC_zero_height {
                   6242:   line-height: 0;
                   6243:   cellpadding: 0;
                   6244: }
                   6245: 
1.938     bisitz   6246: table.LC_data_table {
1.347     albertel 6247:   border: 1px solid #000000;
1.402     albertel 6248:   border-collapse: separate;
1.426     albertel 6249:   border-spacing: 1px;
1.610     albertel 6250:   background: $pgbg;
1.347     albertel 6251: }
1.795     www      6252: 
1.422     albertel 6253: .LC_data_table_dense {
                   6254:   font-size: small;
                   6255: }
1.795     www      6256: 
1.507     raeburn  6257: table.LC_nested_outer {
                   6258:   border: 1px solid #000000;
1.589     raeburn  6259:   border-collapse: collapse;
1.803     bisitz   6260:   border-spacing: 0;
1.507     raeburn  6261:   width: 100%;
                   6262: }
1.795     www      6263: 
1.879     raeburn  6264: table.LC_innerpickbox,
1.507     raeburn  6265: table.LC_nested {
1.803     bisitz   6266:   border: none;
1.589     raeburn  6267:   border-collapse: collapse;
1.803     bisitz   6268:   border-spacing: 0;
1.507     raeburn  6269:   width: 100%;
                   6270: }
1.795     www      6271: 
1.911     bisitz   6272: table.LC_data_table tr th,
                   6273: table.LC_calendar tr th,
1.879     raeburn  6274: table.LC_prior_tries tr th,
                   6275: table.LC_innerpickbox tr th {
1.349     albertel 6276:   font-weight: bold;
                   6277:   background-color: $data_table_head;
1.801     tempelho 6278:   color:$fontmenu;
1.701     harmsja  6279:   font-size:90%;
1.347     albertel 6280: }
1.795     www      6281: 
1.879     raeburn  6282: table.LC_innerpickbox tr th,
                   6283: table.LC_innerpickbox tr td {
                   6284:   vertical-align: top;
                   6285: }
                   6286: 
1.711     raeburn  6287: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   6288:   background-color: #CCCCCC;
1.711     raeburn  6289:   font-weight: bold;
                   6290:   text-align: left;
                   6291: }
1.795     www      6292: 
1.912     bisitz   6293: table.LC_data_table tr.LC_odd_row > td {
                   6294:   background-color: $data_table_light;
                   6295:   padding: 2px;
                   6296:   vertical-align: top;
                   6297: }
                   6298: 
1.809     bisitz   6299: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 6300:   background-color: $data_table_light;
1.912     bisitz   6301:   vertical-align: top;
                   6302: }
                   6303: 
                   6304: table.LC_data_table tr.LC_even_row > td {
                   6305:   background-color: $data_table_dark;
1.425     albertel 6306:   padding: 2px;
1.900     bisitz   6307:   vertical-align: top;
1.347     albertel 6308: }
1.795     www      6309: 
1.809     bisitz   6310: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 6311:   background-color: $data_table_dark;
1.900     bisitz   6312:   vertical-align: top;
1.347     albertel 6313: }
1.795     www      6314: 
1.425     albertel 6315: table.LC_data_table tr.LC_data_table_highlight td {
                   6316:   background-color: $data_table_darker;
                   6317: }
1.795     www      6318: 
1.639     raeburn  6319: table.LC_data_table tr td.LC_leftcol_header {
                   6320:   background-color: $data_table_head;
                   6321:   font-weight: bold;
                   6322: }
1.795     www      6323: 
1.451     albertel 6324: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  6325: table.LC_nested tr.LC_empty_row td {
1.421     albertel 6326:   font-weight: bold;
                   6327:   font-style: italic;
                   6328:   text-align: center;
                   6329:   padding: 8px;
1.347     albertel 6330: }
1.795     www      6331: 
1.1075.2.30  raeburn  6332: table.LC_data_table tr.LC_empty_row td,
                   6333: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   6334:   background-color: $sidebg;
                   6335: }
                   6336: 
                   6337: table.LC_nested tr.LC_empty_row td {
                   6338:   background-color: #FFFFFF;
                   6339: }
                   6340: 
1.890     droeschl 6341: table.LC_caption {
                   6342: }
                   6343: 
1.507     raeburn  6344: table.LC_nested tr.LC_empty_row td {
1.465     albertel 6345:   padding: 4ex
                   6346: }
1.795     www      6347: 
1.507     raeburn  6348: table.LC_nested_outer tr th {
                   6349:   font-weight: bold;
1.801     tempelho 6350:   color:$fontmenu;
1.507     raeburn  6351:   background-color: $data_table_head;
1.701     harmsja  6352:   font-size: small;
1.507     raeburn  6353:   border-bottom: 1px solid #000000;
                   6354: }
1.795     www      6355: 
1.507     raeburn  6356: table.LC_nested_outer tr td.LC_subheader {
                   6357:   background-color: $data_table_head;
                   6358:   font-weight: bold;
                   6359:   font-size: small;
                   6360:   border-bottom: 1px solid #000000;
                   6361:   text-align: right;
1.451     albertel 6362: }
1.795     www      6363: 
1.507     raeburn  6364: table.LC_nested tr.LC_info_row td {
1.735     bisitz   6365:   background-color: #CCCCCC;
1.451     albertel 6366:   font-weight: bold;
                   6367:   font-size: small;
1.507     raeburn  6368:   text-align: center;
                   6369: }
1.795     www      6370: 
1.589     raeburn  6371: table.LC_nested tr.LC_info_row td.LC_left_item,
                   6372: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  6373:   text-align: left;
1.451     albertel 6374: }
1.795     www      6375: 
1.507     raeburn  6376: table.LC_nested td {
1.735     bisitz   6377:   background-color: #FFFFFF;
1.451     albertel 6378:   font-size: small;
1.507     raeburn  6379: }
1.795     www      6380: 
1.507     raeburn  6381: table.LC_nested_outer tr th.LC_right_item,
                   6382: table.LC_nested tr.LC_info_row td.LC_right_item,
                   6383: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   6384: table.LC_nested tr td.LC_right_item {
1.451     albertel 6385:   text-align: right;
                   6386: }
                   6387: 
1.507     raeburn  6388: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   6389:   background-color: #EEEEEE;
1.451     albertel 6390: }
                   6391: 
1.473     raeburn  6392: table.LC_createuser {
                   6393: }
                   6394: 
                   6395: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  6396:   font-size: small;
1.473     raeburn  6397: }
                   6398: 
                   6399: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   6400:   background-color: #CCCCCC;
1.473     raeburn  6401:   font-weight: bold;
                   6402:   text-align: center;
                   6403: }
                   6404: 
1.349     albertel 6405: table.LC_calendar {
                   6406:   border: 1px solid #000000;
                   6407:   border-collapse: collapse;
1.917     raeburn  6408:   width: 98%;
1.349     albertel 6409: }
1.795     www      6410: 
1.349     albertel 6411: table.LC_calendar_pickdate {
                   6412:   font-size: xx-small;
                   6413: }
1.795     www      6414: 
1.349     albertel 6415: table.LC_calendar tr td {
                   6416:   border: 1px solid #000000;
                   6417:   vertical-align: top;
1.917     raeburn  6418:   width: 14%;
1.349     albertel 6419: }
1.795     www      6420: 
1.349     albertel 6421: table.LC_calendar tr td.LC_calendar_day_empty {
                   6422:   background-color: $data_table_dark;
                   6423: }
1.795     www      6424: 
1.779     bisitz   6425: table.LC_calendar tr td.LC_calendar_day_current {
                   6426:   background-color: $data_table_highlight;
1.777     tempelho 6427: }
1.795     www      6428: 
1.938     bisitz   6429: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 6430:   background-color: $mail_new;
                   6431: }
1.795     www      6432: 
1.938     bisitz   6433: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 6434:   background-color: $mail_new_hover;
                   6435: }
1.795     www      6436: 
1.938     bisitz   6437: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 6438:   background-color: $mail_read;
                   6439: }
1.795     www      6440: 
1.938     bisitz   6441: /*
                   6442: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 6443:   background-color: $mail_read_hover;
                   6444: }
1.938     bisitz   6445: */
1.795     www      6446: 
1.938     bisitz   6447: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 6448:   background-color: $mail_replied;
                   6449: }
1.795     www      6450: 
1.938     bisitz   6451: /*
                   6452: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 6453:   background-color: $mail_replied_hover;
                   6454: }
1.938     bisitz   6455: */
1.795     www      6456: 
1.938     bisitz   6457: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 6458:   background-color: $mail_other;
                   6459: }
1.795     www      6460: 
1.938     bisitz   6461: /*
                   6462: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 6463:   background-color: $mail_other_hover;
                   6464: }
1.938     bisitz   6465: */
1.494     raeburn  6466: 
1.777     tempelho 6467: table.LC_data_table tr > td.LC_browser_file,
                   6468: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   6469:   background: #AAEE77;
1.389     albertel 6470: }
1.795     www      6471: 
1.777     tempelho 6472: table.LC_data_table tr > td.LC_browser_file_locked,
                   6473: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 6474:   background: #FFAA99;
1.387     albertel 6475: }
1.795     www      6476: 
1.777     tempelho 6477: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   6478:   background: #888888;
1.779     bisitz   6479: }
1.795     www      6480: 
1.777     tempelho 6481: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   6482: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   6483:   background: #F8F866;
1.777     tempelho 6484: }
1.795     www      6485: 
1.696     bisitz   6486: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   6487:   background: #E0E8FF;
1.387     albertel 6488: }
1.696     bisitz   6489: 
1.707     bisitz   6490: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   6491:   /* background: #77FF77; */
1.707     bisitz   6492: }
1.795     www      6493: 
1.707     bisitz   6494: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   6495:   border-right: 8px solid #FFFF77;
1.707     bisitz   6496: }
1.795     www      6497: 
1.707     bisitz   6498: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   6499:   border-right: 8px solid #FFAA77;
1.707     bisitz   6500: }
1.795     www      6501: 
1.707     bisitz   6502: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   6503:   border-right: 8px solid #FF7777;
1.707     bisitz   6504: }
1.795     www      6505: 
1.707     bisitz   6506: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   6507:   border-right: 8px solid #AAFF77;
1.707     bisitz   6508: }
1.795     www      6509: 
1.707     bisitz   6510: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   6511:   border-right: 8px solid #11CC55;
1.707     bisitz   6512: }
                   6513: 
1.388     albertel 6514: span.LC_current_location {
1.701     harmsja  6515:   font-size:larger;
1.388     albertel 6516:   background: $pgbg;
                   6517: }
1.387     albertel 6518: 
1.1029    www      6519: span.LC_current_nav_location {
                   6520:   font-weight:bold;
                   6521:   background: $sidebg;
                   6522: }
                   6523: 
1.395     albertel 6524: span.LC_parm_menu_item {
                   6525:   font-size: larger;
                   6526: }
1.795     www      6527: 
1.395     albertel 6528: span.LC_parm_scope_all {
                   6529:   color: red;
                   6530: }
1.795     www      6531: 
1.395     albertel 6532: span.LC_parm_scope_folder {
                   6533:   color: green;
                   6534: }
1.795     www      6535: 
1.395     albertel 6536: span.LC_parm_scope_resource {
                   6537:   color: orange;
                   6538: }
1.795     www      6539: 
1.395     albertel 6540: span.LC_parm_part {
                   6541:   color: blue;
                   6542: }
1.795     www      6543: 
1.911     bisitz   6544: span.LC_parm_folder,
                   6545: span.LC_parm_symb {
1.395     albertel 6546:   font-size: x-small;
                   6547:   font-family: $mono;
                   6548:   color: #AAAAAA;
                   6549: }
                   6550: 
1.977     bisitz   6551: ul.LC_parm_parmlist li {
                   6552:   display: inline-block;
                   6553:   padding: 0.3em 0.8em;
                   6554:   vertical-align: top;
                   6555:   width: 150px;
                   6556:   border-top:1px solid $lg_border_color;
                   6557: }
                   6558: 
1.795     www      6559: td.LC_parm_overview_level_menu,
                   6560: td.LC_parm_overview_map_menu,
                   6561: td.LC_parm_overview_parm_selectors,
                   6562: td.LC_parm_overview_restrictions  {
1.396     albertel 6563:   border: 1px solid black;
                   6564:   border-collapse: collapse;
                   6565: }
1.795     www      6566: 
1.396     albertel 6567: table.LC_parm_overview_restrictions td {
                   6568:   border-width: 1px 4px 1px 4px;
                   6569:   border-style: solid;
                   6570:   border-color: $pgbg;
                   6571:   text-align: center;
                   6572: }
1.795     www      6573: 
1.396     albertel 6574: table.LC_parm_overview_restrictions th {
                   6575:   background: $tabbg;
                   6576:   border-width: 1px 4px 1px 4px;
                   6577:   border-style: solid;
                   6578:   border-color: $pgbg;
                   6579: }
1.795     www      6580: 
1.398     albertel 6581: table#LC_helpmenu {
1.803     bisitz   6582:   border: none;
1.398     albertel 6583:   height: 55px;
1.803     bisitz   6584:   border-spacing: 0;
1.398     albertel 6585: }
                   6586: 
                   6587: table#LC_helpmenu fieldset legend {
                   6588:   font-size: larger;
                   6589: }
1.795     www      6590: 
1.397     albertel 6591: table#LC_helpmenu_links {
                   6592:   width: 100%;
                   6593:   border: 1px solid black;
                   6594:   background: $pgbg;
1.803     bisitz   6595:   padding: 0;
1.397     albertel 6596:   border-spacing: 1px;
                   6597: }
1.795     www      6598: 
1.397     albertel 6599: table#LC_helpmenu_links tr td {
                   6600:   padding: 1px;
                   6601:   background: $tabbg;
1.399     albertel 6602:   text-align: center;
                   6603:   font-weight: bold;
1.397     albertel 6604: }
1.396     albertel 6605: 
1.795     www      6606: table#LC_helpmenu_links a:link,
                   6607: table#LC_helpmenu_links a:visited,
1.397     albertel 6608: table#LC_helpmenu_links a:active {
                   6609:   text-decoration: none;
                   6610:   color: $font;
                   6611: }
1.795     www      6612: 
1.397     albertel 6613: table#LC_helpmenu_links a:hover {
                   6614:   text-decoration: underline;
                   6615:   color: $vlink;
                   6616: }
1.396     albertel 6617: 
1.417     albertel 6618: .LC_chrt_popup_exists {
                   6619:   border: 1px solid #339933;
                   6620:   margin: -1px;
                   6621: }
1.795     www      6622: 
1.417     albertel 6623: .LC_chrt_popup_up {
                   6624:   border: 1px solid yellow;
                   6625:   margin: -1px;
                   6626: }
1.795     www      6627: 
1.417     albertel 6628: .LC_chrt_popup {
                   6629:   border: 1px solid #8888FF;
                   6630:   background: #CCCCFF;
                   6631: }
1.795     www      6632: 
1.421     albertel 6633: table.LC_pick_box {
                   6634:   border-collapse: separate;
                   6635:   background: white;
                   6636:   border: 1px solid black;
                   6637:   border-spacing: 1px;
                   6638: }
1.795     www      6639: 
1.421     albertel 6640: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   6641:   background: $sidebg;
1.421     albertel 6642:   font-weight: bold;
1.900     bisitz   6643:   text-align: left;
1.740     bisitz   6644:   vertical-align: top;
1.421     albertel 6645:   width: 184px;
                   6646:   padding: 8px;
                   6647: }
1.795     www      6648: 
1.579     raeburn  6649: table.LC_pick_box td.LC_pick_box_value {
                   6650:   text-align: left;
                   6651:   padding: 8px;
                   6652: }
1.795     www      6653: 
1.579     raeburn  6654: table.LC_pick_box td.LC_pick_box_select {
                   6655:   text-align: left;
                   6656:   padding: 8px;
                   6657: }
1.795     www      6658: 
1.424     albertel 6659: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   6660:   padding: 0;
1.421     albertel 6661:   height: 1px;
                   6662:   background: black;
                   6663: }
1.795     www      6664: 
1.421     albertel 6665: table.LC_pick_box td.LC_pick_box_submit {
                   6666:   text-align: right;
                   6667: }
1.795     www      6668: 
1.579     raeburn  6669: table.LC_pick_box td.LC_evenrow_value {
                   6670:   text-align: left;
                   6671:   padding: 8px;
                   6672:   background-color: $data_table_light;
                   6673: }
1.795     www      6674: 
1.579     raeburn  6675: table.LC_pick_box td.LC_oddrow_value {
                   6676:   text-align: left;
                   6677:   padding: 8px;
                   6678:   background-color: $data_table_light;
                   6679: }
1.795     www      6680: 
1.579     raeburn  6681: span.LC_helpform_receipt_cat {
                   6682:   font-weight: bold;
                   6683: }
1.795     www      6684: 
1.424     albertel 6685: table.LC_group_priv_box {
                   6686:   background: white;
                   6687:   border: 1px solid black;
                   6688:   border-spacing: 1px;
                   6689: }
1.795     www      6690: 
1.424     albertel 6691: table.LC_group_priv_box td.LC_pick_box_title {
                   6692:   background: $tabbg;
                   6693:   font-weight: bold;
                   6694:   text-align: right;
                   6695:   width: 184px;
                   6696: }
1.795     www      6697: 
1.424     albertel 6698: table.LC_group_priv_box td.LC_groups_fixed {
                   6699:   background: $data_table_light;
                   6700:   text-align: center;
                   6701: }
1.795     www      6702: 
1.424     albertel 6703: table.LC_group_priv_box td.LC_groups_optional {
                   6704:   background: $data_table_dark;
                   6705:   text-align: center;
                   6706: }
1.795     www      6707: 
1.424     albertel 6708: table.LC_group_priv_box td.LC_groups_functionality {
                   6709:   background: $data_table_darker;
                   6710:   text-align: center;
                   6711:   font-weight: bold;
                   6712: }
1.795     www      6713: 
1.424     albertel 6714: table.LC_group_priv td {
                   6715:   text-align: left;
1.803     bisitz   6716:   padding: 0;
1.424     albertel 6717: }
                   6718: 
                   6719: .LC_navbuttons {
                   6720:   margin: 2ex 0ex 2ex 0ex;
                   6721: }
1.795     www      6722: 
1.423     albertel 6723: .LC_topic_bar {
                   6724:   font-weight: bold;
                   6725:   background: $tabbg;
1.918     wenzelju 6726:   margin: 1em 0em 1em 2em;
1.805     bisitz   6727:   padding: 3px;
1.918     wenzelju 6728:   font-size: 1.2em;
1.423     albertel 6729: }
1.795     www      6730: 
1.423     albertel 6731: .LC_topic_bar span {
1.918     wenzelju 6732:   left: 0.5em;
                   6733:   position: absolute;
1.423     albertel 6734:   vertical-align: middle;
1.918     wenzelju 6735:   font-size: 1.2em;
1.423     albertel 6736: }
1.795     www      6737: 
1.423     albertel 6738: table.LC_course_group_status {
                   6739:   margin: 20px;
                   6740: }
1.795     www      6741: 
1.423     albertel 6742: table.LC_status_selector td {
                   6743:   vertical-align: top;
                   6744:   text-align: center;
1.424     albertel 6745:   padding: 4px;
                   6746: }
1.795     www      6747: 
1.599     albertel 6748: div.LC_feedback_link {
1.616     albertel 6749:   clear: both;
1.829     kalberla 6750:   background: $sidebg;
1.779     bisitz   6751:   width: 100%;
1.829     kalberla 6752:   padding-bottom: 10px;
                   6753:   border: 1px $tabbg solid;
1.833     kalberla 6754:   height: 22px;
                   6755:   line-height: 22px;
                   6756:   padding-top: 5px;
                   6757: }
                   6758: 
                   6759: div.LC_feedback_link img {
                   6760:   height: 22px;
1.867     kalberla 6761:   vertical-align:middle;
1.829     kalberla 6762: }
                   6763: 
1.911     bisitz   6764: div.LC_feedback_link a {
1.829     kalberla 6765:   text-decoration: none;
1.489     raeburn  6766: }
1.795     www      6767: 
1.867     kalberla 6768: div.LC_comblock {
1.911     bisitz   6769:   display:inline;
1.867     kalberla 6770:   color:$font;
                   6771:   font-size:90%;
                   6772: }
                   6773: 
                   6774: div.LC_feedback_link div.LC_comblock {
                   6775:   padding-left:5px;
                   6776: }
                   6777: 
                   6778: div.LC_feedback_link div.LC_comblock a {
                   6779:   color:$font;
                   6780: }
                   6781: 
1.489     raeburn  6782: span.LC_feedback_link {
1.858     bisitz   6783:   /* background: $feedback_link_bg; */
1.599     albertel 6784:   font-size: larger;
                   6785: }
1.795     www      6786: 
1.599     albertel 6787: span.LC_message_link {
1.858     bisitz   6788:   /* background: $feedback_link_bg; */
1.599     albertel 6789:   font-size: larger;
                   6790:   position: absolute;
                   6791:   right: 1em;
1.489     raeburn  6792: }
1.421     albertel 6793: 
1.515     albertel 6794: table.LC_prior_tries {
1.524     albertel 6795:   border: 1px solid #000000;
                   6796:   border-collapse: separate;
                   6797:   border-spacing: 1px;
1.515     albertel 6798: }
1.523     albertel 6799: 
1.515     albertel 6800: table.LC_prior_tries td {
1.524     albertel 6801:   padding: 2px;
1.515     albertel 6802: }
1.523     albertel 6803: 
                   6804: .LC_answer_correct {
1.795     www      6805:   background: lightgreen;
                   6806:   color: darkgreen;
                   6807:   padding: 6px;
1.523     albertel 6808: }
1.795     www      6809: 
1.523     albertel 6810: .LC_answer_charged_try {
1.797     www      6811:   background: #FFAAAA;
1.795     www      6812:   color: darkred;
                   6813:   padding: 6px;
1.523     albertel 6814: }
1.795     www      6815: 
1.779     bisitz   6816: .LC_answer_not_charged_try,
1.523     albertel 6817: .LC_answer_no_grade,
                   6818: .LC_answer_late {
1.795     www      6819:   background: lightyellow;
1.523     albertel 6820:   color: black;
1.795     www      6821:   padding: 6px;
1.523     albertel 6822: }
1.795     www      6823: 
1.523     albertel 6824: .LC_answer_previous {
1.795     www      6825:   background: lightblue;
                   6826:   color: darkblue;
                   6827:   padding: 6px;
1.523     albertel 6828: }
1.795     www      6829: 
1.779     bisitz   6830: .LC_answer_no_message {
1.777     tempelho 6831:   background: #FFFFFF;
                   6832:   color: black;
1.795     www      6833:   padding: 6px;
1.779     bisitz   6834: }
1.795     www      6835: 
1.1075.2.140  raeburn  6836: .LC_answer_unknown,
                   6837: .LC_answer_warning {
1.779     bisitz   6838:   background: orange;
                   6839:   color: black;
1.795     www      6840:   padding: 6px;
1.777     tempelho 6841: }
1.795     www      6842: 
1.529     albertel 6843: span.LC_prior_numerical,
                   6844: span.LC_prior_string,
                   6845: span.LC_prior_custom,
                   6846: span.LC_prior_reaction,
                   6847: span.LC_prior_math {
1.925     bisitz   6848:   font-family: $mono;
1.523     albertel 6849:   white-space: pre;
                   6850: }
                   6851: 
1.525     albertel 6852: span.LC_prior_string {
1.925     bisitz   6853:   font-family: $mono;
1.525     albertel 6854:   white-space: pre;
                   6855: }
                   6856: 
1.523     albertel 6857: table.LC_prior_option {
                   6858:   width: 100%;
                   6859:   border-collapse: collapse;
                   6860: }
1.795     www      6861: 
1.911     bisitz   6862: table.LC_prior_rank,
1.795     www      6863: table.LC_prior_match {
1.528     albertel 6864:   border-collapse: collapse;
                   6865: }
1.795     www      6866: 
1.528     albertel 6867: table.LC_prior_option tr td,
                   6868: table.LC_prior_rank tr td,
                   6869: table.LC_prior_match tr td {
1.524     albertel 6870:   border: 1px solid #000000;
1.515     albertel 6871: }
                   6872: 
1.855     bisitz   6873: .LC_nobreak {
1.544     albertel 6874:   white-space: nowrap;
1.519     raeburn  6875: }
                   6876: 
1.576     raeburn  6877: span.LC_cusr_emph {
                   6878:   font-style: italic;
                   6879: }
                   6880: 
1.633     raeburn  6881: span.LC_cusr_subheading {
                   6882:   font-weight: normal;
                   6883:   font-size: 85%;
                   6884: }
                   6885: 
1.861     bisitz   6886: div.LC_docs_entry_move {
1.859     bisitz   6887:   border: 1px solid #BBBBBB;
1.545     albertel 6888:   background: #DDDDDD;
1.861     bisitz   6889:   width: 22px;
1.859     bisitz   6890:   padding: 1px;
                   6891:   margin: 0;
1.545     albertel 6892: }
                   6893: 
1.861     bisitz   6894: table.LC_data_table tr > td.LC_docs_entry_commands,
                   6895: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 6896:   font-size: x-small;
                   6897: }
1.795     www      6898: 
1.861     bisitz   6899: .LC_docs_entry_parameter {
                   6900:   white-space: nowrap;
                   6901: }
                   6902: 
1.544     albertel 6903: .LC_docs_copy {
1.545     albertel 6904:   color: #000099;
1.544     albertel 6905: }
1.795     www      6906: 
1.544     albertel 6907: .LC_docs_cut {
1.545     albertel 6908:   color: #550044;
1.544     albertel 6909: }
1.795     www      6910: 
1.544     albertel 6911: .LC_docs_rename {
1.545     albertel 6912:   color: #009900;
1.544     albertel 6913: }
1.795     www      6914: 
1.544     albertel 6915: .LC_docs_remove {
1.545     albertel 6916:   color: #990000;
                   6917: }
                   6918: 
1.1075.2.134  raeburn  6919: .LC_domprefs_email,
1.547     albertel 6920: .LC_docs_reinit_warn,
                   6921: .LC_docs_ext_edit {
                   6922:   font-size: x-small;
                   6923: }
                   6924: 
1.545     albertel 6925: table.LC_docs_adddocs td,
                   6926: table.LC_docs_adddocs th {
                   6927:   border: 1px solid #BBBBBB;
                   6928:   padding: 4px;
                   6929:   background: #DDDDDD;
1.543     albertel 6930: }
                   6931: 
1.584     albertel 6932: table.LC_sty_begin {
                   6933:   background: #BBFFBB;
                   6934: }
1.795     www      6935: 
1.584     albertel 6936: table.LC_sty_end {
                   6937:   background: #FFBBBB;
                   6938: }
                   6939: 
1.589     raeburn  6940: table.LC_double_column {
1.803     bisitz   6941:   border-width: 0;
1.589     raeburn  6942:   border-collapse: collapse;
                   6943:   width: 100%;
                   6944:   padding: 2px;
                   6945: }
                   6946: 
                   6947: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  6948:   top: 2px;
1.589     raeburn  6949:   left: 2px;
                   6950:   width: 47%;
                   6951:   vertical-align: top;
                   6952: }
                   6953: 
                   6954: table.LC_double_column tr td.LC_right_col {
                   6955:   top: 2px;
1.779     bisitz   6956:   right: 2px;
1.589     raeburn  6957:   width: 47%;
                   6958:   vertical-align: top;
                   6959: }
                   6960: 
1.591     raeburn  6961: div.LC_left_float {
                   6962:   float: left;
                   6963:   padding-right: 5%;
1.597     albertel 6964:   padding-bottom: 4px;
1.591     raeburn  6965: }
                   6966: 
                   6967: div.LC_clear_float_header {
1.597     albertel 6968:   padding-bottom: 2px;
1.591     raeburn  6969: }
                   6970: 
                   6971: div.LC_clear_float_footer {
1.597     albertel 6972:   padding-top: 10px;
1.591     raeburn  6973:   clear: both;
                   6974: }
                   6975: 
1.597     albertel 6976: div.LC_grade_show_user {
1.941     bisitz   6977: /*  border-left: 5px solid $sidebg; */
                   6978:   border-top: 5px solid #000000;
                   6979:   margin: 50px 0 0 0;
1.936     bisitz   6980:   padding: 15px 0 5px 10px;
1.597     albertel 6981: }
1.795     www      6982: 
1.936     bisitz   6983: div.LC_grade_show_user_odd_row {
1.941     bisitz   6984: /*  border-left: 5px solid #000000; */
                   6985: }
                   6986: 
                   6987: div.LC_grade_show_user div.LC_Box {
                   6988:   margin-right: 50px;
1.597     albertel 6989: }
                   6990: 
                   6991: div.LC_grade_submissions,
                   6992: div.LC_grade_message_center,
1.936     bisitz   6993: div.LC_grade_info_links {
1.597     albertel 6994:   margin: 5px;
                   6995:   width: 99%;
                   6996:   background: #FFFFFF;
                   6997: }
1.795     www      6998: 
1.597     albertel 6999: div.LC_grade_submissions_header,
1.936     bisitz   7000: div.LC_grade_message_center_header {
1.705     tempelho 7001:   font-weight: bold;
                   7002:   font-size: large;
1.597     albertel 7003: }
1.795     www      7004: 
1.597     albertel 7005: div.LC_grade_submissions_body,
1.936     bisitz   7006: div.LC_grade_message_center_body {
1.597     albertel 7007:   border: 1px solid black;
                   7008:   width: 99%;
                   7009:   background: #FFFFFF;
                   7010: }
1.795     www      7011: 
1.613     albertel 7012: table.LC_scantron_action {
                   7013:   width: 100%;
                   7014: }
1.795     www      7015: 
1.613     albertel 7016: table.LC_scantron_action tr th {
1.698     harmsja  7017:   font-weight:bold;
                   7018:   font-style:normal;
1.613     albertel 7019: }
1.795     www      7020: 
1.779     bisitz   7021: .LC_edit_problem_header,
1.614     albertel 7022: div.LC_edit_problem_footer {
1.705     tempelho 7023:   font-weight: normal;
                   7024:   font-size:  medium;
1.602     albertel 7025:   margin: 2px;
1.1060    bisitz   7026:   background-color: $sidebg;
1.600     albertel 7027: }
1.795     www      7028: 
1.600     albertel 7029: div.LC_edit_problem_header,
1.602     albertel 7030: div.LC_edit_problem_header div,
1.614     albertel 7031: div.LC_edit_problem_footer,
                   7032: div.LC_edit_problem_footer div,
1.602     albertel 7033: div.LC_edit_problem_editxml_header,
                   7034: div.LC_edit_problem_editxml_header div {
1.1075.2.112  raeburn  7035:   z-index: 100;
1.600     albertel 7036: }
1.795     www      7037: 
1.600     albertel 7038: div.LC_edit_problem_header_title {
1.705     tempelho 7039:   font-weight: bold;
                   7040:   font-size: larger;
1.602     albertel 7041:   background: $tabbg;
                   7042:   padding: 3px;
1.1060    bisitz   7043:   margin: 0 0 5px 0;
1.602     albertel 7044: }
1.795     www      7045: 
1.602     albertel 7046: table.LC_edit_problem_header_title {
                   7047:   width: 100%;
1.600     albertel 7048:   background: $tabbg;
1.602     albertel 7049: }
                   7050: 
1.1075.2.112  raeburn  7051: div.LC_edit_actionbar {
                   7052:     background-color: $sidebg;
                   7053:     margin: 0;
                   7054:     padding: 0;
                   7055:     line-height: 200%;
1.602     albertel 7056: }
1.795     www      7057: 
1.1075.2.112  raeburn  7058: div.LC_edit_actionbar div{
                   7059:     padding: 0;
                   7060:     margin: 0;
                   7061:     display: inline-block;
1.600     albertel 7062: }
1.795     www      7063: 
1.1075.2.34  raeburn  7064: .LC_edit_opt {
                   7065:   padding-left: 1em;
                   7066:   white-space: nowrap;
                   7067: }
                   7068: 
1.1075.2.57  raeburn  7069: .LC_edit_problem_latexhelper{
                   7070:     text-align: right;
                   7071: }
                   7072: 
                   7073: #LC_edit_problem_colorful div{
                   7074:     margin-left: 40px;
                   7075: }
                   7076: 
1.1075.2.112  raeburn  7077: #LC_edit_problem_codemirror div{
                   7078:     margin-left: 0px;
                   7079: }
                   7080: 
1.911     bisitz   7081: img.stift {
1.803     bisitz   7082:   border-width: 0;
                   7083:   vertical-align: middle;
1.677     riegler  7084: }
1.680     riegler  7085: 
1.923     bisitz   7086: table td.LC_mainmenu_col_fieldset {
1.680     riegler  7087:   vertical-align: top;
1.777     tempelho 7088: }
1.795     www      7089: 
1.716     raeburn  7090: div.LC_createcourse {
1.911     bisitz   7091:   margin: 10px 10px 10px 10px;
1.716     raeburn  7092: }
                   7093: 
1.917     raeburn  7094: .LC_dccid {
1.1075.2.38  raeburn  7095:   float: right;
1.917     raeburn  7096:   margin: 0.2em 0 0 0;
                   7097:   padding: 0;
                   7098:   font-size: 90%;
                   7099:   display:none;
                   7100: }
                   7101: 
1.897     wenzelju 7102: ol.LC_primary_menu a:hover,
1.721     harmsja  7103: ol#LC_MenuBreadcrumbs a:hover,
                   7104: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 7105: ul#LC_secondary_menu a:hover,
1.721     harmsja  7106: .LC_FormSectionClearButton input:hover
1.795     www      7107: ul.LC_TabContent   li:hover a {
1.952     onken    7108:   color:$button_hover;
1.911     bisitz   7109:   text-decoration:none;
1.693     droeschl 7110: }
                   7111: 
1.779     bisitz   7112: h1 {
1.911     bisitz   7113:   padding: 0;
                   7114:   line-height:130%;
1.693     droeschl 7115: }
1.698     harmsja  7116: 
1.911     bisitz   7117: h2,
                   7118: h3,
                   7119: h4,
                   7120: h5,
                   7121: h6 {
                   7122:   margin: 5px 0 5px 0;
                   7123:   padding: 0;
                   7124:   line-height:130%;
1.693     droeschl 7125: }
1.795     www      7126: 
                   7127: .LC_hcell {
1.911     bisitz   7128:   padding:3px 15px 3px 15px;
                   7129:   margin: 0;
                   7130:   background-color:$tabbg;
                   7131:   color:$fontmenu;
                   7132:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 7133: }
1.795     www      7134: 
1.840     bisitz   7135: .LC_Box > .LC_hcell {
1.911     bisitz   7136:   margin: 0 -10px 10px -10px;
1.835     bisitz   7137: }
                   7138: 
1.721     harmsja  7139: .LC_noBorder {
1.911     bisitz   7140:   border: 0;
1.698     harmsja  7141: }
1.693     droeschl 7142: 
1.721     harmsja  7143: .LC_FormSectionClearButton input {
1.911     bisitz   7144:   background-color:transparent;
                   7145:   border: none;
                   7146:   cursor:pointer;
                   7147:   text-decoration:underline;
1.693     droeschl 7148: }
1.763     bisitz   7149: 
                   7150: .LC_help_open_topic {
1.911     bisitz   7151:   color: #FFFFFF;
                   7152:   background-color: #EEEEFF;
                   7153:   margin: 1px;
                   7154:   padding: 4px;
                   7155:   border: 1px solid #000033;
                   7156:   white-space: nowrap;
                   7157:   /* vertical-align: middle; */
1.759     neumanie 7158: }
1.693     droeschl 7159: 
1.911     bisitz   7160: dl,
                   7161: ul,
                   7162: div,
                   7163: fieldset {
                   7164:   margin: 10px 10px 10px 0;
                   7165:   /* overflow: hidden; */
1.693     droeschl 7166: }
1.795     www      7167: 
1.1075.2.90  raeburn  7168: article.geogebraweb div {
                   7169:     margin: 0;
                   7170: }
                   7171: 
1.838     bisitz   7172: fieldset > legend {
1.911     bisitz   7173:   font-weight: bold;
                   7174:   padding: 0 5px 0 5px;
1.838     bisitz   7175: }
                   7176: 
1.813     bisitz   7177: #LC_nav_bar {
1.911     bisitz   7178:   float: left;
1.995     raeburn  7179:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   7180:   margin: 0 0 2px 0;
1.807     droeschl 7181: }
                   7182: 
1.916     droeschl 7183: #LC_realm {
                   7184:   margin: 0.2em 0 0 0;
                   7185:   padding: 0;
                   7186:   font-weight: bold;
                   7187:   text-align: center;
1.995     raeburn  7188:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 7189: }
                   7190: 
1.911     bisitz   7191: #LC_nav_bar em {
                   7192:   font-weight: bold;
                   7193:   font-style: normal;
1.807     droeschl 7194: }
                   7195: 
1.897     wenzelju 7196: ol.LC_primary_menu {
1.934     droeschl 7197:   margin: 0;
1.1075.2.2  raeburn  7198:   padding: 0;
1.807     droeschl 7199: }
                   7200: 
1.852     droeschl 7201: ol#LC_PathBreadcrumbs {
1.911     bisitz   7202:   margin: 0;
1.693     droeschl 7203: }
                   7204: 
1.897     wenzelju 7205: ol.LC_primary_menu li {
1.1075.2.2  raeburn  7206:   color: RGB(80, 80, 80);
                   7207:   vertical-align: middle;
                   7208:   text-align: left;
                   7209:   list-style: none;
1.1075.2.112  raeburn  7210:   position: relative;
1.1075.2.2  raeburn  7211:   float: left;
1.1075.2.112  raeburn  7212:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   7213:   line-height: 1.5em;
1.1075.2.2  raeburn  7214: }
                   7215: 
1.1075.2.113  raeburn  7216: ol.LC_primary_menu li a, 
1.1075.2.112  raeburn  7217: ol.LC_primary_menu li p {
1.1075.2.2  raeburn  7218:   display: block;
                   7219:   margin: 0;
                   7220:   padding: 0 5px 0 10px;
                   7221:   text-decoration: none;
                   7222: }
                   7223: 
1.1075.2.112  raeburn  7224: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   7225:   display: inline-block;
                   7226:   width: 95%;
                   7227:   text-align: left;
                   7228: }
                   7229: 
                   7230: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   7231:   display: inline-block;
                   7232:   width: 5%;
                   7233:   float: right;
                   7234:   text-align: right;
                   7235:   font-size: 70%;
                   7236: }
                   7237: 
                   7238: ol.LC_primary_menu ul {
1.1075.2.2  raeburn  7239:   display: none;
1.1075.2.112  raeburn  7240:   width: 15em;
1.1075.2.2  raeburn  7241:   background-color: $data_table_light;
1.1075.2.112  raeburn  7242:   position: absolute;
                   7243:   top: 100%;
                   7244: }
                   7245: 
                   7246: ol.LC_primary_menu ul ul {
                   7247:   left: 100%;
                   7248:   top: 0;
1.1075.2.2  raeburn  7249: }
                   7250: 
1.1075.2.112  raeburn  7251: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1075.2.2  raeburn  7252:   display: block;
                   7253:   position: absolute;
                   7254:   margin: 0;
                   7255:   padding: 0;
1.1075.2.5  raeburn  7256:   z-index: 2;
1.1075.2.2  raeburn  7257: }
                   7258: 
                   7259: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1075.2.112  raeburn  7260: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1075.2.2  raeburn  7261:   font-size: 90%;
1.911     bisitz   7262:   vertical-align: top;
1.1075.2.2  raeburn  7263:   float: none;
1.1075.2.5  raeburn  7264:   border-left: 1px solid black;
                   7265:   border-right: 1px solid black;
1.1075.2.112  raeburn  7266: /* A dark bottom border to visualize different menu options;
                   7267: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   7268:   border-bottom: 1px solid $data_table_dark;
1.1075.2.2  raeburn  7269: }
                   7270: 
1.1075.2.112  raeburn  7271: ol.LC_primary_menu li li p:hover {
                   7272:   color:$button_hover;
                   7273:   text-decoration:none;
                   7274:   background-color:$data_table_dark;
1.1075.2.2  raeburn  7275: }
                   7276: 
                   7277: ol.LC_primary_menu li li a:hover {
                   7278:    color:$button_hover;
                   7279:    background-color:$data_table_dark;
1.693     droeschl 7280: }
                   7281: 
1.1075.2.112  raeburn  7282: /* Font-size equal to the size of the predecessors*/
                   7283: ol.LC_primary_menu li:hover li li {
                   7284:   font-size: 100%;
                   7285: }
                   7286: 
1.897     wenzelju 7287: ol.LC_primary_menu li img {
1.911     bisitz   7288:   vertical-align: bottom;
1.934     droeschl 7289:   height: 1.1em;
1.1075.2.3  raeburn  7290:   margin: 0.2em 0 0 0;
1.693     droeschl 7291: }
                   7292: 
1.897     wenzelju 7293: ol.LC_primary_menu a {
1.911     bisitz   7294:   color: RGB(80, 80, 80);
                   7295:   text-decoration: none;
1.693     droeschl 7296: }
1.795     www      7297: 
1.949     droeschl 7298: ol.LC_primary_menu a.LC_new_message {
                   7299:   font-weight:bold;
                   7300:   color: darkred;
                   7301: }
                   7302: 
1.975     raeburn  7303: ol.LC_docs_parameters {
                   7304:   margin-left: 0;
                   7305:   padding: 0;
                   7306:   list-style: none;
                   7307: }
                   7308: 
                   7309: ol.LC_docs_parameters li {
                   7310:   margin: 0;
                   7311:   padding-right: 20px;
                   7312:   display: inline;
                   7313: }
                   7314: 
1.976     raeburn  7315: ol.LC_docs_parameters li:before {
                   7316:   content: "\\002022 \\0020";
                   7317: }
                   7318: 
                   7319: li.LC_docs_parameters_title {
                   7320:   font-weight: bold;
                   7321: }
                   7322: 
                   7323: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   7324:   content: "";
                   7325: }
                   7326: 
1.897     wenzelju 7327: ul#LC_secondary_menu {
1.1075.2.23  raeburn  7328:   clear: right;
1.911     bisitz   7329:   color: $fontmenu;
                   7330:   background: $tabbg;
                   7331:   list-style: none;
                   7332:   padding: 0;
                   7333:   margin: 0;
                   7334:   width: 100%;
1.995     raeburn  7335:   text-align: left;
1.1075.2.4  raeburn  7336:   float: left;
1.808     droeschl 7337: }
                   7338: 
1.897     wenzelju 7339: ul#LC_secondary_menu li {
1.911     bisitz   7340:   font-weight: bold;
                   7341:   line-height: 1.8em;
                   7342:   border-right: 1px solid black;
1.1075.2.4  raeburn  7343:   float: left;
                   7344: }
                   7345: 
                   7346: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   7347:   background-color: $data_table_light;
                   7348: }
                   7349: 
                   7350: ul#LC_secondary_menu li a {
                   7351:   padding: 0 0.8em;
                   7352: }
                   7353: 
                   7354: ul#LC_secondary_menu li ul {
                   7355:   display: none;
                   7356: }
                   7357: 
                   7358: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   7359:   display: block;
                   7360:   position: absolute;
                   7361:   margin: 0;
                   7362:   padding: 0;
                   7363:   list-style:none;
                   7364:   float: none;
                   7365:   background-color: $data_table_light;
1.1075.2.5  raeburn  7366:   z-index: 2;
1.1075.2.10  raeburn  7367:   margin-left: -1px;
1.1075.2.4  raeburn  7368: }
                   7369: 
                   7370: ul#LC_secondary_menu li ul li {
                   7371:   font-size: 90%;
                   7372:   vertical-align: top;
                   7373:   border-left: 1px solid black;
                   7374:   border-right: 1px solid black;
1.1075.2.33  raeburn  7375:   background-color: $data_table_light;
1.1075.2.4  raeburn  7376:   list-style:none;
                   7377:   float: none;
                   7378: }
                   7379: 
                   7380: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   7381:   background-color: $data_table_dark;
1.807     droeschl 7382: }
                   7383: 
1.847     tempelho 7384: ul.LC_TabContent {
1.911     bisitz   7385:   display:block;
                   7386:   background: $sidebg;
                   7387:   border-bottom: solid 1px $lg_border_color;
                   7388:   list-style:none;
1.1020    raeburn  7389:   margin: -1px -10px 0 -10px;
1.911     bisitz   7390:   padding: 0;
1.693     droeschl 7391: }
                   7392: 
1.795     www      7393: ul.LC_TabContent li,
                   7394: ul.LC_TabContentBigger li {
1.911     bisitz   7395:   float:left;
1.741     harmsja  7396: }
1.795     www      7397: 
1.897     wenzelju 7398: ul#LC_secondary_menu li a {
1.911     bisitz   7399:   color: $fontmenu;
                   7400:   text-decoration: none;
1.693     droeschl 7401: }
1.795     www      7402: 
1.721     harmsja  7403: ul.LC_TabContent {
1.952     onken    7404:   min-height:20px;
1.721     harmsja  7405: }
1.795     www      7406: 
                   7407: ul.LC_TabContent li {
1.911     bisitz   7408:   vertical-align:middle;
1.959     onken    7409:   padding: 0 16px 0 10px;
1.911     bisitz   7410:   background-color:$tabbg;
                   7411:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  7412:   border-left: solid 1px $font;
1.721     harmsja  7413: }
1.795     www      7414: 
1.847     tempelho 7415: ul.LC_TabContent .right {
1.911     bisitz   7416:   float:right;
1.847     tempelho 7417: }
                   7418: 
1.911     bisitz   7419: ul.LC_TabContent li a,
                   7420: ul.LC_TabContent li {
                   7421:   color:rgb(47,47,47);
                   7422:   text-decoration:none;
                   7423:   font-size:95%;
                   7424:   font-weight:bold;
1.952     onken    7425:   min-height:20px;
                   7426: }
                   7427: 
1.959     onken    7428: ul.LC_TabContent li a:hover,
                   7429: ul.LC_TabContent li a:focus {
1.952     onken    7430:   color: $button_hover;
1.959     onken    7431:   background:none;
                   7432:   outline:none;
1.952     onken    7433: }
                   7434: 
                   7435: ul.LC_TabContent li:hover {
                   7436:   color: $button_hover;
                   7437:   cursor:pointer;
1.721     harmsja  7438: }
1.795     www      7439: 
1.911     bisitz   7440: ul.LC_TabContent li.active {
1.952     onken    7441:   color: $font;
1.911     bisitz   7442:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    7443:   border-bottom:solid 1px #FFFFFF;
                   7444:   cursor: default;
1.744     ehlerst  7445: }
1.795     www      7446: 
1.959     onken    7447: ul.LC_TabContent li.active a {
                   7448:   color:$font;
                   7449:   background:#FFFFFF;
                   7450:   outline: none;
                   7451: }
1.1047    raeburn  7452: 
                   7453: ul.LC_TabContent li.goback {
                   7454:   float: left;
                   7455:   border-left: none;
                   7456: }
                   7457: 
1.870     tempelho 7458: #maincoursedoc {
1.911     bisitz   7459:   clear:both;
1.870     tempelho 7460: }
                   7461: 
                   7462: ul.LC_TabContentBigger {
1.911     bisitz   7463:   display:block;
                   7464:   list-style:none;
                   7465:   padding: 0;
1.870     tempelho 7466: }
                   7467: 
1.795     www      7468: ul.LC_TabContentBigger li {
1.911     bisitz   7469:   vertical-align:bottom;
                   7470:   height: 30px;
                   7471:   font-size:110%;
                   7472:   font-weight:bold;
                   7473:   color: #737373;
1.841     tempelho 7474: }
                   7475: 
1.957     onken    7476: ul.LC_TabContentBigger li.active {
                   7477:   position: relative;
                   7478:   top: 1px;
                   7479: }
                   7480: 
1.870     tempelho 7481: ul.LC_TabContentBigger li a {
1.911     bisitz   7482:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   7483:   height: 30px;
                   7484:   line-height: 30px;
                   7485:   text-align: center;
                   7486:   display: block;
                   7487:   text-decoration: none;
1.958     onken    7488:   outline: none;  
1.741     harmsja  7489: }
1.795     www      7490: 
1.870     tempelho 7491: ul.LC_TabContentBigger li.active a {
1.911     bisitz   7492:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   7493:   color:$font;
1.744     ehlerst  7494: }
1.795     www      7495: 
1.870     tempelho 7496: ul.LC_TabContentBigger li b {
1.911     bisitz   7497:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   7498:   display: block;
                   7499:   float: left;
                   7500:   padding: 0 30px;
1.957     onken    7501:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 7502: }
                   7503: 
1.956     onken    7504: ul.LC_TabContentBigger li:hover b {
                   7505:   color:$button_hover;
                   7506: }
                   7507: 
1.870     tempelho 7508: ul.LC_TabContentBigger li.active b {
1.911     bisitz   7509:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   7510:   color:$font;
1.957     onken    7511:   border: 0;
1.741     harmsja  7512: }
1.693     droeschl 7513: 
1.870     tempelho 7514: 
1.862     bisitz   7515: ul.LC_CourseBreadcrumbs {
                   7516:   background: $sidebg;
1.1020    raeburn  7517:   height: 2em;
1.862     bisitz   7518:   padding-left: 10px;
1.1020    raeburn  7519:   margin: 0;
1.862     bisitz   7520:   list-style-position: inside;
                   7521: }
                   7522: 
1.911     bisitz   7523: ol#LC_MenuBreadcrumbs,
1.862     bisitz   7524: ol#LC_PathBreadcrumbs {
1.911     bisitz   7525:   padding-left: 10px;
                   7526:   margin: 0;
1.933     droeschl 7527:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 7528: }
                   7529: 
1.911     bisitz   7530: ol#LC_MenuBreadcrumbs li,
                   7531: ol#LC_PathBreadcrumbs li,
1.862     bisitz   7532: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   7533:   display: inline;
1.933     droeschl 7534:   white-space: normal;  
1.693     droeschl 7535: }
                   7536: 
1.823     bisitz   7537: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   7538: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   7539:   text-decoration: none;
                   7540:   font-size:90%;
1.693     droeschl 7541: }
1.795     www      7542: 
1.969     droeschl 7543: ol#LC_MenuBreadcrumbs h1 {
                   7544:   display: inline;
                   7545:   font-size: 90%;
                   7546:   line-height: 2.5em;
                   7547:   margin: 0;
                   7548:   padding: 0;
                   7549: }
                   7550: 
1.795     www      7551: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   7552:   text-decoration:none;
                   7553:   font-size:100%;
                   7554:   font-weight:bold;
1.693     droeschl 7555: }
1.795     www      7556: 
1.840     bisitz   7557: .LC_Box {
1.911     bisitz   7558:   border: solid 1px $lg_border_color;
                   7559:   padding: 0 10px 10px 10px;
1.746     neumanie 7560: }
1.795     www      7561: 
1.1020    raeburn  7562: .LC_DocsBox {
                   7563:   border: solid 1px $lg_border_color;
                   7564:   padding: 0 0 10px 10px;
                   7565: }
                   7566: 
1.795     www      7567: .LC_AboutMe_Image {
1.911     bisitz   7568:   float:left;
                   7569:   margin-right:10px;
1.747     neumanie 7570: }
1.795     www      7571: 
                   7572: .LC_Clear_AboutMe_Image {
1.911     bisitz   7573:   clear:left;
1.747     neumanie 7574: }
1.795     www      7575: 
1.721     harmsja  7576: dl.LC_ListStyleClean dt {
1.911     bisitz   7577:   padding-right: 5px;
                   7578:   display: table-header-group;
1.693     droeschl 7579: }
                   7580: 
1.721     harmsja  7581: dl.LC_ListStyleClean dd {
1.911     bisitz   7582:   display: table-row;
1.693     droeschl 7583: }
                   7584: 
1.721     harmsja  7585: .LC_ListStyleClean,
                   7586: .LC_ListStyleSimple,
                   7587: .LC_ListStyleNormal,
1.795     www      7588: .LC_ListStyleSpecial {
1.911     bisitz   7589:   /* display:block; */
                   7590:   list-style-position: inside;
                   7591:   list-style-type: none;
                   7592:   overflow: hidden;
                   7593:   padding: 0;
1.693     droeschl 7594: }
                   7595: 
1.721     harmsja  7596: .LC_ListStyleSimple li,
                   7597: .LC_ListStyleSimple dd,
                   7598: .LC_ListStyleNormal li,
                   7599: .LC_ListStyleNormal dd,
                   7600: .LC_ListStyleSpecial li,
1.795     www      7601: .LC_ListStyleSpecial dd {
1.911     bisitz   7602:   margin: 0;
                   7603:   padding: 5px 5px 5px 10px;
                   7604:   clear: both;
1.693     droeschl 7605: }
                   7606: 
1.721     harmsja  7607: .LC_ListStyleClean li,
                   7608: .LC_ListStyleClean dd {
1.911     bisitz   7609:   padding-top: 0;
                   7610:   padding-bottom: 0;
1.693     droeschl 7611: }
                   7612: 
1.721     harmsja  7613: .LC_ListStyleSimple dd,
1.795     www      7614: .LC_ListStyleSimple li {
1.911     bisitz   7615:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 7616: }
                   7617: 
1.721     harmsja  7618: .LC_ListStyleSpecial li,
                   7619: .LC_ListStyleSpecial dd {
1.911     bisitz   7620:   list-style-type: none;
                   7621:   background-color: RGB(220, 220, 220);
                   7622:   margin-bottom: 4px;
1.693     droeschl 7623: }
                   7624: 
1.721     harmsja  7625: table.LC_SimpleTable {
1.911     bisitz   7626:   margin:5px;
                   7627:   border:solid 1px $lg_border_color;
1.795     www      7628: }
1.693     droeschl 7629: 
1.721     harmsja  7630: table.LC_SimpleTable tr {
1.911     bisitz   7631:   padding: 0;
                   7632:   border:solid 1px $lg_border_color;
1.693     droeschl 7633: }
1.795     www      7634: 
                   7635: table.LC_SimpleTable thead {
1.911     bisitz   7636:   background:rgb(220,220,220);
1.693     droeschl 7637: }
                   7638: 
1.721     harmsja  7639: div.LC_columnSection {
1.911     bisitz   7640:   display: block;
                   7641:   clear: both;
                   7642:   overflow: hidden;
                   7643:   margin: 0;
1.693     droeschl 7644: }
                   7645: 
1.721     harmsja  7646: div.LC_columnSection>* {
1.911     bisitz   7647:   float: left;
                   7648:   margin: 10px 20px 10px 0;
                   7649:   overflow:hidden;
1.693     droeschl 7650: }
1.721     harmsja  7651: 
1.795     www      7652: table em {
1.911     bisitz   7653:   font-weight: bold;
                   7654:   font-style: normal;
1.748     schulted 7655: }
1.795     www      7656: 
1.779     bisitz   7657: table.LC_tableBrowseRes,
1.795     www      7658: table.LC_tableOfContent {
1.911     bisitz   7659:   border:none;
                   7660:   border-spacing: 1px;
                   7661:   padding: 3px;
                   7662:   background-color: #FFFFFF;
                   7663:   font-size: 90%;
1.753     droeschl 7664: }
1.789     droeschl 7665: 
1.911     bisitz   7666: table.LC_tableOfContent {
                   7667:   border-collapse: collapse;
1.789     droeschl 7668: }
                   7669: 
1.771     droeschl 7670: table.LC_tableBrowseRes a,
1.768     schulted 7671: table.LC_tableOfContent a {
1.911     bisitz   7672:   background-color: transparent;
                   7673:   text-decoration: none;
1.753     droeschl 7674: }
                   7675: 
1.795     www      7676: table.LC_tableOfContent img {
1.911     bisitz   7677:   border: none;
                   7678:   height: 1.3em;
                   7679:   vertical-align: text-bottom;
                   7680:   margin-right: 0.3em;
1.753     droeschl 7681: }
1.757     schulted 7682: 
1.795     www      7683: a#LC_content_toolbar_firsthomework {
1.911     bisitz   7684:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  7685: }
                   7686: 
1.795     www      7687: a#LC_content_toolbar_everything {
1.911     bisitz   7688:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  7689: }
                   7690: 
1.795     www      7691: a#LC_content_toolbar_uncompleted {
1.911     bisitz   7692:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  7693: }
                   7694: 
1.795     www      7695: #LC_content_toolbar_clearbubbles {
1.911     bisitz   7696:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  7697: }
                   7698: 
1.795     www      7699: a#LC_content_toolbar_changefolder {
1.911     bisitz   7700:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 7701: }
                   7702: 
1.795     www      7703: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   7704:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 7705: }
                   7706: 
1.1043    raeburn  7707: a#LC_content_toolbar_edittoplevel {
                   7708:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   7709: }
                   7710: 
1.795     www      7711: ul#LC_toolbar li a:hover {
1.911     bisitz   7712:   background-position: bottom center;
1.757     schulted 7713: }
                   7714: 
1.795     www      7715: ul#LC_toolbar {
1.911     bisitz   7716:   padding: 0;
                   7717:   margin: 2px;
                   7718:   list-style:none;
                   7719:   position:relative;
                   7720:   background-color:white;
1.1075.2.9  raeburn  7721:   overflow: auto;
1.757     schulted 7722: }
                   7723: 
1.795     www      7724: ul#LC_toolbar li {
1.911     bisitz   7725:   border:1px solid white;
                   7726:   padding: 0;
                   7727:   margin: 0;
                   7728:   float: left;
                   7729:   display:inline;
                   7730:   vertical-align:middle;
1.1075.2.9  raeburn  7731:   white-space: nowrap;
1.911     bisitz   7732: }
1.757     schulted 7733: 
1.783     amueller 7734: 
1.795     www      7735: a.LC_toolbarItem {
1.911     bisitz   7736:   display:block;
                   7737:   padding: 0;
                   7738:   margin: 0;
                   7739:   height: 32px;
                   7740:   width: 32px;
                   7741:   color:white;
                   7742:   border: none;
                   7743:   background-repeat:no-repeat;
                   7744:   background-color:transparent;
1.757     schulted 7745: }
                   7746: 
1.915     droeschl 7747: ul.LC_funclist {
                   7748:     margin: 0;
                   7749:     padding: 0.5em 1em 0.5em 0;
                   7750: }
                   7751: 
1.933     droeschl 7752: ul.LC_funclist > li:first-child {
                   7753:     font-weight:bold; 
                   7754:     margin-left:0.8em;
                   7755: }
                   7756: 
1.915     droeschl 7757: ul.LC_funclist + ul.LC_funclist {
                   7758:     /* 
                   7759:        left border as a seperator if we have more than
                   7760:        one list 
                   7761:     */
                   7762:     border-left: 1px solid $sidebg;
                   7763:     /* 
                   7764:        this hides the left border behind the border of the 
                   7765:        outer box if element is wrapped to the next 'line' 
                   7766:     */
                   7767:     margin-left: -1px;
                   7768: }
                   7769: 
1.843     bisitz   7770: ul.LC_funclist li {
1.915     droeschl 7771:   display: inline;
1.782     bisitz   7772:   white-space: nowrap;
1.915     droeschl 7773:   margin: 0 0 0 25px;
                   7774:   line-height: 150%;
1.782     bisitz   7775: }
                   7776: 
1.974     wenzelju 7777: .LC_hidden {
                   7778:   display: none;
                   7779: }
                   7780: 
1.1030    www      7781: .LCmodal-overlay {
                   7782: 		position:fixed;
                   7783: 		top:0;
                   7784: 		right:0;
                   7785: 		bottom:0;
                   7786: 		left:0;
                   7787: 		height:100%;
                   7788: 		width:100%;
                   7789: 		margin:0;
                   7790: 		padding:0;
                   7791: 		background:#999;
                   7792: 		opacity:.75;
                   7793: 		filter: alpha(opacity=75);
                   7794: 		-moz-opacity: 0.75;
                   7795: 		z-index:101;
                   7796: }
                   7797: 
                   7798: * html .LCmodal-overlay {   
                   7799: 		position: absolute;
                   7800: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   7801: }
                   7802: 
                   7803: .LCmodal-window {
                   7804: 		position:fixed;
                   7805: 		top:50%;
                   7806: 		left:50%;
                   7807: 		margin:0;
                   7808: 		padding:0;
                   7809: 		z-index:102;
                   7810: 	}
                   7811: 
                   7812: * html .LCmodal-window {
                   7813: 		position:absolute;
                   7814: }
                   7815: 
                   7816: .LCclose-window {
                   7817: 		position:absolute;
                   7818: 		width:32px;
                   7819: 		height:32px;
                   7820: 		right:8px;
                   7821: 		top:8px;
                   7822: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   7823: 		text-indent:-99999px;
                   7824: 		overflow:hidden;
                   7825: 		cursor:pointer;
                   7826: }
                   7827: 
1.1075.2.141  raeburn  7828: pre.LC_wordwrap {
                   7829:   white-space: pre-wrap;
                   7830:   white-space: -moz-pre-wrap;
                   7831:   white-space: -pre-wrap;
                   7832:   white-space: -o-pre-wrap;
                   7833:   word-wrap: break-word;
                   7834: }
                   7835: 
1.1075.2.17  raeburn  7836: /*
                   7837:   styles used by TTH when "Default set of options to pass to tth/m
                   7838:   when converting TeX" in course settings has been set
                   7839: 
                   7840:   option passed: -t
                   7841: 
                   7842: */
                   7843: 
                   7844: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   7845: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   7846: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   7847: td div.norm {line-height:normal;}
                   7848: 
                   7849: /*
                   7850:   option passed -y3
                   7851: */
                   7852: 
                   7853: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   7854: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   7855: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   7856: 
1.1075.2.121  raeburn  7857: #LC_minitab_header {
                   7858:   float:left;
                   7859:   width:100%;
                   7860:   background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
                   7861:   font-size:93%;
                   7862:   line-height:normal;
                   7863:   margin: 0.5em 0 0.5em 0;
                   7864: }
                   7865: #LC_minitab_header ul {
                   7866:   margin:0;
                   7867:   padding:10px 10px 0;
                   7868:   list-style:none;
                   7869: }
                   7870: #LC_minitab_header li {
                   7871:   float:left;
                   7872:   background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
                   7873:   margin:0;
                   7874:   padding:0 0 0 9px;
                   7875: }
                   7876: #LC_minitab_header a {
                   7877:   display:block;
                   7878:   background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
                   7879:   padding:5px 15px 4px 6px;
                   7880: }
                   7881: #LC_minitab_header #LC_current_minitab {
                   7882:   background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
                   7883: }
                   7884: #LC_minitab_header #LC_current_minitab a {
                   7885:   background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
                   7886:   padding-bottom:5px;
                   7887: }
                   7888: 
                   7889: 
1.343     albertel 7890: END
                   7891: }
                   7892: 
1.306     albertel 7893: =pod
                   7894: 
                   7895: =item * &headtag()
                   7896: 
                   7897: Returns a uniform footer for LON-CAPA web pages.
                   7898: 
1.307     albertel 7899: Inputs: $title - optional title for the head
                   7900:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 7901:         $args - optional arguments
1.319     albertel 7902:             force_register - if is true call registerurl so the remote is 
                   7903:                              informed
1.415     albertel 7904:             redirect       -> array ref of
                   7905:                                    1- seconds before redirect occurs
                   7906:                                    2- url to redirect to
                   7907:                                    3- whether the side effect should occur
1.315     albertel 7908:                            (side effect of setting 
                   7909:                                $env{'internal.head.redirect'} to the url 
                   7910:                                redirected too)
1.352     albertel 7911:             domain         -> force to color decorate a page for a specific
                   7912:                                domain
                   7913:             function       -> force usage of a specific rolish color scheme
                   7914:             bgcolor        -> override the default page bgcolor
1.460     albertel 7915:             no_auto_mt_title
                   7916:                            -> prevent &mt()ing the title arg
1.464     albertel 7917: 
1.306     albertel 7918: =cut
                   7919: 
                   7920: sub headtag {
1.313     albertel 7921:     my ($title,$head_extra,$args) = @_;
1.306     albertel 7922:     
1.363     albertel 7923:     my $function = $args->{'function'} || &get_users_function();
                   7924:     my $domain   = $args->{'domain'}   || &determinedomain();
                   7925:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1075.2.52  raeburn  7926:     my $httphost = $args->{'use_absolute'};
1.418     albertel 7927:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 7928: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 7929: 		   #time(),
1.418     albertel 7930: 		   $env{'environment.color.timestamp'},
1.363     albertel 7931: 		   $function,$domain,$bgcolor);
                   7932: 
1.369     www      7933:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 7934: 
1.308     albertel 7935:     my $result =
                   7936: 	'<head>'.
1.1075.2.56  raeburn  7937: 	&font_settings($args);
1.319     albertel 7938: 
1.1075.2.72  raeburn  7939:     my $inhibitprint;
                   7940:     if ($args->{'print_suppress'}) {
                   7941:         $inhibitprint = &print_suppression();
                   7942:     }
1.1064    raeburn  7943: 
1.461     albertel 7944:     if (!$args->{'frameset'}) {
                   7945: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   7946:     }
1.1075.2.12  raeburn  7947:     if ($args->{'force_register'}) {
                   7948:         $result .= &Apache::lonmenu::registerurl(1);
1.319     albertel 7949:     }
1.436     albertel 7950:     if (!$args->{'no_nav_bar'} 
                   7951: 	&& !$args->{'only_body'}
                   7952: 	&& !$args->{'frameset'}) {
1.1075.2.52  raeburn  7953: 	$result .= &help_menu_js($httphost);
1.1032    www      7954:         $result.=&modal_window();
1.1038    www      7955:         $result.=&togglebox_script();
1.1034    www      7956:         $result.=&wishlist_window();
1.1041    www      7957:         $result.=&LCprogressbarUpdate_script();
1.1034    www      7958:     } else {
                   7959:         if ($args->{'add_modal'}) {
                   7960:            $result.=&modal_window();
                   7961:         }
                   7962:         if ($args->{'add_wishlist'}) {
                   7963:            $result.=&wishlist_window();
                   7964:         }
1.1038    www      7965:         if ($args->{'add_togglebox'}) {
                   7966:            $result.=&togglebox_script();
                   7967:         }
1.1041    www      7968:         if ($args->{'add_progressbar'}) {
                   7969:            $result.=&LCprogressbarUpdate_script();
                   7970:         }
1.436     albertel 7971:     }
1.314     albertel 7972:     if (ref($args->{'redirect'})) {
1.414     albertel 7973: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 7974: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 7975: 	if (!$inhibit_continue) {
                   7976: 	    $env{'internal.head.redirect'} = $url;
                   7977: 	}
1.313     albertel 7978: 	$result.=<<ADDMETA
                   7979: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 7980: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 7981: ADDMETA
1.1075.2.89  raeburn  7982:     } else {
                   7983:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
                   7984:             my $requrl = $env{'request.uri'};
                   7985:             if ($requrl eq '') {
                   7986:                 $requrl = $ENV{'REQUEST_URI'};
                   7987:                 $requrl =~ s/\?.+$//;
                   7988:             }
                   7989:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
                   7990:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
                   7991:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
                   7992:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
                   7993:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
                   7994:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1075.2.145  raeburn  7995:                     my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1075.2.151  raeburn  7996:                     my ($offload,$offloadoth);
1.1075.2.89  raeburn  7997:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
                   7998:                         if ($domdefs{'offloadnow'}{$lonhost}) {
1.1075.2.145  raeburn  7999:                             $offload = 1;
1.1075.2.151  raeburn  8000:                             if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8001:                                 (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8002:                                 unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8003:                                     $offloadoth = 1;
                   8004:                                     $dom_in_use = $env{'user.domain'};
                   8005:                                 }
                   8006:                             }
1.1075.2.145  raeburn  8007:                         }
                   8008:                     }
                   8009:                     unless ($offload) {
                   8010:                         if (ref($domdefs{'offloadoth'}) eq 'HASH') {
                   8011:                             if ($domdefs{'offloadoth'}{$lonhost}) {
                   8012:                                 if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8013:                                     (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8014:                                     unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8015:                                         $offload = 1;
1.1075.2.151  raeburn  8016:                                         $offloadoth = 1;
1.1075.2.145  raeburn  8017:                                         $dom_in_use = $env{'user.domain'};
                   8018:                                     }
1.1075.2.89  raeburn  8019:                                 }
1.1075.2.145  raeburn  8020:                             }
                   8021:                         }
                   8022:                     }
                   8023:                     if ($offload) {
                   8024:                         my $newserver = &Apache::lonnet::spareserver(30000,undef,1,$dom_in_use);
1.1075.2.151  raeburn  8025:                         if (($newserver eq '') && ($offloadoth)) {
                   8026:                             my @domains = &Apache::lonnet::current_machine_domains();
                   8027:                             if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) { 
                   8028:                                 ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
                   8029:                             }
                   8030:                         }
1.1075.2.145  raeburn  8031:                         if (($newserver) && ($newserver ne $lonhost)) {
                   8032:                             my $numsec = 5;
                   8033:                             my $timeout = $numsec * 1000;
                   8034:                             my ($newurl,$locknum,%locks,$msg);
                   8035:                             if ($env{'request.role.adv'}) {
                   8036:                                 ($locknum,%locks) = &Apache::lonnet::get_locks();
                   8037:                             }
                   8038:                             my $disable_submit = 0;
                   8039:                             if ($requrl =~ /$LONCAPA::assess_re/) {
                   8040:                                 $disable_submit = 1;
                   8041:                             }
                   8042:                             if ($locknum) {
                   8043:                                 my @lockinfo = sort(values(%locks));
1.1075.2.153  raeburn  8044:                                 $msg = &mt('Once the following tasks are complete:')." \n".
1.1075.2.145  raeburn  8045:                                        join(", ",sort(values(%locks)))."\n";
                   8046:                                 if (&show_course()) {
                   8047:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
1.1075.2.89  raeburn  8048:                                 } else {
1.1075.2.145  raeburn  8049:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
                   8050:                                 }
                   8051:                             } else {
                   8052:                                 if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
                   8053:                                     $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
                   8054:                                 }
                   8055:                                 $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
                   8056:                                 $newurl = '/adm/switchserver?otherserver='.$newserver;
                   8057:                                 if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
                   8058:                                     $newurl .= '&role='.$env{'request.role'};
                   8059:                                 }
                   8060:                                 if ($env{'request.symb'}) {
                   8061:                                     my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
                   8062:                                     if ($shownsymb =~ m{^/enc/}) {
                   8063:                                         my $reqdmajor = 2;
                   8064:                                         my $reqdminor = 11;
                   8065:                                         my $reqdsubminor = 3;
                   8066:                                         my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
                   8067:                                         my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
                   8068:                                         my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
                   8069:                                         if (($major eq '' && $minor eq '') ||
                   8070:                                             (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
                   8071:                                             (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
                   8072:                                              ($reqdsubminor > $subminor))))) {
                   8073:                                             undef($shownsymb);
                   8074:                                         }
1.1075.2.89  raeburn  8075:                                     }
1.1075.2.145  raeburn  8076:                                     if ($shownsymb) {
                   8077:                                         &js_escape(\$shownsymb);
                   8078:                                         $newurl .= '&symb='.$shownsymb;
1.1075.2.89  raeburn  8079:                                     }
1.1075.2.145  raeburn  8080:                                 } else {
                   8081:                                     my $shownurl = &Apache::lonenc::check_encrypt($requrl);
                   8082:                                     &js_escape(\$shownurl);
                   8083:                                     $newurl .= '&origurl='.$shownurl;
1.1075.2.89  raeburn  8084:                                 }
1.1075.2.145  raeburn  8085:                             }
                   8086:                             &js_escape(\$msg);
                   8087:                             $result.=<<OFFLOAD
1.1075.2.89  raeburn  8088: <meta http-equiv="pragma" content="no-cache" />
                   8089: <script type="text/javascript">
1.1075.2.92  raeburn  8090: // <![CDATA[
1.1075.2.89  raeburn  8091: function LC_Offload_Now() {
                   8092:     var dest = "$newurl";
                   8093:     if (dest != '') {
                   8094:         window.location.href="$newurl";
                   8095:     }
                   8096: }
1.1075.2.92  raeburn  8097: \$(document).ready(function () {
                   8098:     window.alert('$msg');
                   8099:     if ($disable_submit) {
1.1075.2.89  raeburn  8100:         \$(".LC_hwk_submit").prop("disabled", true);
                   8101:         \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1075.2.92  raeburn  8102:     }
                   8103:     setTimeout('LC_Offload_Now()', $timeout);
                   8104: });
                   8105: // ]]>
1.1075.2.89  raeburn  8106: </script>
                   8107: OFFLOAD
                   8108:                         }
                   8109:                     }
                   8110:                 }
                   8111:             }
                   8112:         }
1.313     albertel 8113:     }
1.306     albertel 8114:     if (!defined($title)) {
                   8115: 	$title = 'The LearningOnline Network with CAPA';
                   8116:     }
1.460     albertel 8117:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   8118:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.1075.2.61  raeburn  8119: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'"';
                   8120:     if (!$args->{'frameset'}) {
                   8121:         $result .= ' /';
                   8122:     }
                   8123:     $result .= '>'
1.1064    raeburn  8124:         .$inhibitprint
1.414     albertel 8125: 	.$head_extra;
1.1075.2.108  raeburn  8126:     my $clientmobile;
                   8127:     if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   8128:         (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
                   8129:     } else {
                   8130:         $clientmobile = $env{'browser.mobile'};
                   8131:     }
                   8132:     if ($clientmobile) {
1.1075.2.42  raeburn  8133:         $result .= '
                   8134: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
                   8135: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   8136:     }
1.1075.2.126  raeburn  8137:     $result .= '<meta name="google" content="notranslate" />'."\n";
1.962     droeschl 8138:     return $result.'</head>';
1.306     albertel 8139: }
                   8140: 
                   8141: =pod
                   8142: 
1.340     albertel 8143: =item * &font_settings()
                   8144: 
                   8145: Returns neccessary <meta> to set the proper encoding
                   8146: 
1.1075.2.56  raeburn  8147: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 8148: 
                   8149: =cut
                   8150: 
                   8151: sub font_settings {
1.1075.2.56  raeburn  8152:     my ($args) = @_;
1.340     albertel 8153:     my $headerstring='';
1.1075.2.56  raeburn  8154:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   8155:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.340     albertel 8156: 	$headerstring.=
1.1075.2.61  raeburn  8157: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   8158:         if (!$args->{'frameset'}) {
                   8159:             $headerstring.= ' /';
                   8160:         }
                   8161:         $headerstring .= '>'."\n";
1.340     albertel 8162:     }
                   8163:     return $headerstring;
                   8164: }
                   8165: 
1.341     albertel 8166: =pod
                   8167: 
1.1064    raeburn  8168: =item * &print_suppression()
                   8169: 
                   8170: In course context returns css which causes the body to be blank when media="print",
                   8171: if printout generation is unavailable for the current resource.
                   8172: 
                   8173: This could be because:
                   8174: 
                   8175: (a) printstartdate is in the future
                   8176: 
                   8177: (b) printenddate is in the past
                   8178: 
                   8179: (c) there is an active exam block with "printout"
                   8180: functionality blocked
                   8181: 
                   8182: Users with pav, pfo or evb privileges are exempt.
                   8183: 
                   8184: Inputs: none
                   8185: 
                   8186: =cut
                   8187: 
                   8188: 
                   8189: sub print_suppression {
                   8190:     my $noprint;
                   8191:     if ($env{'request.course.id'}) {
                   8192:         my $scope = $env{'request.course.id'};
                   8193:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8194:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   8195:             return;
                   8196:         }
                   8197:         if ($env{'request.course.sec'} ne '') {
                   8198:             $scope .= "/$env{'request.course.sec'}";
                   8199:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8200:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  8201:                 return;
1.1064    raeburn  8202:             }
                   8203:         }
                   8204:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8205:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.73  raeburn  8206:         my $blocked = &blocking_status('printout',$cnum,$cdom,undef,1);
1.1064    raeburn  8207:         if ($blocked) {
                   8208:             my $checkrole = "cm./$cdom/$cnum";
                   8209:             if ($env{'request.course.sec'} ne '') {
                   8210:                 $checkrole .= "/$env{'request.course.sec'}";
                   8211:             }
                   8212:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   8213:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   8214:                 $noprint = 1;
                   8215:             }
                   8216:         }
                   8217:         unless ($noprint) {
                   8218:             my $symb = &Apache::lonnet::symbread();
                   8219:             if ($symb ne '') {
                   8220:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   8221:                 if (ref($navmap)) {
                   8222:                     my $res = $navmap->getBySymb($symb);
                   8223:                     if (ref($res)) {
                   8224:                         if (!$res->resprintable()) {
                   8225:                             $noprint = 1;
                   8226:                         }
                   8227:                     }
                   8228:                 }
                   8229:             }
                   8230:         }
                   8231:         if ($noprint) {
                   8232:             return <<"ENDSTYLE";
                   8233: <style type="text/css" media="print">
                   8234:     body { display:none }
                   8235: </style>
                   8236: ENDSTYLE
                   8237:         }
                   8238:     }
                   8239:     return;
                   8240: }
                   8241: 
                   8242: =pod
                   8243: 
1.341     albertel 8244: =item * &xml_begin()
                   8245: 
                   8246: Returns the needed doctype and <html>
                   8247: 
                   8248: Inputs: none
                   8249: 
                   8250: =cut
                   8251: 
                   8252: sub xml_begin {
1.1075.2.61  raeburn  8253:     my ($is_frameset) = @_;
1.341     albertel 8254:     my $output='';
                   8255: 
                   8256:     if ($env{'browser.mathml'}) {
                   8257: 	$output='<?xml version="1.0"?>'
                   8258:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   8259: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   8260:             
                   8261: #	    .'<!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">] >'
                   8262: 	    .'<!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">'
                   8263:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   8264: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1075.2.61  raeburn  8265:     } elsif ($is_frameset) {
                   8266:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
                   8267:                 '<html>'."\n";
1.341     albertel 8268:     } else {
1.1075.2.61  raeburn  8269: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   8270:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 8271:     }
                   8272:     return $output;
                   8273: }
1.340     albertel 8274: 
                   8275: =pod
                   8276: 
1.306     albertel 8277: =item * &start_page()
                   8278: 
                   8279: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   8280: 
1.648     raeburn  8281: Inputs:
                   8282: 
                   8283: =over 4
                   8284: 
                   8285: $title - optional title for the page
                   8286: 
                   8287: $head_extra - optional extra HTML to incude inside the <head>
                   8288: 
                   8289: $args - additional optional args supported are:
                   8290: 
                   8291: =over 8
                   8292: 
                   8293:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 8294:                                     arg on
1.814     bisitz   8295:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  8296:              add_entries    -> additional attributes to add to the  <body>
                   8297:              domain         -> force to color decorate a page for a 
1.317     albertel 8298:                                     specific domain
1.648     raeburn  8299:              function       -> force usage of a specific rolish color
1.317     albertel 8300:                                     scheme
1.648     raeburn  8301:              redirect       -> see &headtag()
                   8302:              bgcolor        -> override the default page bg color
                   8303:              js_ready       -> return a string ready for being used in 
1.317     albertel 8304:                                     a javascript writeln
1.648     raeburn  8305:              html_encode    -> return a string ready for being used in 
1.320     albertel 8306:                                     a html attribute
1.648     raeburn  8307:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 8308:                                     $forcereg arg
1.648     raeburn  8309:              frameset       -> if true will start with a <frameset>
1.330     albertel 8310:                                     rather than <body>
1.648     raeburn  8311:              skip_phases    -> hash ref of 
1.338     albertel 8312:                                     head -> skip the <html><head> generation
                   8313:                                     body -> skip all <body> generation
1.1075.2.12  raeburn  8314:              no_inline_link -> if true and in remote mode, don't show the
                   8315:                                     'Switch To Inline Menu' link
1.648     raeburn  8316:              no_auto_mt_title -> prevent &mt()ing the title arg
1.867     kalberla 8317:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  8318:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1075.2.123  raeburn  8319:              bread_crumbs_nomenu -> if true will pass false as the value of $menulink
                   8320:                                     to lonhtmlcommon::breadcrumbs
1.1075.2.15  raeburn  8321:              group          -> includes the current group, if page is for a
                   8322:                                specific group
1.1075.2.133  raeburn  8323:              use_absolute   -> for request for external resource or syllabus, this
                   8324:                                will contain https://<hostname> if server uses
                   8325:                                https (as per hosts.tab), but request is for http
                   8326:              hostname       -> hostname, originally from $r->hostname(), (optional).
1.361     albertel 8327: 
1.648     raeburn  8328: =back
1.460     albertel 8329: 
1.648     raeburn  8330: =back
1.562     albertel 8331: 
1.306     albertel 8332: =cut
                   8333: 
                   8334: sub start_page {
1.309     albertel 8335:     my ($title,$head_extra,$args) = @_;
1.318     albertel 8336:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 8337: 
1.315     albertel 8338:     $env{'internal.start_page'}++;
1.1075.2.15  raeburn  8339:     my ($result,@advtools);
1.964     droeschl 8340: 
1.338     albertel 8341:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1075.2.62  raeburn  8342:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 8343:     }
                   8344:     
                   8345:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   8346: 	if ($args->{'frameset'}) {
                   8347: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   8348: 						$args->{'add_entries'});
                   8349: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   8350:         } else {
                   8351:             $result .=
                   8352:                 &bodytag($title, 
                   8353:                          $args->{'function'},       $args->{'add_entries'},
                   8354:                          $args->{'only_body'},      $args->{'domain'},
                   8355:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12  raeburn  8356:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
1.1075.2.15  raeburn  8357:                          $args,                     \@advtools);
1.831     bisitz   8358:         }
1.330     albertel 8359:     }
1.338     albertel 8360: 
1.315     albertel 8361:     if ($args->{'js_ready'}) {
1.713     kaisler  8362: 		$result = &js_ready($result);
1.315     albertel 8363:     }
1.320     albertel 8364:     if ($args->{'html_encode'}) {
1.713     kaisler  8365: 		$result = &html_encode($result);
                   8366:     }
                   8367: 
1.813     bisitz   8368:     # Preparation for new and consistent functionlist at top of screen
                   8369:     # if ($args->{'functionlist'}) {
                   8370:     #            $result .= &build_functionlist();
                   8371:     #}
                   8372: 
1.964     droeschl 8373:     # Don't add anything more if only_body wanted or in const space
                   8374:     return $result if    $args->{'only_body'} 
                   8375:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   8376: 
                   8377:     #Breadcrumbs
1.758     kaisler  8378:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   8379: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   8380: 		#if any br links exists, add them to the breadcrumbs
                   8381: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   8382: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   8383: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   8384: 			}
                   8385: 		}
1.1075.2.19  raeburn  8386:                 # if @advtools array contains items add then to the breadcrumbs
                   8387:                 if (@advtools > 0) {
                   8388:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   8389:                 }
1.1075.2.123  raeburn  8390:                 my $menulink;
                   8391:                 # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
                   8392:                 if (exists($args->{'bread_crumbs_nomenu'})) {
                   8393:                     $menulink = 0;
                   8394:                 } else {
                   8395:                     undef($menulink);
                   8396:                 }
1.758     kaisler  8397: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   8398: 		if(exists($args->{'bread_crumbs_component'})){
1.1075.2.123  raeburn  8399: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.758     kaisler  8400: 		}else{
1.1075.2.123  raeburn  8401: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758     kaisler  8402: 		}
1.1075.2.24  raeburn  8403:     } elsif (($env{'environment.remote'} eq 'on') &&
                   8404:              ($env{'form.inhibitmenu'} ne 'yes') &&
                   8405:              ($env{'request.noversionuri'} =~ m{^/res/}) &&
                   8406:              ($env{'request.noversionuri'} !~ m{^/res/adm/pages/})) {
1.1075.2.21  raeburn  8407:         $result .= '<div style="padding:0;margin:0;clear:both"><hr /></div>';
1.320     albertel 8408:     }
1.315     albertel 8409:     return $result;
1.306     albertel 8410: }
                   8411: 
                   8412: sub end_page {
1.315     albertel 8413:     my ($args) = @_;
                   8414:     $env{'internal.end_page'}++;
1.330     albertel 8415:     my $result;
1.335     albertel 8416:     if ($args->{'discussion'}) {
                   8417: 	my ($target,$parser);
                   8418: 	if (ref($args->{'discussion'})) {
                   8419: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   8420: 				$args->{'discussion'}{'parser'});
                   8421: 	}
                   8422: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   8423:     }
1.330     albertel 8424:     if ($args->{'frameset'}) {
                   8425: 	$result .= '</frameset>';
                   8426:     } else {
1.635     raeburn  8427: 	$result .= &endbodytag($args);
1.330     albertel 8428:     }
1.1075.2.6  raeburn  8429:     unless ($args->{'notbody'}) {
                   8430:         $result .= "\n</html>";
                   8431:     }
1.330     albertel 8432: 
1.315     albertel 8433:     if ($args->{'js_ready'}) {
1.317     albertel 8434: 	$result = &js_ready($result);
1.315     albertel 8435:     }
1.335     albertel 8436: 
1.320     albertel 8437:     if ($args->{'html_encode'}) {
                   8438: 	$result = &html_encode($result);
                   8439:     }
1.335     albertel 8440: 
1.315     albertel 8441:     return $result;
                   8442: }
                   8443: 
1.1034    www      8444: sub wishlist_window {
                   8445:     return(<<'ENDWISHLIST');
1.1046    raeburn  8446: <script type="text/javascript">
1.1034    www      8447: // <![CDATA[
                   8448: // <!-- BEGIN LON-CAPA Internal
                   8449: function set_wishlistlink(title, path) {
                   8450:     if (!title) {
                   8451:         title = document.title;
                   8452:         title = title.replace(/^LON-CAPA /,'');
                   8453:     }
1.1075.2.65  raeburn  8454:     title = encodeURIComponent(title);
1.1075.2.83  raeburn  8455:     title = title.replace("'","\\\'");
1.1034    www      8456:     if (!path) {
                   8457:         path = location.pathname;
                   8458:     }
1.1075.2.65  raeburn  8459:     path = encodeURIComponent(path);
1.1075.2.83  raeburn  8460:     path = path.replace("'","\\\'");
1.1034    www      8461:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   8462:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   8463: }
                   8464: // END LON-CAPA Internal -->
                   8465: // ]]>
                   8466: </script>
                   8467: ENDWISHLIST
                   8468: }
                   8469: 
1.1030    www      8470: sub modal_window {
                   8471:     return(<<'ENDMODAL');
1.1046    raeburn  8472: <script type="text/javascript">
1.1030    www      8473: // <![CDATA[
                   8474: // <!-- BEGIN LON-CAPA Internal
                   8475: var modalWindow = {
                   8476: 	parent:"body",
                   8477: 	windowId:null,
                   8478: 	content:null,
                   8479: 	width:null,
                   8480: 	height:null,
                   8481: 	close:function()
                   8482: 	{
                   8483: 	        $(".LCmodal-window").remove();
                   8484: 	        $(".LCmodal-overlay").remove();
                   8485: 	},
                   8486: 	open:function()
                   8487: 	{
                   8488: 		var modal = "";
                   8489: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   8490: 		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;\">";
                   8491: 		modal += this.content;
                   8492: 		modal += "</div>";	
                   8493: 
                   8494: 		$(this.parent).append(modal);
                   8495: 
                   8496: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   8497: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   8498: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   8499: 	}
                   8500: };
1.1075.2.42  raeburn  8501: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      8502: 	{
1.1075.2.119  raeburn  8503:                 source = source.replace(/'/g,"&#39;");
1.1030    www      8504: 		modalWindow.windowId = "myModal";
                   8505: 		modalWindow.width = width;
                   8506: 		modalWindow.height = height;
1.1075.2.80  raeburn  8507: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      8508: 		modalWindow.open();
1.1075.2.87  raeburn  8509: 	};
1.1030    www      8510: // END LON-CAPA Internal -->
                   8511: // ]]>
                   8512: </script>
                   8513: ENDMODAL
                   8514: }
                   8515: 
                   8516: sub modal_link {
1.1075.2.42  raeburn  8517:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      8518:     unless ($width) { $width=480; }
                   8519:     unless ($height) { $height=400; }
1.1031    www      8520:     unless ($scrolling) { $scrolling='yes'; }
1.1075.2.42  raeburn  8521:     unless ($transparency) { $transparency='true'; }
                   8522: 
1.1074    raeburn  8523:     my $target_attr;
                   8524:     if (defined($target)) {
                   8525:         $target_attr = 'target="'.$target.'"';
                   8526:     }
                   8527:     return <<"ENDLINK";
1.1075.2.143  raeburn  8528: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074    raeburn  8529: ENDLINK
1.1030    www      8530: }
                   8531: 
1.1032    www      8532: sub modal_adhoc_script {
1.1075.2.155  raeburn  8533:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
                   8534:     my $mathjax;
                   8535:     if ($possmathjax) {
                   8536:         $mathjax = <<'ENDJAX';
                   8537:                if (typeof MathJax == 'object') {
                   8538:                    MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
                   8539:                }
                   8540: ENDJAX
                   8541:     }
1.1032    www      8542:     return (<<ENDADHOC);
1.1046    raeburn  8543: <script type="text/javascript">
1.1032    www      8544: // <![CDATA[
                   8545:         var $funcname = function()
                   8546:         {
                   8547:                 modalWindow.windowId = "myModal";
                   8548:                 modalWindow.width = $width;
                   8549:                 modalWindow.height = $height;
                   8550:                 modalWindow.content = '$content';
                   8551:                 modalWindow.open();
1.1075.2.155  raeburn  8552:                 $mathjax
1.1032    www      8553:         };  
                   8554: // ]]>
                   8555: </script>
                   8556: ENDADHOC
                   8557: }
                   8558: 
1.1041    www      8559: sub modal_adhoc_inner {
1.1075.2.155  raeburn  8560:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041    www      8561:     my $innerwidth=$width-20;
                   8562:     $content=&js_ready(
1.1042    www      8563:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1075.2.42  raeburn  8564:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   8565:                  $content.
1.1041    www      8566:                  &end_scrollbox().
1.1075.2.42  raeburn  8567:                  &end_page()
1.1041    www      8568:              );
1.1075.2.155  raeburn  8569:     return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041    www      8570: }
                   8571: 
                   8572: sub modal_adhoc_window {
1.1075.2.155  raeburn  8573:     my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
                   8574:     return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041    www      8575:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   8576: }
                   8577: 
                   8578: sub modal_adhoc_launch {
                   8579:     my ($funcname,$width,$height,$content)=@_;
                   8580:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   8581: <script type="text/javascript">
                   8582: // <![CDATA[
                   8583: $funcname();
                   8584: // ]]>
                   8585: </script>
                   8586: ENDLAUNCH
                   8587: }
                   8588: 
                   8589: sub modal_adhoc_close {
                   8590:     return (<<ENDCLOSE);
                   8591: <script type="text/javascript">
                   8592: // <![CDATA[
                   8593: modalWindow.close();
                   8594: // ]]>
                   8595: </script>
                   8596: ENDCLOSE
                   8597: }
                   8598: 
1.1038    www      8599: sub togglebox_script {
                   8600:    return(<<ENDTOGGLE);
                   8601: <script type="text/javascript"> 
                   8602: // <![CDATA[
                   8603: function LCtoggleDisplay(id,hidetext,showtext) {
                   8604:    link = document.getElementById(id + "link").childNodes[0];
                   8605:    with (document.getElementById(id).style) {
                   8606:       if (display == "none" ) {
                   8607:           display = "inline";
                   8608:           link.nodeValue = hidetext;
                   8609:         } else {
                   8610:           display = "none";
                   8611:           link.nodeValue = showtext;
                   8612:        }
                   8613:    }
                   8614: }
                   8615: // ]]>
                   8616: </script>
                   8617: ENDTOGGLE
                   8618: }
                   8619: 
1.1039    www      8620: sub start_togglebox {
                   8621:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   8622:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   8623:     unless ($showtext) { $showtext=&mt('show'); }
                   8624:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   8625:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   8626:     return &start_data_table().
                   8627:            &start_data_table_header_row().
                   8628:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   8629:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   8630:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   8631:            &end_data_table_header_row().
                   8632:            '<tr id="'.$id.'" style="display:none""><td>';
                   8633: }
                   8634: 
                   8635: sub end_togglebox {
                   8636:     return '</td></tr>'.&end_data_table();
                   8637: }
                   8638: 
1.1041    www      8639: sub LCprogressbar_script {
1.1075.2.130  raeburn  8640:    my ($id,$number_to_do)=@_;
                   8641:    if ($number_to_do) {
                   8642:        return(<<ENDPROGRESS);
1.1041    www      8643: <script type="text/javascript">
                   8644: // <![CDATA[
1.1045    www      8645: \$('#progressbar$id').progressbar({
1.1041    www      8646:   value: 0,
                   8647:   change: function(event, ui) {
                   8648:     var newVal = \$(this).progressbar('option', 'value');
                   8649:     \$('.pblabel', this).text(LCprogressTxt);
                   8650:   }
                   8651: });
                   8652: // ]]>
                   8653: </script>
                   8654: ENDPROGRESS
1.1075.2.130  raeburn  8655:    } else {
                   8656:        return(<<ENDPROGRESS);
                   8657: <script type="text/javascript">
                   8658: // <![CDATA[
                   8659: \$('#progressbar$id').progressbar({
                   8660:   value: false,
                   8661:   create: function(event, ui) {
                   8662:     \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
                   8663:     \$('.ui-progressbar-overlay', this).css({'margin':'0'});
                   8664:   }
                   8665: });
                   8666: // ]]>
                   8667: </script>
                   8668: ENDPROGRESS
                   8669:    }
1.1041    www      8670: }
                   8671: 
                   8672: sub LCprogressbarUpdate_script {
                   8673:    return(<<ENDPROGRESSUPDATE);
                   8674: <style type="text/css">
                   8675: .ui-progressbar { position:relative; }
1.1075.2.130  raeburn  8676: .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      8677: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   8678: </style>
                   8679: <script type="text/javascript">
                   8680: // <![CDATA[
1.1045    www      8681: var LCprogressTxt='---';
                   8682: 
1.1075.2.130  raeburn  8683: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041    www      8684:    LCprogressTxt=progresstext;
1.1075.2.130  raeburn  8685:    if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
                   8686:        \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
                   8687:    } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
                   8688:        \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
                   8689:    } else {
                   8690:        \$('#progressbar'+id).progressbar('value',percent);
                   8691:    }
1.1041    www      8692: }
                   8693: // ]]>
                   8694: </script>
                   8695: ENDPROGRESSUPDATE
                   8696: }
                   8697: 
1.1042    www      8698: my $LClastpercent;
1.1045    www      8699: my $LCidcnt;
                   8700: my $LCcurrentid;
1.1042    www      8701: 
1.1041    www      8702: sub LCprogressbar {
1.1075.2.130  raeburn  8703:     my ($r,$number_to_do,$preamble)=@_;
1.1042    www      8704:     $LClastpercent=0;
1.1045    www      8705:     $LCidcnt++;
                   8706:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1075.2.130  raeburn  8707:     my ($starting,$content);
                   8708:     if ($number_to_do) {
                   8709:         $starting=&mt('Starting');
                   8710:         $content=(<<ENDPROGBAR);
                   8711: $preamble
1.1045    www      8712:   <div id="progressbar$LCcurrentid">
1.1041    www      8713:     <span class="pblabel">$starting</span>
                   8714:   </div>
                   8715: ENDPROGBAR
1.1075.2.130  raeburn  8716:     } else {
                   8717:         $starting=&mt('Loading...');
                   8718:         $LClastpercent='false';
                   8719:         $content=(<<ENDPROGBAR);
                   8720: $preamble
                   8721:   <div id="progressbar$LCcurrentid">
                   8722:       <div class="progress-label">$starting</div>
                   8723:   </div>
                   8724: ENDPROGBAR
                   8725:     }
                   8726:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041    www      8727: }
                   8728: 
                   8729: sub LCprogressbarUpdate {
1.1075.2.130  raeburn  8730:     my ($r,$val,$text,$number_to_do)=@_;
                   8731:     if ($number_to_do) {
                   8732:         unless ($val) { 
                   8733:             if ($LClastpercent) {
                   8734:                 $val=$LClastpercent;
                   8735:             } else {
                   8736:                 $val=0;
                   8737:             }
                   8738:         }
                   8739:         if ($val<0) { $val=0; }
                   8740:         if ($val>100) { $val=0; }
                   8741:         $LClastpercent=$val;
                   8742:         unless ($text) { $text=$val.'%'; }
                   8743:     } else {
                   8744:         $val = 'false';
1.1042    www      8745:     }
1.1041    www      8746:     $text=&js_ready($text);
1.1044    www      8747:     &r_print($r,<<ENDUPDATE);
1.1041    www      8748: <script type="text/javascript">
                   8749: // <![CDATA[
1.1075.2.130  raeburn  8750: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041    www      8751: // ]]>
                   8752: </script>
                   8753: ENDUPDATE
1.1035    www      8754: }
                   8755: 
1.1042    www      8756: sub LCprogressbarClose {
                   8757:     my ($r)=@_;
                   8758:     $LClastpercent=0;
1.1044    www      8759:     &r_print($r,<<ENDCLOSE);
1.1042    www      8760: <script type="text/javascript">
                   8761: // <![CDATA[
1.1045    www      8762: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      8763: // ]]>
                   8764: </script>
                   8765: ENDCLOSE
1.1044    www      8766: }
                   8767: 
                   8768: sub r_print {
                   8769:     my ($r,$to_print)=@_;
                   8770:     if ($r) {
                   8771:       $r->print($to_print);
                   8772:       $r->rflush();
                   8773:     } else {
                   8774:       print($to_print);
                   8775:     }
1.1042    www      8776: }
                   8777: 
1.320     albertel 8778: sub html_encode {
                   8779:     my ($result) = @_;
                   8780: 
1.322     albertel 8781:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 8782:     
                   8783:     return $result;
                   8784: }
1.1044    www      8785: 
1.317     albertel 8786: sub js_ready {
                   8787:     my ($result) = @_;
                   8788: 
1.323     albertel 8789:     $result =~ s/[\n\r]/ /xmsg;
                   8790:     $result =~ s/\\/\\\\/xmsg;
                   8791:     $result =~ s/'/\\'/xmsg;
1.372     albertel 8792:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 8793:     
                   8794:     return $result;
                   8795: }
                   8796: 
1.315     albertel 8797: sub validate_page {
                   8798:     if (  exists($env{'internal.start_page'})
1.316     albertel 8799: 	  &&     $env{'internal.start_page'} > 1) {
                   8800: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 8801: 				 $env{'internal.start_page'}.' '.
1.316     albertel 8802: 				 $ENV{'request.filename'});
1.315     albertel 8803:     }
                   8804:     if (  exists($env{'internal.end_page'})
1.316     albertel 8805: 	  &&     $env{'internal.end_page'} > 1) {
                   8806: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 8807: 				 $env{'internal.end_page'}.' '.
1.316     albertel 8808: 				 $env{'request.filename'});
1.315     albertel 8809:     }
                   8810:     if (     exists($env{'internal.start_page'})
                   8811: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 8812: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   8813: 				 $env{'request.filename'});
1.315     albertel 8814:     }
                   8815:     if (   ! exists($env{'internal.start_page'})
                   8816: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 8817: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   8818: 				 $env{'request.filename'});
1.315     albertel 8819:     }
1.306     albertel 8820: }
1.315     albertel 8821: 
1.996     www      8822: 
                   8823: sub start_scrollbox {
1.1075.2.56  raeburn  8824:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  8825:     unless ($outerwidth) { $outerwidth='520px'; }
                   8826:     unless ($width) { $width='500px'; }
                   8827:     unless ($height) { $height='200px'; }
1.1075    raeburn  8828:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  8829:     if ($id ne '') {
1.1075.2.42  raeburn  8830:         $table_id = ' id="table_'.$id.'"';
                   8831:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  8832:     }
1.1075    raeburn  8833:     if ($bgcolor ne '') {
                   8834:         $tdcol = "background-color: $bgcolor;";
                   8835:     }
1.1075.2.42  raeburn  8836:     my $nicescroll_js;
                   8837:     if ($env{'browser.mobile'}) {
                   8838:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   8839:     }
1.1075    raeburn  8840:     return <<"END";
1.1075.2.42  raeburn  8841: $nicescroll_js
                   8842: 
                   8843: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
1.1075.2.56  raeburn  8844: <div style="overflow:auto; width:$width; height:$height;"$div_id>
1.1075    raeburn  8845: END
1.996     www      8846: }
                   8847: 
                   8848: sub end_scrollbox {
1.1036    www      8849:     return '</div></td></tr></table>';
1.996     www      8850: }
                   8851: 
1.1075.2.42  raeburn  8852: sub nicescroll_javascript {
                   8853:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   8854:     my %options;
                   8855:     if (ref($cursor) eq 'HASH') {
                   8856:         %options = %{$cursor};
                   8857:     }
                   8858:     unless ($options{'railalign'} =~ /^left|right$/) {
                   8859:         $options{'railalign'} = 'left';
                   8860:     }
                   8861:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   8862:         my $function  = &get_users_function();
                   8863:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
                   8864:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   8865:             $options{'cursorcolor'} = '#00F';
                   8866:         }
                   8867:     }
                   8868:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   8869:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
                   8870:             $options{'cursoropacity'}='1.0';
                   8871:         }
                   8872:     } else {
                   8873:         $options{'cursoropacity'}='1.0';
                   8874:     }
                   8875:     if ($options{'cursorfixedheight'} eq 'none') {
                   8876:         delete($options{'cursorfixedheight'});
                   8877:     } else {
                   8878:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   8879:     }
                   8880:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   8881:         delete($options{'railoffset'});
                   8882:     }
                   8883:     my @niceoptions;
                   8884:     while (my($key,$value) = each(%options)) {
                   8885:         if ($value =~ /^\{.+\}$/) {
                   8886:             push(@niceoptions,$key.':'.$value);
                   8887:         } else {
                   8888:             push(@niceoptions,$key.':"'.$value.'"');
                   8889:         }
                   8890:     }
                   8891:     my $nicescroll_js = '
                   8892: $(document).ready(
                   8893:       function() {
                   8894:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   8895:       }
                   8896: );
                   8897: ';
                   8898:     if ($framecheck) {
                   8899:         $nicescroll_js .= '
                   8900: function expand_div(caller) {
                   8901:     if (top === self) {
                   8902:         document.getElementById("'.$id.'").style.width = "auto";
                   8903:         document.getElementById("'.$id.'").style.height = "auto";
                   8904:     } else {
                   8905:         try {
                   8906:             if (parent.frames) {
                   8907:                 if (parent.frames.length > 1) {
                   8908:                     var framesrc = parent.frames[1].location.href;
                   8909:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   8910:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   8911:                         document.getElementById("'.$id.'").style.width = "auto";
                   8912:                         document.getElementById("'.$id.'").style.height = "auto";
                   8913:                     }
                   8914:                 }
                   8915:             }
                   8916:         } catch (e) {
                   8917:             return;
                   8918:         }
                   8919:     }
                   8920:     return;
                   8921: }
                   8922: ';
                   8923:     }
                   8924:     if ($needjsready) {
                   8925:         $nicescroll_js = '
                   8926: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   8927:     } else {
                   8928:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   8929:     }
                   8930:     return $nicescroll_js;
                   8931: }
                   8932: 
1.318     albertel 8933: sub simple_error_page {
1.1075.2.49  raeburn  8934:     my ($r,$title,$msg,$args) = @_;
                   8935:     if (ref($args) eq 'HASH') {
                   8936:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
                   8937:     } else {
                   8938:         $msg = &mt($msg);
                   8939:     }
                   8940: 
1.318     albertel 8941:     my $page =
                   8942: 	&Apache::loncommon::start_page($title).
1.1075.2.49  raeburn  8943: 	'<p class="LC_error">'.$msg.'</p>'.
1.318     albertel 8944: 	&Apache::loncommon::end_page();
                   8945:     if (ref($r)) {
                   8946: 	$r->print($page);
1.327     albertel 8947: 	return;
1.318     albertel 8948:     }
                   8949:     return $page;
                   8950: }
1.347     albertel 8951: 
                   8952: {
1.610     albertel 8953:     my @row_count;
1.961     onken    8954: 
                   8955:     sub start_data_table_count {
                   8956:         unshift(@row_count, 0);
                   8957:         return;
                   8958:     }
                   8959: 
                   8960:     sub end_data_table_count {
                   8961:         shift(@row_count);
                   8962:         return;
                   8963:     }
                   8964: 
1.347     albertel 8965:     sub start_data_table {
1.1018    raeburn  8966: 	my ($add_class,$id) = @_;
1.422     albertel 8967: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  8968:         my $table_id;
                   8969:         if (defined($id)) {
                   8970:             $table_id = ' id="'.$id.'"';
                   8971:         }
1.961     onken    8972: 	&start_data_table_count();
1.1018    raeburn  8973: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 8974:     }
                   8975: 
                   8976:     sub end_data_table {
1.961     onken    8977: 	&end_data_table_count();
1.389     albertel 8978: 	return '</table>'."\n";;
1.347     albertel 8979:     }
                   8980: 
                   8981:     sub start_data_table_row {
1.974     wenzelju 8982: 	my ($add_class, $id) = @_;
1.610     albertel 8983: 	$row_count[0]++;
                   8984: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   8985: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 8986:         $id = (' id="'.$id.'"') unless ($id eq '');
                   8987:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 8988:     }
1.471     banghart 8989:     
                   8990:     sub continue_data_table_row {
1.974     wenzelju 8991: 	my ($add_class, $id) = @_;
1.610     albertel 8992: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 8993: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   8994:         $id = (' id="'.$id.'"') unless ($id eq '');
                   8995:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 8996:     }
1.347     albertel 8997: 
                   8998:     sub end_data_table_row {
1.389     albertel 8999: 	return '</tr>'."\n";;
1.347     albertel 9000:     }
1.367     www      9001: 
1.421     albertel 9002:     sub start_data_table_empty_row {
1.707     bisitz   9003: #	$row_count[0]++;
1.421     albertel 9004: 	return  '<tr class="LC_empty_row" >'."\n";;
                   9005:     }
                   9006: 
                   9007:     sub end_data_table_empty_row {
                   9008: 	return '</tr>'."\n";;
                   9009:     }
                   9010: 
1.367     www      9011:     sub start_data_table_header_row {
1.389     albertel 9012: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      9013:     }
                   9014: 
                   9015:     sub end_data_table_header_row {
1.389     albertel 9016: 	return '</tr>'."\n";;
1.367     www      9017:     }
1.890     droeschl 9018: 
                   9019:     sub data_table_caption {
                   9020:         my $caption = shift;
                   9021:         return "<caption class=\"LC_caption\">$caption</caption>";
                   9022:     }
1.347     albertel 9023: }
                   9024: 
1.548     albertel 9025: =pod
                   9026: 
                   9027: =item * &inhibit_menu_check($arg)
                   9028: 
                   9029: Checks for a inhibitmenu state and generates output to preserve it
                   9030: 
                   9031: Inputs:         $arg - can be any of
                   9032:                      - undef - in which case the return value is a string 
                   9033:                                to add  into arguments list of a uri
                   9034:                      - 'input' - in which case the return value is a HTML
                   9035:                                  <form> <input> field of type hidden to
                   9036:                                  preserve the value
                   9037:                      - a url - in which case the return value is the url with
                   9038:                                the neccesary cgi args added to preserve the
                   9039:                                inhibitmenu state
                   9040:                      - a ref to a url - no return value, but the string is
                   9041:                                         updated to include the neccessary cgi
                   9042:                                         args to preserve the inhibitmenu state
                   9043: 
                   9044: =cut
                   9045: 
                   9046: sub inhibit_menu_check {
                   9047:     my ($arg) = @_;
                   9048:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   9049:     if ($arg eq 'input') {
                   9050: 	if ($env{'form.inhibitmenu'}) {
                   9051: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   9052: 	} else {
                   9053: 	    return
                   9054: 	}
                   9055:     }
                   9056:     if ($env{'form.inhibitmenu'}) {
                   9057: 	if (ref($arg)) {
                   9058: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9059: 	} elsif ($arg eq '') {
                   9060: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   9061: 	} else {
                   9062: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9063: 	}
                   9064:     }
                   9065:     if (!ref($arg)) {
                   9066: 	return $arg;
                   9067:     }
                   9068: }
                   9069: 
1.251     albertel 9070: ###############################################
1.182     matthew  9071: 
                   9072: =pod
                   9073: 
1.549     albertel 9074: =back
                   9075: 
                   9076: =head1 User Information Routines
                   9077: 
                   9078: =over 4
                   9079: 
1.405     albertel 9080: =item * &get_users_function()
1.182     matthew  9081: 
                   9082: Used by &bodytag to determine the current users primary role.
                   9083: Returns either 'student','coordinator','admin', or 'author'.
                   9084: 
                   9085: =cut
                   9086: 
                   9087: ###############################################
                   9088: sub get_users_function {
1.815     tempelho 9089:     my $function = 'norole';
1.818     tempelho 9090:     if ($env{'request.role'}=~/^(st)/) {
                   9091:         $function='student';
                   9092:     }
1.907     raeburn  9093:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  9094:         $function='coordinator';
                   9095:     }
1.258     albertel 9096:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  9097:         $function='admin';
                   9098:     }
1.826     bisitz   9099:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  9100:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  9101:         $function='author';
                   9102:     }
                   9103:     return $function;
1.54      www      9104: }
1.99      www      9105: 
                   9106: ###############################################
                   9107: 
1.233     raeburn  9108: =pod
                   9109: 
1.821     raeburn  9110: =item * &show_course()
                   9111: 
                   9112: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   9113: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   9114: 
                   9115: Inputs:
                   9116: None
                   9117: 
                   9118: Outputs:
                   9119: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   9120: 
                   9121: =cut
                   9122: 
                   9123: ###############################################
                   9124: sub show_course {
                   9125:     my $course = !$env{'user.adv'};
                   9126:     if (!$env{'user.adv'}) {
                   9127:         foreach my $env (keys(%env)) {
                   9128:             next if ($env !~ m/^user\.priv\./);
                   9129:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   9130:                 $course = 0;
                   9131:                 last;
                   9132:             }
                   9133:         }
                   9134:     }
                   9135:     return $course;
                   9136: }
                   9137: 
                   9138: ###############################################
                   9139: 
                   9140: =pod
                   9141: 
1.542     raeburn  9142: =item * &check_user_status()
1.274     raeburn  9143: 
                   9144: Determines current status of supplied role for a
                   9145: specific user. Roles can be active, previous or future.
                   9146: 
                   9147: Inputs: 
                   9148: user's domain, user's username, course's domain,
1.375     raeburn  9149: course's number, optional section ID.
1.274     raeburn  9150: 
                   9151: Outputs:
                   9152: role status: active, previous or future. 
                   9153: 
                   9154: =cut
                   9155: 
                   9156: sub check_user_status {
1.412     raeburn  9157:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  9158:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1075.2.85  raeburn  9159:     my @uroles = keys(%userinfo);
1.274     raeburn  9160:     my $srchstr;
                   9161:     my $active_chk = 'none';
1.412     raeburn  9162:     my $now = time;
1.274     raeburn  9163:     if (@uroles > 0) {
1.908     raeburn  9164:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  9165:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   9166:         } else {
1.412     raeburn  9167:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   9168:         }
                   9169:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  9170:             my $role_end = 0;
                   9171:             my $role_start = 0;
                   9172:             $active_chk = 'active';
1.412     raeburn  9173:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   9174:                 $role_end = $1;
                   9175:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   9176:                     $role_start = $1;
1.274     raeburn  9177:                 }
                   9178:             }
                   9179:             if ($role_start > 0) {
1.412     raeburn  9180:                 if ($now < $role_start) {
1.274     raeburn  9181:                     $active_chk = 'future';
                   9182:                 }
                   9183:             }
                   9184:             if ($role_end > 0) {
1.412     raeburn  9185:                 if ($now > $role_end) {
1.274     raeburn  9186:                     $active_chk = 'previous';
                   9187:                 }
                   9188:             }
                   9189:         }
                   9190:     }
                   9191:     return $active_chk;
                   9192: }
                   9193: 
                   9194: ###############################################
                   9195: 
                   9196: =pod
                   9197: 
1.405     albertel 9198: =item * &get_sections()
1.233     raeburn  9199: 
                   9200: Determines all the sections for a course including
                   9201: sections with students and sections containing other roles.
1.419     raeburn  9202: Incoming parameters: 
                   9203: 
                   9204: 1. domain
                   9205: 2. course number 
                   9206: 3. reference to array containing roles for which sections should 
                   9207: be gathered (optional).
                   9208: 4. reference to array containing status types for which sections 
                   9209: should be gathered (optional).
                   9210: 
                   9211: If the third argument is undefined, sections are gathered for any role. 
                   9212: If the fourth argument is undefined, sections are gathered for any status.
                   9213: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  9214:  
1.374     raeburn  9215: Returns section hash (keys are section IDs, values are
                   9216: number of users in each section), subject to the
1.419     raeburn  9217: optional roles filter, optional status filter 
1.233     raeburn  9218: 
                   9219: =cut
                   9220: 
                   9221: ###############################################
                   9222: sub get_sections {
1.419     raeburn  9223:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 9224:     if (!defined($cdom) || !defined($cnum)) {
                   9225:         my $cid =  $env{'request.course.id'};
                   9226: 
                   9227: 	return if (!defined($cid));
                   9228: 
                   9229:         $cdom = $env{'course.'.$cid.'.domain'};
                   9230:         $cnum = $env{'course.'.$cid.'.num'};
                   9231:     }
                   9232: 
                   9233:     my %sectioncount;
1.419     raeburn  9234:     my $now = time;
1.240     albertel 9235: 
1.1075.2.33  raeburn  9236:     my $check_students = 1;
                   9237:     my $only_students = 0;
                   9238:     if (ref($possible_roles) eq 'ARRAY') {
                   9239:         if (grep(/^st$/,@{$possible_roles})) {
                   9240:             if (@{$possible_roles} == 1) {
                   9241:                 $only_students = 1;
                   9242:             }
                   9243:         } else {
                   9244:             $check_students = 0;
                   9245:         }
                   9246:     }
                   9247: 
                   9248:     if ($check_students) {
1.276     albertel 9249: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 9250: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   9251: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  9252:         my $start_index = &Apache::loncoursedata::CL_START();
                   9253:         my $end_index = &Apache::loncoursedata::CL_END();
                   9254:         my $status;
1.366     albertel 9255: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  9256: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   9257: 				                     $data->[$status_index],
                   9258:                                                      $data->[$start_index],
                   9259:                                                      $data->[$end_index]);
                   9260:             if ($stu_status eq 'Active') {
                   9261:                 $status = 'active';
                   9262:             } elsif ($end < $now) {
                   9263:                 $status = 'previous';
                   9264:             } elsif ($start > $now) {
                   9265:                 $status = 'future';
                   9266:             } 
                   9267: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   9268:                 if ((!defined($possible_status)) || (($status ne '') && 
                   9269:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   9270: 		    $sectioncount{$section}++;
                   9271:                 }
1.240     albertel 9272: 	    }
                   9273: 	}
                   9274:     }
1.1075.2.33  raeburn  9275:     if ($only_students) {
                   9276:         return %sectioncount;
                   9277:     }
1.240     albertel 9278:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9279:     foreach my $user (sort(keys(%courseroles))) {
                   9280: 	if ($user !~ /^(\w{2})/) { next; }
                   9281: 	my ($role) = ($user =~ /^(\w{2})/);
                   9282: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  9283: 	my ($section,$status);
1.240     albertel 9284: 	if ($role eq 'cr' &&
                   9285: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   9286: 	    $section=$1;
                   9287: 	}
                   9288: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   9289: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  9290:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   9291:         if ($end == -1 && $start == -1) {
                   9292:             next; #deleted role
                   9293:         }
                   9294:         if (!defined($possible_status)) { 
                   9295:             $sectioncount{$section}++;
                   9296:         } else {
                   9297:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   9298:                 $status = 'active';
                   9299:             } elsif ($end < $now) {
                   9300:                 $status = 'future';
                   9301:             } elsif ($start > $now) {
                   9302:                 $status = 'previous';
                   9303:             }
                   9304:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   9305:                 $sectioncount{$section}++;
                   9306:             }
                   9307:         }
1.233     raeburn  9308:     }
1.366     albertel 9309:     return %sectioncount;
1.233     raeburn  9310: }
                   9311: 
1.274     raeburn  9312: ###############################################
1.294     raeburn  9313: 
                   9314: =pod
1.405     albertel 9315: 
                   9316: =item * &get_course_users()
                   9317: 
1.275     raeburn  9318: Retrieves usernames:domains for users in the specified course
                   9319: with specific role(s), and access status. 
                   9320: 
                   9321: Incoming parameters:
1.277     albertel 9322: 1. course domain
                   9323: 2. course number
                   9324: 3. access status: users must have - either active, 
1.275     raeburn  9325: previous, future, or all.
1.277     albertel 9326: 4. reference to array of permissible roles
1.288     raeburn  9327: 5. reference to array of section restrictions (optional)
                   9328: 6. reference to results object (hash of hashes).
                   9329: 7. reference to optional userdata hash
1.609     raeburn  9330: 8. reference to optional statushash
1.630     raeburn  9331: 9. flag if privileged users (except those set to unhide in
                   9332:    course settings) should be excluded    
1.609     raeburn  9333: Keys of top level results hash are roles.
1.275     raeburn  9334: Keys of inner hashes are username:domain, with 
                   9335: values set to access type.
1.288     raeburn  9336: Optional userdata hash returns an array with arguments in the 
                   9337: same order as loncoursedata::get_classlist() for student data.
                   9338: 
1.609     raeburn  9339: Optional statushash returns
                   9340: 
1.288     raeburn  9341: Entries for end, start, section and status are blank because
                   9342: of the possibility of multiple values for non-student roles.
                   9343: 
1.275     raeburn  9344: =cut
1.405     albertel 9345: 
1.275     raeburn  9346: ###############################################
1.405     albertel 9347: 
1.275     raeburn  9348: sub get_course_users {
1.630     raeburn  9349:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  9350:     my %idx = ();
1.419     raeburn  9351:     my %seclists;
1.288     raeburn  9352: 
                   9353:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   9354:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   9355:     $idx{end} = &Apache::loncoursedata::CL_END();
                   9356:     $idx{start} = &Apache::loncoursedata::CL_START();
                   9357:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   9358:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   9359:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   9360:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   9361: 
1.290     albertel 9362:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 9363:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  9364:         my $now = time;
1.277     albertel 9365:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  9366:             my $match = 0;
1.412     raeburn  9367:             my $secmatch = 0;
1.419     raeburn  9368:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  9369:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  9370:             if ($section eq '') {
                   9371:                 $section = 'none';
                   9372:             }
1.291     albertel 9373:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9374:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9375:                     $secmatch = 1;
                   9376:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 9377:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9378:                         $secmatch = 1;
                   9379:                     }
                   9380:                 } else {  
1.419     raeburn  9381: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  9382: 		        $secmatch = 1;
                   9383:                     }
1.290     albertel 9384: 		}
1.412     raeburn  9385:                 if (!$secmatch) {
                   9386:                     next;
                   9387:                 }
1.419     raeburn  9388:             }
1.275     raeburn  9389:             if (defined($$types{'active'})) {
1.288     raeburn  9390:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  9391:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  9392:                     $match = 1;
1.275     raeburn  9393:                 }
                   9394:             }
                   9395:             if (defined($$types{'previous'})) {
1.609     raeburn  9396:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  9397:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  9398:                     $match = 1;
1.275     raeburn  9399:                 }
                   9400:             }
                   9401:             if (defined($$types{'future'})) {
1.609     raeburn  9402:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  9403:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  9404:                     $match = 1;
1.275     raeburn  9405:                 }
                   9406:             }
1.609     raeburn  9407:             if ($match) {
                   9408:                 push(@{$seclists{$student}},$section);
                   9409:                 if (ref($userdata) eq 'HASH') {
                   9410:                     $$userdata{$student} = $$classlist{$student};
                   9411:                 }
                   9412:                 if (ref($statushash) eq 'HASH') {
                   9413:                     $statushash->{$student}{'st'}{$section} = $status;
                   9414:                 }
1.288     raeburn  9415:             }
1.275     raeburn  9416:         }
                   9417:     }
1.412     raeburn  9418:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  9419:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9420:         my $now = time;
1.609     raeburn  9421:         my %displaystatus = ( previous => 'Expired',
                   9422:                               active   => 'Active',
                   9423:                               future   => 'Future',
                   9424:                             );
1.1075.2.36  raeburn  9425:         my (%nothide,@possdoms);
1.630     raeburn  9426:         if ($hidepriv) {
                   9427:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   9428:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   9429:                 if ($user !~ /:/) {
                   9430:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   9431:                 } else {
                   9432:                     $nothide{$user} = 1;
                   9433:                 }
                   9434:             }
1.1075.2.36  raeburn  9435:             my @possdoms = ($cdom);
                   9436:             if ($coursehash{'checkforpriv'}) {
                   9437:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   9438:             }
1.630     raeburn  9439:         }
1.439     raeburn  9440:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  9441:             my $match = 0;
1.412     raeburn  9442:             my $secmatch = 0;
1.439     raeburn  9443:             my $status;
1.412     raeburn  9444:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  9445:             $user =~ s/:$//;
1.439     raeburn  9446:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   9447:             if ($end == -1 || $start == -1) {
                   9448:                 next;
                   9449:             }
                   9450:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   9451:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  9452:                 my ($uname,$udom) = split(/:/,$user);
                   9453:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9454:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9455:                         $secmatch = 1;
                   9456:                     } elsif ($usec eq '') {
1.420     albertel 9457:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9458:                             $secmatch = 1;
                   9459:                         }
                   9460:                     } else {
                   9461:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   9462:                             $secmatch = 1;
                   9463:                         }
                   9464:                     }
                   9465:                     if (!$secmatch) {
                   9466:                         next;
                   9467:                     }
1.288     raeburn  9468:                 }
1.419     raeburn  9469:                 if ($usec eq '') {
                   9470:                     $usec = 'none';
                   9471:                 }
1.275     raeburn  9472:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  9473:                     if ($hidepriv) {
1.1075.2.36  raeburn  9474:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  9475:                             (!$nothide{$uname.':'.$udom})) {
                   9476:                             next;
                   9477:                         }
                   9478:                     }
1.503     raeburn  9479:                     if ($end > 0 && $end < $now) {
1.439     raeburn  9480:                         $status = 'previous';
                   9481:                     } elsif ($start > $now) {
                   9482:                         $status = 'future';
                   9483:                     } else {
                   9484:                         $status = 'active';
                   9485:                     }
1.277     albertel 9486:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  9487:                         if ($status eq $type) {
1.420     albertel 9488:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  9489:                                 push(@{$$users{$role}{$user}},$type);
                   9490:                             }
1.288     raeburn  9491:                             $match = 1;
                   9492:                         }
                   9493:                     }
1.419     raeburn  9494:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   9495:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   9496: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   9497:                         }
1.420     albertel 9498:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  9499:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   9500:                         }
1.609     raeburn  9501:                         if (ref($statushash) eq 'HASH') {
                   9502:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   9503:                         }
1.275     raeburn  9504:                     }
                   9505:                 }
                   9506:             }
                   9507:         }
1.290     albertel 9508:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  9509:             if ((defined($cdom)) && (defined($cnum))) {
                   9510:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   9511:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   9512:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  9513:                     next if ($owner eq '');
                   9514:                     my ($ownername,$ownerdom);
                   9515:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   9516:                         $ownername = $1;
                   9517:                         $ownerdom = $2;
                   9518:                     } else {
                   9519:                         $ownername = $owner;
                   9520:                         $ownerdom = $cdom;
                   9521:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  9522:                     }
                   9523:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 9524:                     if (defined($userdata) && 
1.609     raeburn  9525: 			!exists($$userdata{$owner})) {
                   9526: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   9527:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   9528:                             push(@{$seclists{$owner}},'none');
                   9529:                         }
                   9530:                         if (ref($statushash) eq 'HASH') {
                   9531:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  9532:                         }
1.290     albertel 9533: 		    }
1.279     raeburn  9534:                 }
                   9535:             }
                   9536:         }
1.419     raeburn  9537:         foreach my $user (keys(%seclists)) {
                   9538:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   9539:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   9540:         }
1.275     raeburn  9541:     }
                   9542:     return;
                   9543: }
                   9544: 
1.288     raeburn  9545: sub get_user_info {
                   9546:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 9547:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   9548: 	&plainname($uname,$udom,'lastname');
1.291     albertel 9549:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  9550:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  9551:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   9552:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  9553:     return;
                   9554: }
1.275     raeburn  9555: 
1.472     raeburn  9556: ###############################################
                   9557: 
                   9558: =pod
                   9559: 
                   9560: =item * &get_user_quota()
                   9561: 
1.1075.2.41  raeburn  9562: Retrieves quota assigned for storage of user files.
                   9563: Default is to report quota for portfolio files.
1.472     raeburn  9564: 
                   9565: Incoming parameters:
                   9566: 1. user's username
                   9567: 2. user's domain
1.1075.2.41  raeburn  9568: 3. quota name - portfolio, author, or course
                   9569:    (if no quota name provided, defaults to portfolio).
1.1075.2.59  raeburn  9570: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1075.2.42  raeburn  9571:    course
1.472     raeburn  9572: 
                   9573: Returns:
1.1075.2.58  raeburn  9574: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  9575: 2. (Optional) Type of setting: custom or default
                   9576:    (individually assigned or default for user's 
                   9577:    institutional status).
                   9578: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   9579:    or student - types as defined in localenroll::inst_usertypes 
                   9580:    for user's domain, which determines default quota for user.
                   9581: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  9582: 
                   9583: If a value has been stored in the user's environment, 
1.536     raeburn  9584: it will return that, otherwise it returns the maximal default
1.1075.2.41  raeburn  9585: defined for the user's institutional status(es) in the domain.
1.472     raeburn  9586: 
                   9587: =cut
                   9588: 
                   9589: ###############################################
                   9590: 
                   9591: 
                   9592: sub get_user_quota {
1.1075.2.42  raeburn  9593:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  9594:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  9595:     if (!defined($udom)) {
                   9596:         $udom = $env{'user.domain'};
                   9597:     }
                   9598:     if (!defined($uname)) {
                   9599:         $uname = $env{'user.name'};
                   9600:     }
                   9601:     if (($udom eq '' || $uname eq '') ||
                   9602:         ($udom eq 'public') && ($uname eq 'public')) {
                   9603:         $quota = 0;
1.536     raeburn  9604:         $quotatype = 'default';
                   9605:         $defquota = 0; 
1.472     raeburn  9606:     } else {
1.536     raeburn  9607:         my $inststatus;
1.1075.2.41  raeburn  9608:         if ($quotaname eq 'course') {
                   9609:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   9610:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   9611:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   9612:             } else {
                   9613:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   9614:                 $quota = $cenv{'internal.uploadquota'};
                   9615:             }
1.536     raeburn  9616:         } else {
1.1075.2.41  raeburn  9617:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   9618:                 if ($quotaname eq 'author') {
                   9619:                     $quota = $env{'environment.authorquota'};
                   9620:                 } else {
                   9621:                     $quota = $env{'environment.portfolioquota'};
                   9622:                 }
                   9623:                 $inststatus = $env{'environment.inststatus'};
                   9624:             } else {
                   9625:                 my %userenv = 
                   9626:                     &Apache::lonnet::get('environment',['portfolioquota',
                   9627:                                          'authorquota','inststatus'],$udom,$uname);
                   9628:                 my ($tmp) = keys(%userenv);
                   9629:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   9630:                     if ($quotaname eq 'author') {
                   9631:                         $quota = $userenv{'authorquota'};
                   9632:                     } else {
                   9633:                         $quota = $userenv{'portfolioquota'};
                   9634:                     }
                   9635:                     $inststatus = $userenv{'inststatus'};
                   9636:                 } else {
                   9637:                     undef(%userenv);
                   9638:                 }
                   9639:             }
                   9640:         }
                   9641:         if ($quota eq '' || wantarray) {
                   9642:             if ($quotaname eq 'course') {
                   9643:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1075.2.59  raeburn  9644:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
                   9645:                     ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1075.2.42  raeburn  9646:                     $defquota = $domdefs{$crstype.'quota'};
                   9647:                 }
                   9648:                 if ($defquota eq '') {
                   9649:                     $defquota = 500;
                   9650:                 }
1.1075.2.41  raeburn  9651:             } else {
                   9652:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   9653:             }
                   9654:             if ($quota eq '') {
                   9655:                 $quota = $defquota;
                   9656:                 $quotatype = 'default';
                   9657:             } else {
                   9658:                 $quotatype = 'custom';
                   9659:             }
1.472     raeburn  9660:         }
                   9661:     }
1.536     raeburn  9662:     if (wantarray) {
                   9663:         return ($quota,$quotatype,$settingstatus,$defquota);
                   9664:     } else {
                   9665:         return $quota;
                   9666:     }
1.472     raeburn  9667: }
                   9668: 
                   9669: ###############################################
                   9670: 
                   9671: =pod
                   9672: 
                   9673: =item * &default_quota()
                   9674: 
1.536     raeburn  9675: Retrieves default quota assigned for storage of user portfolio files,
                   9676: given an (optional) user's institutional status.
1.472     raeburn  9677: 
                   9678: Incoming parameters:
1.1075.2.42  raeburn  9679: 
1.472     raeburn  9680: 1. domain
1.536     raeburn  9681: 2. (Optional) institutional status(es).  This is a : separated list of 
                   9682:    status types (e.g., faculty, staff, student etc.)
                   9683:    which apply to the user for whom the default is being retrieved.
                   9684:    If the institutional status string in undefined, the domain
1.1075.2.41  raeburn  9685:    default quota will be returned.
                   9686: 3.  quota name - portfolio, author, or course
                   9687:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  9688: 
                   9689: Returns:
1.1075.2.42  raeburn  9690: 
1.1075.2.58  raeburn  9691: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  9692: 2. (Optional) institutional type which determined the value of the
                   9693:    default quota.
1.472     raeburn  9694: 
                   9695: If a value has been stored in the domain's configuration db,
                   9696: it will return that, otherwise it returns 20 (for backwards 
                   9697: compatibility with domains which have not set up a configuration
1.1075.2.58  raeburn  9698: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  9699: 
1.536     raeburn  9700: If the user's status includes multiple types (e.g., staff and student),
                   9701: the largest default quota which applies to the user determines the
                   9702: default quota returned.
                   9703: 
1.472     raeburn  9704: =cut
                   9705: 
                   9706: ###############################################
                   9707: 
                   9708: 
                   9709: sub default_quota {
1.1075.2.41  raeburn  9710:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  9711:     my ($defquota,$settingstatus);
                   9712:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  9713:                                             ['quotas'],$udom);
1.1075.2.41  raeburn  9714:     my $key = 'defaultquota';
                   9715:     if ($quotaname eq 'author') {
                   9716:         $key = 'authorquota';
                   9717:     }
1.622     raeburn  9718:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  9719:         if ($inststatus ne '') {
1.765     raeburn  9720:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  9721:             foreach my $item (@statuses) {
1.1075.2.41  raeburn  9722:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9723:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  9724:                         if ($defquota eq '') {
1.1075.2.41  raeburn  9725:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9726:                             $settingstatus = $item;
1.1075.2.41  raeburn  9727:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   9728:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9729:                             $settingstatus = $item;
                   9730:                         }
                   9731:                     }
1.1075.2.41  raeburn  9732:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  9733:                     if ($quotahash{'quotas'}{$item} ne '') {
                   9734:                         if ($defquota eq '') {
                   9735:                             $defquota = $quotahash{'quotas'}{$item};
                   9736:                             $settingstatus = $item;
                   9737:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   9738:                             $defquota = $quotahash{'quotas'}{$item};
                   9739:                             $settingstatus = $item;
                   9740:                         }
1.536     raeburn  9741:                     }
                   9742:                 }
                   9743:             }
                   9744:         }
                   9745:         if ($defquota eq '') {
1.1075.2.41  raeburn  9746:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9747:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   9748:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  9749:                 $defquota = $quotahash{'quotas'}{'default'};
                   9750:             }
1.536     raeburn  9751:             $settingstatus = 'default';
1.1075.2.42  raeburn  9752:             if ($defquota eq '') {
                   9753:                 if ($quotaname eq 'author') {
                   9754:                     $defquota = 500;
                   9755:                 }
                   9756:             }
1.536     raeburn  9757:         }
                   9758:     } else {
                   9759:         $settingstatus = 'default';
1.1075.2.41  raeburn  9760:         if ($quotaname eq 'author') {
                   9761:             $defquota = 500;
                   9762:         } else {
                   9763:             $defquota = 20;
                   9764:         }
1.536     raeburn  9765:     }
                   9766:     if (wantarray) {
                   9767:         return ($defquota,$settingstatus);
1.472     raeburn  9768:     } else {
1.536     raeburn  9769:         return $defquota;
1.472     raeburn  9770:     }
                   9771: }
                   9772: 
1.1075.2.41  raeburn  9773: ###############################################
                   9774: 
                   9775: =pod
                   9776: 
1.1075.2.42  raeburn  9777: =item * &excess_filesize_warning()
1.1075.2.41  raeburn  9778: 
                   9779: Returns warning message if upload of file to authoring space, or copying
1.1075.2.42  raeburn  9780: of existing file within authoring space will cause quota for the authoring
                   9781: space to be exceeded.
                   9782: 
                   9783: Same, if upload of a file directly to a course/community via Course Editor
                   9784: will cause quota for uploaded content for the course to be exceeded.
1.1075.2.41  raeburn  9785: 
1.1075.2.61  raeburn  9786: Inputs: 7 
1.1075.2.42  raeburn  9787: 1. username or coursenum
1.1075.2.41  raeburn  9788: 2. domain
1.1075.2.42  raeburn  9789: 3. context ('author' or 'course')
1.1075.2.41  raeburn  9790: 4. filename of file for which action is being requested
                   9791: 5. filesize (kB) of file
                   9792: 6. action being taken: copy or upload.
1.1075.2.59  raeburn  9793: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1075.2.41  raeburn  9794: 
                   9795: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
                   9796:          otherwise return null.
                   9797: 
1.1075.2.42  raeburn  9798: =back
                   9799: 
1.1075.2.41  raeburn  9800: =cut
                   9801: 
1.1075.2.42  raeburn  9802: sub excess_filesize_warning {
1.1075.2.59  raeburn  9803:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1075.2.42  raeburn  9804:     my $current_disk_usage = 0;
1.1075.2.59  raeburn  9805:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1075.2.42  raeburn  9806:     if ($context eq 'author') {
                   9807:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   9808:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   9809:     } else {
                   9810:         foreach my $subdir ('docs','supplemental') {
                   9811:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   9812:         }
                   9813:     }
1.1075.2.41  raeburn  9814:     $disk_quota = int($disk_quota * 1000);
                   9815:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1075.2.69  raeburn  9816:         return '<p class="LC_warning">'.
1.1075.2.41  raeburn  9817:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1075.2.69  raeburn  9818:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   9819:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1075.2.41  raeburn  9820:                             $disk_quota,$current_disk_usage).
                   9821:                '</p>';
                   9822:     }
                   9823:     return;
                   9824: }
                   9825: 
                   9826: ###############################################
                   9827: 
                   9828: 
1.384     raeburn  9829: sub get_secgrprole_info {
                   9830:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   9831:     my %sections_count = &get_sections($cdom,$cnum);
                   9832:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   9833:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   9834:     my @groups = sort(keys(%curr_groups));
                   9835:     my $allroles = [];
                   9836:     my $rolehash;
                   9837:     my $accesshash = {
                   9838:                      active => 'Currently has access',
                   9839:                      future => 'Will have future access',
                   9840:                      previous => 'Previously had access',
                   9841:                   };
                   9842:     if ($needroles) {
                   9843:         $rolehash = {'all' => 'all'};
1.385     albertel 9844:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9845: 	if (&Apache::lonnet::error(%user_roles)) {
                   9846: 	    undef(%user_roles);
                   9847: 	}
                   9848:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  9849:             my ($role)=split(/\:/,$item,2);
                   9850:             if ($role eq 'cr') { next; }
                   9851:             if ($role =~ /^cr/) {
                   9852:                 $$rolehash{$role} = (split('/',$role))[3];
                   9853:             } else {
                   9854:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   9855:             }
                   9856:         }
                   9857:         foreach my $key (sort(keys(%{$rolehash}))) {
                   9858:             push(@{$allroles},$key);
                   9859:         }
                   9860:         push (@{$allroles},'st');
                   9861:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   9862:     }
                   9863:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   9864: }
                   9865: 
1.555     raeburn  9866: sub user_picker {
1.1075.2.127  raeburn  9867:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  9868:     my $currdom = $dom;
1.1075.2.114  raeburn  9869:     my @alldoms = &Apache::lonnet::all_domains();
                   9870:     if (@alldoms == 1) {
                   9871:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   9872:                                                ['directorysrch'],$alldoms[0]);
                   9873:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   9874:         my $showdom = $domdesc;
                   9875:         if ($showdom eq '') {
                   9876:             $showdom = $dom;
                   9877:         }
                   9878:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   9879:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   9880:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   9881:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   9882:             }
                   9883:         }
                   9884:     }
1.555     raeburn  9885:     my %curr_selected = (
                   9886:                         srchin => 'dom',
1.580     raeburn  9887:                         srchby => 'lastname',
1.555     raeburn  9888:                       );
                   9889:     my $srchterm;
1.625     raeburn  9890:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  9891:         if ($srch->{'srchby'} ne '') {
                   9892:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   9893:         }
                   9894:         if ($srch->{'srchin'} ne '') {
                   9895:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   9896:         }
                   9897:         if ($srch->{'srchtype'} ne '') {
                   9898:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   9899:         }
                   9900:         if ($srch->{'srchdomain'} ne '') {
                   9901:             $currdom = $srch->{'srchdomain'};
                   9902:         }
                   9903:         $srchterm = $srch->{'srchterm'};
                   9904:     }
1.1075.2.98  raeburn  9905:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  9906:                     'usr'       => 'Search criteria',
1.563     raeburn  9907:                     'doma'      => 'Domain/institution to search',
1.558     albertel 9908:                     'uname'     => 'username',
                   9909:                     'lastname'  => 'last name',
1.555     raeburn  9910:                     'lastfirst' => 'last name, first name',
1.558     albertel 9911:                     'crs'       => 'in this course',
1.576     raeburn  9912:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 9913:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  9914:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 9915:                     'exact'     => 'is',
                   9916:                     'contains'  => 'contains',
1.569     raeburn  9917:                     'begins'    => 'begins with',
1.1075.2.98  raeburn  9918:                                        );
                   9919:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  9920:                     'youm'      => "You must include some text to search for.",
                   9921:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   9922:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   9923:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   9924:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   9925:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   9926:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   9927:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  9928:                                        );
1.1075.2.98  raeburn  9929:     &html_escape(\%html_lt);
                   9930:     &js_escape(\%js_lt);
1.1075.2.115  raeburn  9931:     my $domform;
1.1075.2.126  raeburn  9932:     my $allow_blank = 1;
1.1075.2.115  raeburn  9933:     if ($fixeddom) {
1.1075.2.126  raeburn  9934:         $allow_blank = 0;
                   9935:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1075.2.115  raeburn  9936:     } else {
1.1075.2.126  raeburn  9937:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1);
1.1075.2.115  raeburn  9938:     }
1.563     raeburn  9939:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  9940: 
                   9941:     my @srchins = ('crs','dom','alc','instd');
                   9942: 
                   9943:     foreach my $option (@srchins) {
                   9944:         # FIXME 'alc' option unavailable until 
                   9945:         #       loncreateuser::print_user_query_page()
                   9946:         #       has been completed.
                   9947:         next if ($option eq 'alc');
1.880     raeburn  9948:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  9949:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1075.2.127  raeburn  9950:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  9951:         if ($curr_selected{'srchin'} eq $option) {
                   9952:             $srchinsel .= ' 
1.1075.2.98  raeburn  9953:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  9954:         } else {
                   9955:             $srchinsel .= '
1.1075.2.98  raeburn  9956:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  9957:         }
1.555     raeburn  9958:     }
1.563     raeburn  9959:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  9960: 
                   9961:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  9962:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  9963:         if ($curr_selected{'srchby'} eq $option) {
                   9964:             $srchbysel .= '
1.1075.2.98  raeburn  9965:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  9966:         } else {
                   9967:             $srchbysel .= '
1.1075.2.98  raeburn  9968:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  9969:          }
                   9970:     }
                   9971:     $srchbysel .= "\n  </select>\n";
                   9972: 
                   9973:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  9974:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  9975:         if ($curr_selected{'srchtype'} eq $option) {
                   9976:             $srchtypesel .= '
1.1075.2.98  raeburn  9977:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  9978:         } else {
                   9979:             $srchtypesel .= '
1.1075.2.98  raeburn  9980:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  9981:         }
                   9982:     }
                   9983:     $srchtypesel .= "\n  </select>\n";
                   9984: 
1.558     albertel 9985:     my ($newuserscript,$new_user_create);
1.994     raeburn  9986:     my $context_dom = $env{'request.role.domain'};
                   9987:     if ($context eq 'requestcrs') {
                   9988:         if ($env{'form.coursedom'} ne '') { 
                   9989:             $context_dom = $env{'form.coursedom'};
                   9990:         }
                   9991:     }
1.556     raeburn  9992:     if ($forcenewuser) {
1.576     raeburn  9993:         if (ref($srch) eq 'HASH') {
1.994     raeburn  9994:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  9995:                 if ($cancreate) {
                   9996:                     $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>';
                   9997:                 } else {
1.799     bisitz   9998:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  9999:                     my %usertypetext = (
                   10000:                         official   => 'institutional',
                   10001:                         unofficial => 'non-institutional',
                   10002:                     );
1.799     bisitz   10003:                     $new_user_create = '<p class="LC_warning">'
                   10004:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   10005:                                       .' '
                   10006:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   10007:                                           ,'<a href="'.$helplink.'">','</a>')
                   10008:                                       .'</p><br />';
1.627     raeburn  10009:                 }
1.576     raeburn  10010:             }
                   10011:         }
                   10012: 
1.556     raeburn  10013:         $newuserscript = <<"ENDSCRIPT";
                   10014: 
1.570     raeburn  10015: function setSearch(createnew,callingForm) {
1.556     raeburn  10016:     if (createnew == 1) {
1.570     raeburn  10017:         for (var i=0; i<callingForm.srchby.length; i++) {
                   10018:             if (callingForm.srchby.options[i].value == 'uname') {
                   10019:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  10020:             }
                   10021:         }
1.570     raeburn  10022:         for (var i=0; i<callingForm.srchin.length; i++) {
                   10023:             if ( callingForm.srchin.options[i].value == 'dom') {
                   10024: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  10025:             }
                   10026:         }
1.570     raeburn  10027:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   10028:             if (callingForm.srchtype.options[i].value == 'exact') {
                   10029:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  10030:             }
                   10031:         }
1.570     raeburn  10032:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  10033:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  10034:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  10035:             }
                   10036:         }
                   10037:     }
                   10038: }
                   10039: ENDSCRIPT
1.558     albertel 10040: 
1.556     raeburn  10041:     }
                   10042: 
1.555     raeburn  10043:     my $output = <<"END_BLOCK";
1.556     raeburn  10044: <script type="text/javascript">
1.824     bisitz   10045: // <![CDATA[
1.570     raeburn  10046: function validateEntry(callingForm) {
1.558     albertel 10047: 
1.556     raeburn  10048:     var checkok = 1;
1.558     albertel 10049:     var srchin;
1.570     raeburn  10050:     for (var i=0; i<callingForm.srchin.length; i++) {
                   10051: 	if ( callingForm.srchin[i].checked ) {
                   10052: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 10053: 	}
                   10054:     }
                   10055: 
1.570     raeburn  10056:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   10057:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   10058:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   10059:     var srchterm =  callingForm.srchterm.value;
                   10060:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  10061:     var msg = "";
                   10062: 
                   10063:     if (srchterm == "") {
                   10064:         checkok = 0;
1.1075.2.98  raeburn  10065:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  10066:     }
                   10067: 
1.569     raeburn  10068:     if (srchtype== 'begins') {
                   10069:         if (srchterm.length < 2) {
                   10070:             checkok = 0;
1.1075.2.98  raeburn  10071:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  10072:         }
                   10073:     }
                   10074: 
1.556     raeburn  10075:     if (srchtype== 'contains') {
                   10076:         if (srchterm.length < 3) {
                   10077:             checkok = 0;
1.1075.2.98  raeburn  10078:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  10079:         }
                   10080:     }
                   10081:     if (srchin == 'instd') {
                   10082:         if (srchdomain == '') {
                   10083:             checkok = 0;
1.1075.2.98  raeburn  10084:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  10085:         }
                   10086:     }
                   10087:     if (srchin == 'dom') {
                   10088:         if (srchdomain == '') {
                   10089:             checkok = 0;
1.1075.2.98  raeburn  10090:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  10091:         }
                   10092:     }
                   10093:     if (srchby == 'lastfirst') {
                   10094:         if (srchterm.indexOf(",") == -1) {
                   10095:             checkok = 0;
1.1075.2.98  raeburn  10096:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  10097:         }
                   10098:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   10099:             checkok = 0;
1.1075.2.98  raeburn  10100:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  10101:         }
                   10102:     }
                   10103:     if (checkok == 0) {
1.1075.2.98  raeburn  10104:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  10105:         return;
                   10106:     }
                   10107:     if (checkok == 1) {
1.570     raeburn  10108:         callingForm.submit();
1.556     raeburn  10109:     }
                   10110: }
                   10111: 
                   10112: $newuserscript
                   10113: 
1.824     bisitz   10114: // ]]>
1.556     raeburn  10115: </script>
1.558     albertel 10116: 
                   10117: $new_user_create
                   10118: 
1.555     raeburn  10119: END_BLOCK
1.558     albertel 10120: 
1.876     raeburn  10121:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1075.2.98  raeburn  10122:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  10123:                $domform.
                   10124:                &Apache::lonhtmlcommon::row_closure().
1.1075.2.98  raeburn  10125:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  10126:                $srchbysel.
                   10127:                $srchtypesel. 
                   10128:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   10129:                $srchinsel.
                   10130:                &Apache::lonhtmlcommon::row_closure(1). 
                   10131:                &Apache::lonhtmlcommon::end_pick_box().
                   10132:                '<br />';
1.1075.2.114  raeburn  10133:     return ($output,1);
1.555     raeburn  10134: }
                   10135: 
1.612     raeburn  10136: sub user_rule_check {
1.615     raeburn  10137:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1075.2.99  raeburn  10138:     my ($response,%inst_response);
1.612     raeburn  10139:     if (ref($usershash) eq 'HASH') {
1.1075.2.99  raeburn  10140:         if (keys(%{$usershash}) > 1) {
                   10141:             my (%by_username,%by_id,%userdoms);
                   10142:             my $checkid;
1.612     raeburn  10143:             if (ref($checks) eq 'HASH') {
1.1075.2.99  raeburn  10144:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   10145:                     $checkid = 1;
                   10146:                 }
                   10147:             }
                   10148:             foreach my $user (keys(%{$usershash})) {
                   10149:                 my ($uname,$udom) = split(/:/,$user);
                   10150:                 if ($checkid) {
                   10151:                     if (ref($usershash->{$user}) eq 'HASH') {
                   10152:                         if ($usershash->{$user}->{'id'} ne '') {
                   10153:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
                   10154:                             $userdoms{$udom} = 1;
                   10155:                             if (ref($inst_results) eq 'HASH') {
                   10156:                                 $inst_results->{$uname.':'.$udom} = {};
                   10157:                             }
                   10158:                         }
                   10159:                     }
                   10160:                 } else {
                   10161:                     $by_username{$udom}{$uname} = 1;
                   10162:                     $userdoms{$udom} = 1;
                   10163:                     if (ref($inst_results) eq 'HASH') {
                   10164:                         $inst_results->{$uname.':'.$udom} = {};
                   10165:                     }
                   10166:                 }
                   10167:             }
                   10168:             foreach my $udom (keys(%userdoms)) {
                   10169:                 if (!$got_rules->{$udom}) {
                   10170:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10171:                                                              ['usercreation'],$udom);
                   10172:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10173:                         foreach my $item ('username','id') {
                   10174:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10175:                                 $$curr_rules{$udom}{$item} =
                   10176:                                     $domconfig{'usercreation'}{$item.'_rule'};
                   10177:                             }
                   10178:                         }
                   10179:                     }
                   10180:                     $got_rules->{$udom} = 1;
                   10181:                 }
                   10182:             }
                   10183:             if ($checkid) {
                   10184:                 foreach my $udom (keys(%by_id)) {
                   10185:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   10186:                     if ($outcome eq 'ok') {
                   10187:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   10188:                             my $uname = $by_id{$udom}{$id};
                   10189:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10190:                         }
                   10191:                         if (ref($results) eq 'HASH') {
                   10192:                             foreach my $uname (keys(%{$results})) {
                   10193:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   10194:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   10195:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10196:                                 }
                   10197:                             }
                   10198:                         }
                   10199:                     }
1.612     raeburn  10200:                 }
1.615     raeburn  10201:             } else {
1.1075.2.99  raeburn  10202:                 foreach my $udom (keys(%by_username)) {
                   10203:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   10204:                     if ($outcome eq 'ok') {
                   10205:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   10206:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10207:                         }
                   10208:                         if (ref($results) eq 'HASH') {
                   10209:                             foreach my $uname (keys(%{$results})) {
                   10210:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10211:                             }
                   10212:                         }
                   10213:                     }
                   10214:                 }
1.612     raeburn  10215:             }
1.1075.2.99  raeburn  10216:         } elsif (keys(%{$usershash}) == 1) {
                   10217:             my $user = (keys(%{$usershash}))[0];
                   10218:             my ($uname,$udom) = split(/:/,$user);
                   10219:             if (($udom ne '') && ($uname ne '')) {
                   10220:                 if (ref($usershash->{$user}) eq 'HASH') {
                   10221:                     if (ref($checks) eq 'HASH') {
                   10222:                         if (defined($checks->{'username'})) {
                   10223:                             ($inst_response{$user},%{$inst_results->{$user}}) =
                   10224:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   10225:                         } elsif (defined($checks->{'id'})) {
                   10226:                             if ($usershash->{$user}->{'id'} ne '') {
                   10227:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10228:                                     &Apache::lonnet::get_instuser($udom,undef,
                   10229:                                                                   $usershash->{$user}->{'id'});
                   10230:                             } else {
                   10231:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10232:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   10233:                             }
                   10234:                         }
                   10235:                     } else {
                   10236:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   10237:                             &Apache::lonnet::get_instuser($udom,$uname);
                   10238:                        return;
                   10239:                     }
                   10240:                     if (!$got_rules->{$udom}) {
                   10241:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10242:                                                                  ['usercreation'],$udom);
                   10243:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10244:                             foreach my $item ('username','id') {
                   10245:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10246:                                    $$curr_rules{$udom}{$item} =
                   10247:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   10248:                                 }
                   10249:                             }
1.585     raeburn  10250:                         }
1.1075.2.99  raeburn  10251:                         $got_rules->{$udom} = 1;
1.585     raeburn  10252:                     }
                   10253:                 }
1.1075.2.99  raeburn  10254:             } else {
                   10255:                 return;
                   10256:             }
                   10257:         } else {
                   10258:             return;
                   10259:         }
                   10260:         foreach my $user (keys(%{$usershash})) {
                   10261:             my ($uname,$udom) = split(/:/,$user);
                   10262:             next if (($udom eq '') || ($uname eq ''));
                   10263:             my $id;
                   10264:             if (ref($inst_results) eq 'HASH') {
                   10265:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   10266:                     $id = $inst_results->{$user}->{'id'};
                   10267:                 }
                   10268:             }
                   10269:             if ($id eq '') {
                   10270:                 if (ref($usershash->{$user})) {
                   10271:                     $id = $usershash->{$user}->{'id'};
                   10272:                 }
1.585     raeburn  10273:             }
1.612     raeburn  10274:             foreach my $item (keys(%{$checks})) {
                   10275:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   10276:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   10277:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1075.2.99  raeburn  10278:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   10279:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  10280:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   10281:                                 if ($rule_check{$rule}) {
                   10282:                                     $$rulematch{$user}{$item} = $rule;
1.1075.2.99  raeburn  10283:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  10284:                                         if (ref($inst_results) eq 'HASH') {
                   10285:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   10286:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   10287:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1075.2.99  raeburn  10288:                                                 } elsif ($item eq 'id') {
                   10289:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   10290:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   10291:                                                     }
1.615     raeburn  10292:                                                 }
1.612     raeburn  10293:                                             }
                   10294:                                         }
1.615     raeburn  10295:                                     }
                   10296:                                     last;
1.585     raeburn  10297:                                 }
                   10298:                             }
                   10299:                         }
                   10300:                     }
                   10301:                 }
                   10302:             }
                   10303:         }
                   10304:     }
1.612     raeburn  10305:     return;
                   10306: }
                   10307: 
                   10308: sub user_rule_formats {
                   10309:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   10310:     my %text = ( 
                   10311:                  'username' => 'Usernames',
                   10312:                  'id'       => 'IDs',
                   10313:                );
                   10314:     my $output;
                   10315:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   10316:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   10317:         if (@{$ruleorder} > 0) {
1.1075.2.20  raeburn  10318:             $output = '<br />'.
                   10319:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   10320:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   10321:                       ' <ul>';
1.612     raeburn  10322:             foreach my $rule (@{$ruleorder}) {
                   10323:                 if (ref($curr_rules) eq 'ARRAY') {
                   10324:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   10325:                         if (ref($rules->{$rule}) eq 'HASH') {
                   10326:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   10327:                                         $rules->{$rule}{'desc'}.'</li>';
                   10328:                         }
                   10329:                     }
                   10330:                 }
                   10331:             }
                   10332:             $output .= '</ul>';
                   10333:         }
                   10334:     }
                   10335:     return $output;
                   10336: }
                   10337: 
                   10338: sub instrule_disallow_msg {
1.615     raeburn  10339:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  10340:     my $response;
                   10341:     my %text = (
                   10342:                   item   => 'username',
                   10343:                   items  => 'usernames',
                   10344:                   match  => 'matches',
                   10345:                   do     => 'does',
                   10346:                   action => 'a username',
                   10347:                   one    => 'one',
                   10348:                );
                   10349:     if ($count > 1) {
                   10350:         $text{'item'} = 'usernames';
                   10351:         $text{'match'} ='match';
                   10352:         $text{'do'} = 'do';
                   10353:         $text{'action'} = 'usernames',
                   10354:         $text{'one'} = 'ones';
                   10355:     }
                   10356:     if ($checkitem eq 'id') {
                   10357:         $text{'items'} = 'IDs';
                   10358:         $text{'item'} = 'ID';
                   10359:         $text{'action'} = 'an ID';
1.615     raeburn  10360:         if ($count > 1) {
                   10361:             $text{'item'} = 'IDs';
                   10362:             $text{'action'} = 'IDs';
                   10363:         }
1.612     raeburn  10364:     }
1.674     bisitz   10365:     $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  10366:     if ($mode eq 'upload') {
                   10367:         if ($checkitem eq 'username') {
                   10368:             $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'}.");
                   10369:         } elsif ($checkitem eq 'id') {
1.674     bisitz   10370:             $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  10371:         }
1.669     raeburn  10372:     } elsif ($mode eq 'selfcreate') {
                   10373:         if ($checkitem eq 'id') {
                   10374:             $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.");
                   10375:         }
1.615     raeburn  10376:     } else {
                   10377:         if ($checkitem eq 'username') {
                   10378:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   10379:         } elsif ($checkitem eq 'id') {
                   10380:             $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.");
                   10381:         }
1.612     raeburn  10382:     }
                   10383:     return $response;
1.585     raeburn  10384: }
                   10385: 
1.624     raeburn  10386: sub personal_data_fieldtitles {
                   10387:     my %fieldtitles = &Apache::lonlocal::texthash (
                   10388:                         id => 'Student/Employee ID',
                   10389:                         permanentemail => 'E-mail address',
                   10390:                         lastname => 'Last Name',
                   10391:                         firstname => 'First Name',
                   10392:                         middlename => 'Middle Name',
                   10393:                         generation => 'Generation',
                   10394:                         gen => 'Generation',
1.765     raeburn  10395:                         inststatus => 'Affiliation',
1.624     raeburn  10396:                    );
                   10397:     return %fieldtitles;
                   10398: }
                   10399: 
1.642     raeburn  10400: sub sorted_inst_types {
                   10401:     my ($dom) = @_;
1.1075.2.70  raeburn  10402:     my ($usertypes,$order);
                   10403:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   10404:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   10405:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   10406:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   10407:     } else {
                   10408:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   10409:     }
1.642     raeburn  10410:     my $othertitle = &mt('All users');
                   10411:     if ($env{'request.course.id'}) {
1.668     raeburn  10412:         $othertitle  = &mt('Any users');
1.642     raeburn  10413:     }
                   10414:     my @types;
                   10415:     if (ref($order) eq 'ARRAY') {
                   10416:         @types = @{$order};
                   10417:     }
                   10418:     if (@types == 0) {
                   10419:         if (ref($usertypes) eq 'HASH') {
                   10420:             @types = sort(keys(%{$usertypes}));
                   10421:         }
                   10422:     }
                   10423:     if (keys(%{$usertypes}) > 0) {
                   10424:         $othertitle = &mt('Other users');
                   10425:     }
                   10426:     return ($othertitle,$usertypes,\@types);
                   10427: }
                   10428: 
1.645     raeburn  10429: sub get_institutional_codes {
1.1075.2.156! raeburn  10430:     my ($settings,$allcourses,$LC_code) = @_;
1.645     raeburn  10431: # Get complete list of course sections to update
                   10432:     my @currsections = ();
                   10433:     my @currxlists = ();
                   10434:     my $coursecode = $$settings{'internal.coursecode'};
                   10435: 
                   10436:     if ($$settings{'internal.sectionnums'} ne '') {
                   10437:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   10438:     }
                   10439: 
                   10440:     if ($$settings{'internal.crosslistings'} ne '') {
                   10441:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   10442:     }
                   10443: 
                   10444:     if (@currxlists > 0) {
1.1075.2.156! raeburn  10445:         foreach (@currxlists) {
        !          10446:             if (m/^([^:]+):(\w*)$/) {
1.645     raeburn  10447:                 unless (grep/^$1$/,@{$allcourses}) {
1.1075.2.119  raeburn  10448:                     push(@{$allcourses},$1);
1.645     raeburn  10449:                     $$LC_code{$1} = $2;
                   10450:                 }
                   10451:             }
                   10452:         }
                   10453:     }
1.1075.2.156! raeburn  10454:  
1.645     raeburn  10455:     if (@currsections > 0) {
1.1075.2.156! raeburn  10456:         foreach (@currsections) {
        !          10457:             if (m/^(\w+):(\w*)$/) {
        !          10458:                 my $sec = $coursecode.$1;
1.645     raeburn  10459:                 my $lc_sec = $2;
1.1075.2.156! raeburn  10460:                 unless (grep/^$sec$/,@{$allcourses}) {
1.1075.2.119  raeburn  10461:                     push(@{$allcourses},$sec);
1.1075.2.156! raeburn  10462:                     $$LC_code{$sec} = $lc_sec;
1.645     raeburn  10463:                 }
                   10464:             }
                   10465:         }
                   10466:     }
                   10467:     return;
                   10468: }
                   10469: 
1.971     raeburn  10470: sub get_standard_codeitems {
                   10471:     return ('Year','Semester','Department','Number','Section');
                   10472: }
                   10473: 
1.112     bowersj2 10474: =pod
                   10475: 
1.780     raeburn  10476: =head1 Slot Helpers
                   10477: 
                   10478: =over 4
                   10479: 
                   10480: =item * sorted_slots()
                   10481: 
1.1040    raeburn  10482: Sorts an array of slot names in order of an optional sort key,
                   10483: default sort is by slot start time (earliest first). 
1.780     raeburn  10484: 
                   10485: Inputs:
                   10486: 
                   10487: =over 4
                   10488: 
                   10489: slotsarr  - Reference to array of unsorted slot names.
                   10490: 
                   10491: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   10492: 
1.1040    raeburn  10493: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   10494: 
1.549     albertel 10495: =back
                   10496: 
1.780     raeburn  10497: Returns:
                   10498: 
                   10499: =over 4
                   10500: 
1.1040    raeburn  10501: sorted   - An array of slot names sorted by a specified sort key 
                   10502:            (default sort key is start time of the slot).
1.780     raeburn  10503: 
                   10504: =back
                   10505: 
                   10506: =cut
                   10507: 
                   10508: 
                   10509: sub sorted_slots {
1.1040    raeburn  10510:     my ($slotsarr,$slots,$sortkey) = @_;
                   10511:     if ($sortkey eq '') {
                   10512:         $sortkey = 'starttime';
                   10513:     }
1.780     raeburn  10514:     my @sorted;
                   10515:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   10516:         @sorted =
                   10517:             sort {
                   10518:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  10519:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  10520:                      }
                   10521:                      if (ref($slots->{$a})) { return -1;}
                   10522:                      if (ref($slots->{$b})) { return 1;}
                   10523:                      return 0;
                   10524:                  } @{$slotsarr};
                   10525:     }
                   10526:     return @sorted;
                   10527: }
                   10528: 
1.1040    raeburn  10529: =pod
                   10530: 
                   10531: =item * get_future_slots()
                   10532: 
                   10533: Inputs:
                   10534: 
                   10535: =over 4
                   10536: 
                   10537: cnum - course number
                   10538: 
                   10539: cdom - course domain
                   10540: 
                   10541: now - current UNIX time
                   10542: 
                   10543: symb - optional symb
                   10544: 
                   10545: =back
                   10546: 
                   10547: Returns:
                   10548: 
                   10549: =over 4
                   10550: 
                   10551: sorted_reservable - ref to array of student_schedulable slots currently 
                   10552:                     reservable, ordered by end date of reservation period.
                   10553: 
                   10554: reservable_now - ref to hash of student_schedulable slots currently
                   10555:                  reservable.
                   10556: 
                   10557:     Keys in inner hash are:
                   10558:     (a) symb: either blank or symb to which slot use is restricted.
1.1075.2.104  raeburn  10559:     (b) endreserve: end date of reservation period.
                   10560:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10561:         selected.
1.1040    raeburn  10562: 
                   10563: sorted_future - ref to array of student_schedulable slots reservable in
                   10564:                 the future, ordered by start date of reservation period.
                   10565: 
                   10566: future_reservable - ref to hash of student_schedulable slots reservable
                   10567:                     in the future.
                   10568: 
                   10569:     Keys in inner hash are:
                   10570:     (a) symb: either blank or symb to which slot use is restricted.
                   10571:     (b) startreserve:  start date of reservation period.
1.1075.2.104  raeburn  10572:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10573:         selected.
1.1040    raeburn  10574: 
                   10575: =back
                   10576: 
                   10577: =cut
                   10578: 
                   10579: sub get_future_slots {
                   10580:     my ($cnum,$cdom,$now,$symb) = @_;
                   10581:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   10582:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   10583:     foreach my $slot (keys(%slots)) {
                   10584:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   10585:         if ($symb) {
                   10586:             next if (($slots{$slot}->{'symb'} ne '') && 
                   10587:                      ($slots{$slot}->{'symb'} ne $symb));
                   10588:         }
                   10589:         if (($slots{$slot}->{'starttime'} > $now) &&
                   10590:             ($slots{$slot}->{'endtime'} > $now)) {
                   10591:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   10592:                 my $userallowed = 0;
                   10593:                 if ($slots{$slot}->{'allowedsections'}) {
                   10594:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   10595:                     if (!defined($env{'request.role.sec'})
                   10596:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   10597:                         $userallowed=1;
                   10598:                     } else {
                   10599:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   10600:                             $userallowed=1;
                   10601:                         }
                   10602:                     }
                   10603:                     unless ($userallowed) {
                   10604:                         if (defined($env{'request.course.groups'})) {
                   10605:                             my @groups = split(/:/,$env{'request.course.groups'});
                   10606:                             foreach my $group (@groups) {
                   10607:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   10608:                                     $userallowed=1;
                   10609:                                     last;
                   10610:                                 }
                   10611:                             }
                   10612:                         }
                   10613:                     }
                   10614:                 }
                   10615:                 if ($slots{$slot}->{'allowedusers'}) {
                   10616:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   10617:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   10618:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   10619:                         $userallowed = 1;
                   10620:                     }
                   10621:                 }
                   10622:                 next unless($userallowed);
                   10623:             }
                   10624:             my $startreserve = $slots{$slot}->{'startreserve'};
                   10625:             my $endreserve = $slots{$slot}->{'endreserve'};
                   10626:             my $symb = $slots{$slot}->{'symb'};
1.1075.2.104  raeburn  10627:             my $uniqueperiod;
                   10628:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   10629:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   10630:             }
1.1040    raeburn  10631:             if (($startreserve < $now) &&
                   10632:                 (!$endreserve || $endreserve > $now)) {
                   10633:                 my $lastres = $endreserve;
                   10634:                 if (!$lastres) {
                   10635:                     $lastres = $slots{$slot}->{'starttime'};
                   10636:                 }
                   10637:                 $reservable_now{$slot} = {
                   10638:                                            symb       => $symb,
1.1075.2.104  raeburn  10639:                                            endreserve => $lastres,
                   10640:                                            uniqueperiod => $uniqueperiod,   
1.1040    raeburn  10641:                                          };
                   10642:             } elsif (($startreserve > $now) &&
                   10643:                      (!$endreserve || $endreserve > $startreserve)) {
                   10644:                 $future_reservable{$slot} = {
                   10645:                                               symb         => $symb,
1.1075.2.104  raeburn  10646:                                               startreserve => $startreserve,
                   10647:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  10648:                                             };
                   10649:             }
                   10650:         }
                   10651:     }
                   10652:     my @unsorted_reservable = keys(%reservable_now);
                   10653:     if (@unsorted_reservable > 0) {
                   10654:         @sorted_reservable = 
                   10655:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   10656:     }
                   10657:     my @unsorted_future = keys(%future_reservable);
                   10658:     if (@unsorted_future > 0) {
                   10659:         @sorted_future =
                   10660:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   10661:     }
                   10662:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   10663: }
1.780     raeburn  10664: 
                   10665: =pod
                   10666: 
1.1057    foxr     10667: =back
                   10668: 
1.549     albertel 10669: =head1 HTTP Helpers
                   10670: 
                   10671: =over 4
                   10672: 
1.648     raeburn  10673: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 10674: 
1.258     albertel 10675: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 10676: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 10677: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 10678: 
                   10679: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   10680: $possible_names is an ref to an array of form element names.  As an example:
                   10681: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 10682: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 10683: 
                   10684: =cut
1.1       albertel 10685: 
1.6       albertel 10686: sub get_unprocessed_cgi {
1.25      albertel 10687:   my ($query,$possible_names)= @_;
1.26      matthew  10688:   # $Apache::lonxml::debug=1;
1.356     albertel 10689:   foreach my $pair (split(/&/,$query)) {
                   10690:     my ($name, $value) = split(/=/,$pair);
1.369     www      10691:     $name = &unescape($name);
1.25      albertel 10692:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   10693:       $value =~ tr/+/ /;
                   10694:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 10695:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 10696:     }
1.16      harris41 10697:   }
1.6       albertel 10698: }
                   10699: 
1.112     bowersj2 10700: =pod
                   10701: 
1.648     raeburn  10702: =item * &cacheheader() 
1.112     bowersj2 10703: 
                   10704: returns cache-controlling header code
                   10705: 
                   10706: =cut
                   10707: 
1.7       albertel 10708: sub cacheheader {
1.258     albertel 10709:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 10710:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   10711:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 10712:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   10713:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 10714:     return $output;
1.7       albertel 10715: }
                   10716: 
1.112     bowersj2 10717: =pod
                   10718: 
1.648     raeburn  10719: =item * &no_cache($r) 
1.112     bowersj2 10720: 
                   10721: specifies header code to not have cache
                   10722: 
                   10723: =cut
                   10724: 
1.9       albertel 10725: sub no_cache {
1.216     albertel 10726:     my ($r) = @_;
                   10727:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 10728: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 10729:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   10730:     $r->no_cache(1);
                   10731:     $r->header_out("Expires" => $date);
                   10732:     $r->header_out("Pragma" => "no-cache");
1.123     www      10733: }
                   10734: 
                   10735: sub content_type {
1.181     albertel 10736:     my ($r,$type,$charset) = @_;
1.299     foxr     10737:     if ($r) {
                   10738: 	#  Note that printout.pl calls this with undef for $r.
                   10739: 	&no_cache($r);
                   10740:     }
1.258     albertel 10741:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 10742:     unless ($charset) {
                   10743: 	$charset=&Apache::lonlocal::current_encoding;
                   10744:     }
                   10745:     if ($charset) { $type.='; charset='.$charset; }
                   10746:     if ($r) {
                   10747: 	$r->content_type($type);
                   10748:     } else {
                   10749: 	print("Content-type: $type\n\n");
                   10750:     }
1.9       albertel 10751: }
1.25      albertel 10752: 
1.112     bowersj2 10753: =pod
                   10754: 
1.648     raeburn  10755: =item * &add_to_env($name,$value) 
1.112     bowersj2 10756: 
1.258     albertel 10757: adds $name to the %env hash with value
1.112     bowersj2 10758: $value, if $name already exists, the entry is converted to an array
                   10759: reference and $value is added to the array.
                   10760: 
                   10761: =cut
                   10762: 
1.25      albertel 10763: sub add_to_env {
                   10764:   my ($name,$value)=@_;
1.258     albertel 10765:   if (defined($env{$name})) {
                   10766:     if (ref($env{$name})) {
1.25      albertel 10767:       #already have multiple values
1.258     albertel 10768:       push(@{ $env{$name} },$value);
1.25      albertel 10769:     } else {
                   10770:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 10771:       my $first=$env{$name};
                   10772:       undef($env{$name});
                   10773:       push(@{ $env{$name} },$first,$value);
1.25      albertel 10774:     }
                   10775:   } else {
1.258     albertel 10776:     $env{$name}=$value;
1.25      albertel 10777:   }
1.31      albertel 10778: }
1.149     albertel 10779: 
                   10780: =pod
                   10781: 
1.648     raeburn  10782: =item * &get_env_multiple($name) 
1.149     albertel 10783: 
1.258     albertel 10784: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 10785: values may be defined and end up as an array ref.
                   10786: 
                   10787: returns an array of values
                   10788: 
                   10789: =cut
                   10790: 
                   10791: sub get_env_multiple {
                   10792:     my ($name) = @_;
                   10793:     my @values;
1.258     albertel 10794:     if (defined($env{$name})) {
1.149     albertel 10795:         # exists is it an array
1.258     albertel 10796:         if (ref($env{$name})) {
                   10797:             @values=@{ $env{$name} };
1.149     albertel 10798:         } else {
1.258     albertel 10799:             $values[0]=$env{$name};
1.149     albertel 10800:         }
                   10801:     }
                   10802:     return(@values);
                   10803: }
                   10804: 
1.660     raeburn  10805: sub ask_for_embedded_content {
                   10806:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  10807:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11  raeburn  10808:         %currsubfile,%unused,$rem);
1.1071    raeburn  10809:     my $counter = 0;
                   10810:     my $numnew = 0;
1.987     raeburn  10811:     my $numremref = 0;
                   10812:     my $numinvalid = 0;
                   10813:     my $numpathchg = 0;
                   10814:     my $numexisting = 0;
1.1071    raeburn  10815:     my $numunused = 0;
                   10816:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1075.2.53  raeburn  10817:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  10818:     my $heading = &mt('Upload embedded files');
                   10819:     my $buttontext = &mt('Upload');
                   10820: 
1.1075.2.11  raeburn  10821:     if ($env{'request.course.id'}) {
1.1075.2.35  raeburn  10822:         if ($actionurl eq '/adm/dependencies') {
                   10823:             $navmap = Apache::lonnavmaps::navmap->new();
                   10824:         }
                   10825:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10826:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11  raeburn  10827:     }
1.1075.2.35  raeburn  10828:     if (($actionurl eq '/adm/portfolio') ||
                   10829:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  10830:         my $current_path='/';
                   10831:         if ($env{'form.currentpath'}) {
                   10832:             $current_path = $env{'form.currentpath'};
                   10833:         }
                   10834:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35  raeburn  10835:             $udom = $cdom;
                   10836:             $uname = $cnum;
1.984     raeburn  10837:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   10838:         } else {
                   10839:             $udom = $env{'user.domain'};
                   10840:             $uname = $env{'user.name'};
                   10841:             $url = '/userfiles/portfolio';
                   10842:         }
1.987     raeburn  10843:         $toplevel = $url.'/';
1.984     raeburn  10844:         $url .= $current_path;
                   10845:         $getpropath = 1;
1.987     raeburn  10846:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   10847:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      10848:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  10849:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  10850:         $toplevel = $url;
1.984     raeburn  10851:         if ($rest ne '') {
1.987     raeburn  10852:             $url .= $rest;
                   10853:         }
                   10854:     } elsif ($actionurl eq '/adm/coursedocs') {
                   10855:         if (ref($args) eq 'HASH') {
1.1071    raeburn  10856:             $url = $args->{'docs_url'};
                   10857:             $toplevel = $url;
1.1075.2.11  raeburn  10858:             if ($args->{'context'} eq 'paste') {
                   10859:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   10860:                 ($path) =
                   10861:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   10862:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   10863:                 $fileloc =~ s{^/}{};
                   10864:             }
1.1071    raeburn  10865:         }
                   10866:     } elsif ($actionurl eq '/adm/dependencies') {
                   10867:         if ($env{'request.course.id'} ne '') {
                   10868:             if (ref($args) eq 'HASH') {
                   10869:                 $url = $args->{'docs_url'};
                   10870:                 $title = $args->{'docs_title'};
1.1075.2.35  raeburn  10871:                 $toplevel = $url;
                   10872:                 unless ($toplevel =~ m{^/}) {
                   10873:                     $toplevel = "/$url";
                   10874:                 }
1.1075.2.11  raeburn  10875:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35  raeburn  10876:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   10877:                     $path = $1;
                   10878:                 } else {
                   10879:                     ($path) =
                   10880:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   10881:                 }
1.1075.2.79  raeburn  10882:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   10883:                     $fileloc = $toplevel;
                   10884:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   10885:                     my ($udom,$uname,$fname) =
                   10886:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   10887:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   10888:                 } else {
                   10889:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   10890:                 }
1.1071    raeburn  10891:                 $fileloc =~ s{^/}{};
                   10892:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   10893:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   10894:             }
1.987     raeburn  10895:         }
1.1075.2.35  raeburn  10896:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   10897:         $udom = $cdom;
                   10898:         $uname = $cnum;
                   10899:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   10900:         $toplevel = $url;
                   10901:         $path = $url;
                   10902:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   10903:         $fileloc =~ s{^/}{};
                   10904:     }
                   10905:     foreach my $file (keys(%{$allfiles})) {
                   10906:         my $embed_file;
                   10907:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   10908:             $embed_file = $1;
                   10909:         } else {
                   10910:             $embed_file = $file;
                   10911:         }
1.1075.2.55  raeburn  10912:         my ($absolutepath,$cleaned_file);
                   10913:         if ($embed_file =~ m{^\w+://}) {
                   10914:             $cleaned_file = $embed_file;
1.1075.2.47  raeburn  10915:             $newfiles{$cleaned_file} = 1;
                   10916:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  10917:         } else {
1.1075.2.55  raeburn  10918:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  10919:             if ($embed_file =~ m{^/}) {
                   10920:                 $absolutepath = $embed_file;
                   10921:             }
1.1075.2.47  raeburn  10922:             if ($cleaned_file =~ m{/}) {
                   10923:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  10924:                 $path = &check_for_traversal($path,$url,$toplevel);
                   10925:                 my $item = $fname;
                   10926:                 if ($path ne '') {
                   10927:                     $item = $path.'/'.$fname;
                   10928:                     $subdependencies{$path}{$fname} = 1;
                   10929:                 } else {
                   10930:                     $dependencies{$item} = 1;
                   10931:                 }
                   10932:                 if ($absolutepath) {
                   10933:                     $mapping{$item} = $absolutepath;
                   10934:                 } else {
                   10935:                     $mapping{$item} = $embed_file;
                   10936:                 }
                   10937:             } else {
                   10938:                 $dependencies{$embed_file} = 1;
                   10939:                 if ($absolutepath) {
1.1075.2.47  raeburn  10940:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  10941:                 } else {
1.1075.2.47  raeburn  10942:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  10943:                 }
                   10944:             }
1.984     raeburn  10945:         }
                   10946:     }
1.1071    raeburn  10947:     my $dirptr = 16384;
1.984     raeburn  10948:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  10949:         $currsubfile{$path} = {};
1.1075.2.35  raeburn  10950:         if (($actionurl eq '/adm/portfolio') ||
                   10951:             ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  10952:             my ($sublistref,$listerror) =
                   10953:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   10954:             if (ref($sublistref) eq 'ARRAY') {
                   10955:                 foreach my $line (@{$sublistref}) {
                   10956:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  10957:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  10958:                 }
1.984     raeburn  10959:             }
1.987     raeburn  10960:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  10961:             if (opendir(my $dir,$url.'/'.$path)) {
                   10962:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  10963:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   10964:             }
1.1075.2.11  raeburn  10965:         } elsif (($actionurl eq '/adm/dependencies') ||
                   10966:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  10967:                   ($args->{'context'} eq 'paste')) ||
                   10968:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  10969:             if ($env{'request.course.id'} ne '') {
1.1075.2.35  raeburn  10970:                 my $dir;
                   10971:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   10972:                     $dir = $fileloc;
                   10973:                 } else {
                   10974:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   10975:                 }
1.1071    raeburn  10976:                 if ($dir ne '') {
                   10977:                     my ($sublistref,$listerror) =
                   10978:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   10979:                     if (ref($sublistref) eq 'ARRAY') {
                   10980:                         foreach my $line (@{$sublistref}) {
                   10981:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   10982:                                 undef,$mtime)=split(/\&/,$line,12);
                   10983:                             unless (($testdir&$dirptr) ||
                   10984:                                     ($file_name =~ /^\.\.?$/)) {
                   10985:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   10986:                             }
                   10987:                         }
                   10988:                     }
                   10989:                 }
1.984     raeburn  10990:             }
                   10991:         }
                   10992:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  10993:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  10994:                 my $item = $path.'/'.$file;
                   10995:                 unless ($mapping{$item} eq $item) {
                   10996:                     $pathchanges{$item} = 1;
                   10997:                 }
                   10998:                 $existing{$item} = 1;
                   10999:                 $numexisting ++;
                   11000:             } else {
                   11001:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  11002:             }
                   11003:         }
1.1071    raeburn  11004:         if ($actionurl eq '/adm/dependencies') {
                   11005:             foreach my $path (keys(%currsubfile)) {
                   11006:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   11007:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   11008:                          unless ($subdependencies{$path}{$file}) {
1.1075.2.11  raeburn  11009:                              next if (($rem ne '') &&
                   11010:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   11011:                                        (ref($navmap) &&
                   11012:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   11013:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11014:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  11015:                              $unused{$path.'/'.$file} = 1; 
                   11016:                          }
                   11017:                     }
                   11018:                 }
                   11019:             }
                   11020:         }
1.984     raeburn  11021:     }
1.987     raeburn  11022:     my %currfile;
1.1075.2.35  raeburn  11023:     if (($actionurl eq '/adm/portfolio') ||
                   11024:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  11025:         my ($dirlistref,$listerror) =
                   11026:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   11027:         if (ref($dirlistref) eq 'ARRAY') {
                   11028:             foreach my $line (@{$dirlistref}) {
                   11029:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   11030:                 $currfile{$file_name} = 1;
                   11031:             }
1.984     raeburn  11032:         }
1.987     raeburn  11033:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11034:         if (opendir(my $dir,$url)) {
1.987     raeburn  11035:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  11036:             map {$currfile{$_} = 1;} @dir_list;
                   11037:         }
1.1075.2.11  raeburn  11038:     } elsif (($actionurl eq '/adm/dependencies') ||
                   11039:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11040:               ($args->{'context'} eq 'paste')) ||
                   11041:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11042:         if ($env{'request.course.id'} ne '') {
                   11043:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11044:             if ($dir ne '') {
                   11045:                 my ($dirlistref,$listerror) =
                   11046:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   11047:                 if (ref($dirlistref) eq 'ARRAY') {
                   11048:                     foreach my $line (@{$dirlistref}) {
                   11049:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   11050:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   11051:                         unless (($testdir&$dirptr) ||
                   11052:                                 ($file_name =~ /^\.\.?$/)) {
                   11053:                             $currfile{$file_name} = [$size,$mtime];
                   11054:                         }
                   11055:                     }
                   11056:                 }
                   11057:             }
                   11058:         }
1.984     raeburn  11059:     }
                   11060:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  11061:         if (exists($currfile{$file})) {
1.987     raeburn  11062:             unless ($mapping{$file} eq $file) {
                   11063:                 $pathchanges{$file} = 1;
                   11064:             }
                   11065:             $existing{$file} = 1;
                   11066:             $numexisting ++;
                   11067:         } else {
1.984     raeburn  11068:             $newfiles{$file} = 1;
                   11069:         }
                   11070:     }
1.1071    raeburn  11071:     foreach my $file (keys(%currfile)) {
                   11072:         unless (($file eq $filename) ||
                   11073:                 ($file eq $filename.'.bak') ||
                   11074:                 ($dependencies{$file})) {
1.1075.2.11  raeburn  11075:             if ($actionurl eq '/adm/dependencies') {
1.1075.2.35  raeburn  11076:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   11077:                     next if (($rem ne '') &&
                   11078:                              (($env{"httpref.$rem".$file} ne '') ||
                   11079:                               (ref($navmap) &&
                   11080:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   11081:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11082:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   11083:                 }
1.1075.2.11  raeburn  11084:             }
1.1071    raeburn  11085:             $unused{$file} = 1;
                   11086:         }
                   11087:     }
1.1075.2.11  raeburn  11088:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   11089:         ($args->{'context'} eq 'paste')) {
                   11090:         $counter = scalar(keys(%existing));
                   11091:         $numpathchg = scalar(keys(%pathchanges));
                   11092:         return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35  raeburn  11093:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
                   11094:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   11095:         $counter = scalar(keys(%existing));
                   11096:         $numpathchg = scalar(keys(%pathchanges));
                   11097:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11  raeburn  11098:     }
1.984     raeburn  11099:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  11100:         if ($actionurl eq '/adm/dependencies') {
                   11101:             next if ($embed_file =~ m{^\w+://});
                   11102:         }
1.660     raeburn  11103:         $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11104:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  11105:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  11106:         unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35  raeburn  11107:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   11108:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  11109:         }
1.1075.2.35  raeburn  11110:         $upload_output .= '</td>';
1.1071    raeburn  11111:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1075.2.35  raeburn  11112:             $upload_output.='<td align="right">'.
                   11113:                             '<span class="LC_info LC_fontsize_medium">'.
                   11114:                             &mt("URL points to web address").'</span>';
1.987     raeburn  11115:             $numremref++;
1.660     raeburn  11116:         } elsif ($args->{'error_on_invalid_names'}
                   11117:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35  raeburn  11118:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   11119:                             &mt('Invalid characters').'</span>';
1.987     raeburn  11120:             $numinvalid++;
1.660     raeburn  11121:         } else {
1.1075.2.35  raeburn  11122:             $upload_output .= '<td>'.
                   11123:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  11124:                                                      $embed_file,\%mapping,
1.1071    raeburn  11125:                                                      $allfiles,$codebase,'upload');
                   11126:             $counter ++;
                   11127:             $numnew ++;
1.987     raeburn  11128:         }
                   11129:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   11130:     }
                   11131:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  11132:         if ($actionurl eq '/adm/dependencies') {
                   11133:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   11134:             $modify_output .= &start_data_table_row().
                   11135:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   11136:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   11137:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   11138:                               '<td>'.$size.'</td>'.
                   11139:                               '<td>'.$mtime.'</td>'.
                   11140:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   11141:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   11142:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   11143:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   11144:                               &embedded_file_element('upload_embedded',$counter,
                   11145:                                                      $embed_file,\%mapping,
                   11146:                                                      $allfiles,$codebase,'modify').
                   11147:                               '</div></td>'.
                   11148:                               &end_data_table_row()."\n";
                   11149:             $counter ++;
                   11150:         } else {
                   11151:             $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11152:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   11153:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   11154:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  11155:                               &Apache::loncommon::end_data_table_row()."\n";
                   11156:         }
                   11157:     }
                   11158:     my $delidx = $counter;
                   11159:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   11160:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   11161:         $delete_output .= &start_data_table_row().
                   11162:                           '<td><img src="'.&icon($oldfile).'" />'.
                   11163:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   11164:                           '<td>'.$size.'</td>'.
                   11165:                           '<td>'.$mtime.'</td>'.
                   11166:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   11167:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   11168:                           &embedded_file_element('upload_embedded',$delidx,
                   11169:                                                  $oldfile,\%mapping,$allfiles,
                   11170:                                                  $codebase,'delete').'</td>'.
                   11171:                           &end_data_table_row()."\n"; 
                   11172:         $numunused ++;
                   11173:         $delidx ++;
1.987     raeburn  11174:     }
                   11175:     if ($upload_output) {
                   11176:         $upload_output = &start_data_table().
                   11177:                          $upload_output.
                   11178:                          &end_data_table()."\n";
                   11179:     }
1.1071    raeburn  11180:     if ($modify_output) {
                   11181:         $modify_output = &start_data_table().
                   11182:                          &start_data_table_header_row().
                   11183:                          '<th>'.&mt('File').'</th>'.
                   11184:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11185:                          '<th>'.&mt('Modified').'</th>'.
                   11186:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   11187:                          &end_data_table_header_row().
                   11188:                          $modify_output.
                   11189:                          &end_data_table()."\n";
                   11190:     }
                   11191:     if ($delete_output) {
                   11192:         $delete_output = &start_data_table().
                   11193:                          &start_data_table_header_row().
                   11194:                          '<th>'.&mt('File').'</th>'.
                   11195:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11196:                          '<th>'.&mt('Modified').'</th>'.
                   11197:                          '<th>'.&mt('Delete?').'</th>'.
                   11198:                          &end_data_table_header_row().
                   11199:                          $delete_output.
                   11200:                          &end_data_table()."\n";
                   11201:     }
1.987     raeburn  11202:     my $applies = 0;
                   11203:     if ($numremref) {
                   11204:         $applies ++;
                   11205:     }
                   11206:     if ($numinvalid) {
                   11207:         $applies ++;
                   11208:     }
                   11209:     if ($numexisting) {
                   11210:         $applies ++;
                   11211:     }
1.1071    raeburn  11212:     if ($counter || $numunused) {
1.987     raeburn  11213:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   11214:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  11215:                   $state.'<h3>'.$heading.'</h3>'; 
                   11216:         if ($actionurl eq '/adm/dependencies') {
                   11217:             if ($numnew) {
                   11218:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   11219:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   11220:                            $upload_output.'<br />'."\n";
                   11221:             }
                   11222:             if ($numexisting) {
                   11223:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   11224:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   11225:                            $modify_output.'<br />'."\n";
                   11226:                            $buttontext = &mt('Save changes');
                   11227:             }
                   11228:             if ($numunused) {
                   11229:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   11230:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   11231:                            $delete_output.'<br />'."\n";
                   11232:                            $buttontext = &mt('Save changes');
                   11233:             }
                   11234:         } else {
                   11235:             $output .= $upload_output.'<br />'."\n";
                   11236:         }
                   11237:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   11238:                    $counter.'" />'."\n";
                   11239:         if ($actionurl eq '/adm/dependencies') { 
                   11240:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   11241:                        $numnew.'" />'."\n";
                   11242:         } elsif ($actionurl eq '') {
1.987     raeburn  11243:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   11244:         }
                   11245:     } elsif ($applies) {
                   11246:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   11247:         if ($applies > 1) {
                   11248:             $output .=  
1.1075.2.35  raeburn  11249:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  11250:             if ($numremref) {
                   11251:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   11252:             }
                   11253:             if ($numinvalid) {
                   11254:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   11255:             }
                   11256:             if ($numexisting) {
                   11257:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   11258:             }
                   11259:             $output .= '</ul><br />';
                   11260:         } elsif ($numremref) {
                   11261:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   11262:         } elsif ($numinvalid) {
                   11263:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   11264:         } elsif ($numexisting) {
                   11265:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   11266:         }
                   11267:         $output .= $upload_output.'<br />';
                   11268:     }
                   11269:     my ($pathchange_output,$chgcount);
1.1071    raeburn  11270:     $chgcount = $counter;
1.987     raeburn  11271:     if (keys(%pathchanges) > 0) {
                   11272:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  11273:             if ($counter) {
1.987     raeburn  11274:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   11275:                                                   $embed_file,\%mapping,
1.1071    raeburn  11276:                                                   $allfiles,$codebase,'change');
1.987     raeburn  11277:             } else {
                   11278:                 $pathchange_output .= 
                   11279:                     &start_data_table_row().
                   11280:                     '<td><input type ="checkbox" name="namechange" value="'.
                   11281:                     $chgcount.'" checked="checked" /></td>'.
                   11282:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   11283:                     '<td>'.$embed_file.
                   11284:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  11285:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  11286:                     '</td>'.&end_data_table_row();
1.660     raeburn  11287:             }
1.987     raeburn  11288:             $numpathchg ++;
                   11289:             $chgcount ++;
1.660     raeburn  11290:         }
                   11291:     }
1.1075.2.35  raeburn  11292:     if (($counter) || ($numunused)) {
1.987     raeburn  11293:         if ($numpathchg) {
                   11294:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   11295:                        $numpathchg.'" />'."\n";
                   11296:         }
                   11297:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   11298:             ($actionurl eq '/adm/imsimport')) {
                   11299:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   11300:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   11301:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  11302:         } elsif ($actionurl eq '/adm/dependencies') {
                   11303:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  11304:         }
1.1075.2.35  raeburn  11305:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  11306:     } elsif ($numpathchg) {
                   11307:         my %pathchange = ();
                   11308:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   11309:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11310:             $output .= '<p>'.&mt('or').'</p>'; 
1.1075.2.35  raeburn  11311:         }
1.987     raeburn  11312:     }
1.1071    raeburn  11313:     return ($output,$counter,$numpathchg);
1.987     raeburn  11314: }
                   11315: 
1.1075.2.47  raeburn  11316: =pod
                   11317: 
                   11318: =item * clean_path($name)
                   11319: 
                   11320: Performs clean-up of directories, subdirectories and filename in an
                   11321: embedded object, referenced in an HTML file which is being uploaded
                   11322: to a course or portfolio, where
                   11323: "Upload embedded images/multimedia files if HTML file" checkbox was
                   11324: checked.
                   11325: 
                   11326: Clean-up is similar to replacements in lonnet::clean_filename()
                   11327: except each / between sub-directory and next level is preserved.
                   11328: 
                   11329: =cut
                   11330: 
                   11331: sub clean_path {
                   11332:     my ($embed_file) = @_;
                   11333:     $embed_file =~s{^/+}{};
                   11334:     my @contents;
                   11335:     if ($embed_file =~ m{/}) {
                   11336:         @contents = split(/\//,$embed_file);
                   11337:     } else {
                   11338:         @contents = ($embed_file);
                   11339:     }
                   11340:     my $lastidx = scalar(@contents)-1;
                   11341:     for (my $i=0; $i<=$lastidx; $i++) {
                   11342:         $contents[$i]=~s{\\}{/}g;
                   11343:         $contents[$i]=~s/\s+/\_/g;
                   11344:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   11345:         if ($i == $lastidx) {
                   11346:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   11347:         }
                   11348:     }
                   11349:     if ($lastidx > 0) {
                   11350:         return join('/',@contents);
                   11351:     } else {
                   11352:         return $contents[0];
                   11353:     }
                   11354: }
                   11355: 
1.987     raeburn  11356: sub embedded_file_element {
1.1071    raeburn  11357:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  11358:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   11359:                    (ref($codebase) eq 'HASH'));
                   11360:     my $output;
1.1071    raeburn  11361:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  11362:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   11363:     }
                   11364:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   11365:                &escape($embed_file).'" />';
                   11366:     unless (($context eq 'upload_embedded') && 
                   11367:             ($mapping->{$embed_file} eq $embed_file)) {
                   11368:         $output .='
                   11369:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   11370:     }
                   11371:     my $attrib;
                   11372:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   11373:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   11374:     }
                   11375:     $output .=
                   11376:         "\n\t\t".
                   11377:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   11378:         $attrib.'" />';
                   11379:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   11380:         $output .=
                   11381:             "\n\t\t".
                   11382:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   11383:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  11384:     }
1.987     raeburn  11385:     return $output;
1.660     raeburn  11386: }
                   11387: 
1.1071    raeburn  11388: sub get_dependency_details {
                   11389:     my ($currfile,$currsubfile,$embed_file) = @_;
                   11390:     my ($size,$mtime,$showsize,$showmtime);
                   11391:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   11392:         if ($embed_file =~ m{/}) {
                   11393:             my ($path,$fname) = split(/\//,$embed_file);
                   11394:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   11395:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   11396:             }
                   11397:         } else {
                   11398:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   11399:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   11400:             }
                   11401:         }
                   11402:         $showsize = $size/1024.0;
                   11403:         $showsize = sprintf("%.1f",$showsize);
                   11404:         if ($mtime > 0) {
                   11405:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   11406:         }
                   11407:     }
                   11408:     return ($showsize,$showmtime);
                   11409: }
                   11410: 
                   11411: sub ask_embedded_js {
                   11412:     return <<"END";
                   11413: <script type="text/javascript"">
                   11414: // <![CDATA[
                   11415: function toggleBrowse(counter) {
                   11416:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   11417:     var fileid = document.getElementById('embedded_item_'+counter);
                   11418:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   11419:     if (chkboxid.checked == true) {
                   11420:         uploaddivid.style.display='block';
                   11421:     } else {
                   11422:         uploaddivid.style.display='none';
                   11423:         fileid.value = '';
                   11424:     }
                   11425: }
                   11426: // ]]>
                   11427: </script>
                   11428: 
                   11429: END
                   11430: }
                   11431: 
1.661     raeburn  11432: sub upload_embedded {
                   11433:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  11434:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   11435:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  11436:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   11437:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   11438:         my $orig_uploaded_filename =
                   11439:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  11440:         foreach my $type ('orig','ref','attrib','codebase') {
                   11441:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   11442:                 $env{'form.embedded_'.$type.'_'.$i} =
                   11443:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   11444:             }
                   11445:         }
1.661     raeburn  11446:         my ($path,$fname) =
                   11447:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   11448:         # no path, whole string is fname
                   11449:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   11450:         $fname = &Apache::lonnet::clean_filename($fname);
                   11451:         # See if there is anything left
                   11452:         next if ($fname eq '');
                   11453: 
                   11454:         # Check if file already exists as a file or directory.
                   11455:         my ($state,$msg);
                   11456:         if ($context eq 'portfolio') {
                   11457:             my $port_path = $dirpath;
                   11458:             if ($group ne '') {
                   11459:                 $port_path = "groups/$group/$port_path";
                   11460:             }
1.987     raeburn  11461:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   11462:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  11463:                                               $dir_root,$port_path,$disk_quota,
                   11464:                                               $current_disk_usage,$uname,$udom);
                   11465:             if ($state eq 'will_exceed_quota'
1.984     raeburn  11466:                 || $state eq 'file_locked') {
1.661     raeburn  11467:                 $output .= $msg;
                   11468:                 next;
                   11469:             }
                   11470:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   11471:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   11472:             if ($state eq 'exists') {
                   11473:                 $output .= $msg;
                   11474:                 next;
                   11475:             }
                   11476:         }
                   11477:         # Check if extension is valid
                   11478:         if (($fname =~ /\.(\w+)$/) &&
                   11479:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1075.2.53  raeburn  11480:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   11481:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  11482:             next;
                   11483:         } elsif (($fname =~ /\.(\w+)$/) &&
                   11484:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  11485:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  11486:             next;
                   11487:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34  raeburn  11488:             $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  11489:             next;
                   11490:         }
                   11491:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35  raeburn  11492:         my $subdir = $path;
                   11493:         $subdir =~ s{/+$}{};
1.661     raeburn  11494:         if ($context eq 'portfolio') {
1.984     raeburn  11495:             my $result;
                   11496:             if ($state eq 'existingfile') {
                   11497:                 $result=
                   11498:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35  raeburn  11499:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  11500:             } else {
1.984     raeburn  11501:                 $result=
                   11502:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  11503:                                                     $dirpath.
1.1075.2.35  raeburn  11504:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  11505:                 if ($result !~ m|^/uploaded/|) {
                   11506:                     $output .= '<span class="LC_error">'
                   11507:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11508:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11509:                                .'</span><br />';
                   11510:                     next;
                   11511:                 } else {
1.987     raeburn  11512:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11513:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  11514:                 }
1.661     raeburn  11515:             }
1.1075.2.35  raeburn  11516:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
                   11517:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   11518:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  11519:             my $result =
1.1075.2.35  raeburn  11520:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  11521:             if ($result !~ m|^/uploaded/|) {
                   11522:                 $output .= '<span class="LC_error">'
                   11523:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11524:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11525:                            .'</span><br />';
                   11526:                     next;
                   11527:             } else {
                   11528:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11529:                            $path.$fname.'</span>').'<br />';
1.1075.2.35  raeburn  11530:                 if ($context eq 'syllabus') {
                   11531:                     &Apache::lonnet::make_public_indefinitely($result);
                   11532:                 }
1.987     raeburn  11533:             }
1.661     raeburn  11534:         } else {
                   11535: # Save the file
                   11536:             my $target = $env{'form.embedded_item_'.$i};
                   11537:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   11538:             my $dest = $fullpath.$fname;
                   11539:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  11540:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  11541:             my $count;
                   11542:             my $filepath = $dir_root;
1.1027    raeburn  11543:             foreach my $subdir (@parts) {
                   11544:                 $filepath .= "/$subdir";
                   11545:                 if (!-e $filepath) {
1.661     raeburn  11546:                     mkdir($filepath,0770);
                   11547:                 }
                   11548:             }
                   11549:             my $fh;
                   11550:             if (!open($fh,'>'.$dest)) {
                   11551:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   11552:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  11553:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   11554:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11555:                            '</span><br />';
                   11556:             } else {
                   11557:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   11558:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   11559:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  11560:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   11561:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11562:                               '</span><br />';
                   11563:                 } else {
1.987     raeburn  11564:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11565:                                $url.'</span>').'<br />';
                   11566:                     unless ($context eq 'testbank') {
                   11567:                         $footer .= &mt('View embedded file: [_1]',
                   11568:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   11569:                     }
                   11570:                 }
                   11571:                 close($fh);
                   11572:             }
                   11573:         }
                   11574:         if ($env{'form.embedded_ref_'.$i}) {
                   11575:             $pathchange{$i} = 1;
                   11576:         }
                   11577:     }
                   11578:     if ($output) {
                   11579:         $output = '<p>'.$output.'</p>';
                   11580:     }
                   11581:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   11582:     $returnflag = 'ok';
1.1071    raeburn  11583:     my $numpathchgs = scalar(keys(%pathchange));
                   11584:     if ($numpathchgs > 0) {
1.987     raeburn  11585:         if ($context eq 'portfolio') {
                   11586:             $output .= '<p>'.&mt('or').'</p>';
                   11587:         } elsif ($context eq 'testbank') {
1.1071    raeburn  11588:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   11589:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  11590:             $returnflag = 'modify_orightml';
                   11591:         }
                   11592:     }
1.1071    raeburn  11593:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  11594: }
                   11595: 
                   11596: sub modify_html_form {
                   11597:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   11598:     my $end = 0;
                   11599:     my $modifyform;
                   11600:     if ($context eq 'upload_embedded') {
                   11601:         return unless (ref($pathchange) eq 'HASH');
                   11602:         if ($env{'form.number_embedded_items'}) {
                   11603:             $end += $env{'form.number_embedded_items'};
                   11604:         }
                   11605:         if ($env{'form.number_pathchange_items'}) {
                   11606:             $end += $env{'form.number_pathchange_items'};
                   11607:         }
                   11608:         if ($end) {
                   11609:             for (my $i=0; $i<$end; $i++) {
                   11610:                 if ($i < $env{'form.number_embedded_items'}) {
                   11611:                     next unless($pathchange->{$i});
                   11612:                 }
                   11613:                 $modifyform .=
                   11614:                     &start_data_table_row().
                   11615:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   11616:                     'checked="checked" /></td>'.
                   11617:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   11618:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   11619:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   11620:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   11621:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   11622:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   11623:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   11624:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   11625:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   11626:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   11627:                     &end_data_table_row();
1.1071    raeburn  11628:             }
1.987     raeburn  11629:         }
                   11630:     } else {
                   11631:         $modifyform = $pathchgtable;
                   11632:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   11633:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   11634:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11635:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   11636:         }
                   11637:     }
                   11638:     if ($modifyform) {
1.1071    raeburn  11639:         if ($actionurl eq '/adm/dependencies') {
                   11640:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   11641:         }
1.987     raeburn  11642:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   11643:                '<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".
                   11644:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   11645:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   11646:                '</ol></p>'."\n".'<p>'.
                   11647:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   11648:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   11649:                &start_data_table()."\n".
                   11650:                &start_data_table_header_row().
                   11651:                '<th>'.&mt('Change?').'</th>'.
                   11652:                '<th>'.&mt('Current reference').'</th>'.
                   11653:                '<th>'.&mt('Required reference').'</th>'.
                   11654:                &end_data_table_header_row()."\n".
                   11655:                $modifyform.
                   11656:                &end_data_table().'<br />'."\n".$hiddenstate.
                   11657:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   11658:                '</form>'."\n";
                   11659:     }
                   11660:     return;
                   11661: }
                   11662: 
                   11663: sub modify_html_refs {
1.1075.2.35  raeburn  11664:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  11665:     my $container;
                   11666:     if ($context eq 'portfolio') {
                   11667:         $container = $env{'form.container'};
                   11668:     } elsif ($context eq 'coursedoc') {
                   11669:         $container = $env{'form.primaryurl'};
1.1071    raeburn  11670:     } elsif ($context eq 'manage_dependencies') {
                   11671:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   11672:         $container = "/$container";
1.1075.2.35  raeburn  11673:     } elsif ($context eq 'syllabus') {
                   11674:         $container = $url;
1.987     raeburn  11675:     } else {
1.1027    raeburn  11676:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  11677:     }
                   11678:     my (%allfiles,%codebase,$output,$content);
                   11679:     my @changes = &get_env_multiple('form.namechange');
1.1075.2.35  raeburn  11680:     unless ((@changes > 0)  || ($context eq 'syllabus')) {
1.1071    raeburn  11681:         if (wantarray) {
                   11682:             return ('',0,0); 
                   11683:         } else {
                   11684:             return;
                   11685:         }
                   11686:     }
                   11687:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11688:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  11689:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   11690:             if (wantarray) {
                   11691:                 return ('',0,0);
                   11692:             } else {
                   11693:                 return;
                   11694:             }
                   11695:         } 
1.987     raeburn  11696:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  11697:         if ($content eq '-1') {
                   11698:             if (wantarray) {
                   11699:                 return ('',0,0);
                   11700:             } else {
                   11701:                 return;
                   11702:             }
                   11703:         }
1.987     raeburn  11704:     } else {
1.1071    raeburn  11705:         unless ($container =~ /^\Q$dir_root\E/) {
                   11706:             if (wantarray) {
                   11707:                 return ('',0,0);
                   11708:             } else {
                   11709:                 return;
                   11710:             }
                   11711:         } 
1.1075.2.128  raeburn  11712:         if (open(my $fh,'<',$container)) {
1.987     raeburn  11713:             $content = join('', <$fh>);
                   11714:             close($fh);
                   11715:         } else {
1.1071    raeburn  11716:             if (wantarray) {
                   11717:                 return ('',0,0);
                   11718:             } else {
                   11719:                 return;
                   11720:             }
1.987     raeburn  11721:         }
                   11722:     }
                   11723:     my ($count,$codebasecount) = (0,0);
                   11724:     my $mm = new File::MMagic;
                   11725:     my $mime_type = $mm->checktype_contents($content);
                   11726:     if ($mime_type eq 'text/html') {
                   11727:         my $parse_result = 
                   11728:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   11729:                                                     \%codebase,\$content);
                   11730:         if ($parse_result eq 'ok') {
                   11731:             foreach my $i (@changes) {
                   11732:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   11733:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   11734:                 if ($allfiles{$ref}) {
                   11735:                     my $newname =  $orig;
                   11736:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  11737:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  11738:                     if ($attrib_regexp =~ /:/) {
                   11739:                         $attrib_regexp =~ s/\:/|/g;
                   11740:                     }
                   11741:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11742:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11743:                         $count += $numchg;
1.1075.2.35  raeburn  11744:                         $allfiles{$newname} = $allfiles{$ref};
1.1075.2.48  raeburn  11745:                         delete($allfiles{$ref});
1.987     raeburn  11746:                     }
                   11747:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  11748:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  11749:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   11750:                         $codebasecount ++;
                   11751:                     }
                   11752:                 }
                   11753:             }
1.1075.2.35  raeburn  11754:             my $skiprewrites;
1.987     raeburn  11755:             if ($count || $codebasecount) {
                   11756:                 my $saveresult;
1.1071    raeburn  11757:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11758:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  11759:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11760:                     if ($url eq $container) {
                   11761:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   11762:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11763:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  11764:                                             $fname.'</span>').'</p>';
1.987     raeburn  11765:                     } else {
                   11766:                          $output = '<p class="LC_error">'.
                   11767:                                    &mt('Error: update failed for: [_1].',
                   11768:                                    '<span class="LC_filename">'.
                   11769:                                    $container.'</span>').'</p>';
                   11770:                     }
1.1075.2.35  raeburn  11771:                     if ($context eq 'syllabus') {
                   11772:                         unless ($saveresult eq 'ok') {
                   11773:                             $skiprewrites = 1;
                   11774:                         }
                   11775:                     }
1.987     raeburn  11776:                 } else {
1.1075.2.128  raeburn  11777:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  11778:                         print $fh $content;
                   11779:                         close($fh);
                   11780:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11781:                                   $count,'<span class="LC_filename">'.
                   11782:                                   $container.'</span>').'</p>';
1.661     raeburn  11783:                     } else {
1.987     raeburn  11784:                          $output = '<p class="LC_error">'.
                   11785:                                    &mt('Error: could not update [_1].',
                   11786:                                    '<span class="LC_filename">'.
                   11787:                                    $container.'</span>').'</p>';
1.661     raeburn  11788:                     }
                   11789:                 }
                   11790:             }
1.1075.2.35  raeburn  11791:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   11792:                 my ($actionurl,$state);
                   11793:                 $actionurl = "/public/$udom/$uname/syllabus";
                   11794:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   11795:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   11796:                                               \%codebase,
                   11797:                                               {'context' => 'rewrites',
                   11798:                                                'ignore_remote_references' => 1,});
                   11799:                 if (ref($mapping) eq 'HASH') {
                   11800:                     my $rewrites = 0;
                   11801:                     foreach my $key (keys(%{$mapping})) {
                   11802:                         next if ($key =~ m{^https?://});
                   11803:                         my $ref = $mapping->{$key};
                   11804:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   11805:                         my $attrib;
                   11806:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   11807:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   11808:                         }
                   11809:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11810:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11811:                             $rewrites += $numchg;
                   11812:                         }
                   11813:                     }
                   11814:                     if ($rewrites) {
                   11815:                         my $saveresult;
                   11816:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11817:                         if ($url eq $container) {
                   11818:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   11819:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   11820:                                             $count,'<span class="LC_filename">'.
                   11821:                                             $fname.'</span>').'</p>';
                   11822:                         } else {
                   11823:                             $output .= '<p class="LC_error">'.
                   11824:                                        &mt('Error: could not update links in [_1].',
                   11825:                                        '<span class="LC_filename">'.
                   11826:                                        $container.'</span>').'</p>';
                   11827: 
                   11828:                         }
                   11829:                     }
                   11830:                 }
                   11831:             }
1.987     raeburn  11832:         } else {
                   11833:             &logthis('Failed to parse '.$container.
                   11834:                      ' to modify references: '.$parse_result);
1.661     raeburn  11835:         }
                   11836:     }
1.1071    raeburn  11837:     if (wantarray) {
                   11838:         return ($output,$count,$codebasecount);
                   11839:     } else {
                   11840:         return $output;
                   11841:     }
1.661     raeburn  11842: }
                   11843: 
                   11844: sub check_for_existing {
                   11845:     my ($path,$fname,$element) = @_;
                   11846:     my ($state,$msg);
                   11847:     if (-d $path.'/'.$fname) {
                   11848:         $state = 'exists';
                   11849:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   11850:     } elsif (-e $path.'/'.$fname) {
                   11851:         $state = 'exists';
                   11852:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   11853:     }
                   11854:     if ($state eq 'exists') {
                   11855:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   11856:     }
                   11857:     return ($state,$msg);
                   11858: }
                   11859: 
                   11860: sub check_for_upload {
                   11861:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   11862:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  11863:     my $filesize = length($env{'form.'.$element});
                   11864:     if (!$filesize) {
                   11865:         my $msg = '<span class="LC_error">'.
                   11866:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   11867:                       '<span class="LC_filename">'.$fname.'</span>',
                   11868:                       $filesize).'<br />'.
1.1007    raeburn  11869:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  11870:                   '</span>';
                   11871:         return ('zero_bytes',$msg);
                   11872:     }
                   11873:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  11874:     my $getpropath = 1;
1.1021    raeburn  11875:     my ($dirlistref,$listerror) =
                   11876:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  11877:     my $found_file = 0;
                   11878:     my $locked_file = 0;
1.991     raeburn  11879:     my @lockers;
                   11880:     my $navmap;
                   11881:     if ($env{'request.course.id'}) {
                   11882:         $navmap = Apache::lonnavmaps::navmap->new();
                   11883:     }
1.1021    raeburn  11884:     if (ref($dirlistref) eq 'ARRAY') {
                   11885:         foreach my $line (@{$dirlistref}) {
                   11886:             my ($file_name,$rest)=split(/\&/,$line,2);
                   11887:             if ($file_name eq $fname){
                   11888:                 $file_name = $path.$file_name;
                   11889:                 if ($group ne '') {
                   11890:                     $file_name = $group.$file_name;
                   11891:                 }
                   11892:                 $found_file = 1;
                   11893:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   11894:                     foreach my $lock (@lockers) {
                   11895:                         if (ref($lock) eq 'ARRAY') {
                   11896:                             my ($symb,$crsid) = @{$lock};
                   11897:                             if ($crsid eq $env{'request.course.id'}) {
                   11898:                                 if (ref($navmap)) {
                   11899:                                     my $res = $navmap->getBySymb($symb);
                   11900:                                     foreach my $part (@{$res->parts()}) { 
                   11901:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   11902:                                         unless (($slot_status == $res->RESERVED) ||
                   11903:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   11904:                                             $locked_file = 1;
                   11905:                                         }
1.991     raeburn  11906:                                     }
1.1021    raeburn  11907:                                 } else {
                   11908:                                     $locked_file = 1;
1.991     raeburn  11909:                                 }
                   11910:                             } else {
                   11911:                                 $locked_file = 1;
                   11912:                             }
                   11913:                         }
1.1021    raeburn  11914:                    }
                   11915:                 } else {
                   11916:                     my @info = split(/\&/,$rest);
                   11917:                     my $currsize = $info[6]/1000;
                   11918:                     if ($currsize < $filesize) {
                   11919:                         my $extra = $filesize - $currsize;
                   11920:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1075.2.69  raeburn  11921:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  11922:                                       &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  11923:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   11924:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   11925:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  11926:                             return ('will_exceed_quota',$msg);
                   11927:                         }
1.984     raeburn  11928:                     }
                   11929:                 }
1.661     raeburn  11930:             }
                   11931:         }
                   11932:     }
                   11933:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1075.2.69  raeburn  11934:         my $msg = '<p class="LC_warning">'.
                   11935:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
                   11936:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  11937:         return ('will_exceed_quota',$msg);
                   11938:     } elsif ($found_file) {
                   11939:         if ($locked_file) {
1.1075.2.69  raeburn  11940:             my $msg = '<p class="LC_warning">';
1.661     raeburn  11941:             $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  11942:             $msg .= '</p>';
1.661     raeburn  11943:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   11944:             return ('file_locked',$msg);
                   11945:         } else {
1.1075.2.69  raeburn  11946:             my $msg = '<p class="LC_error">';
1.984     raeburn  11947:             $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  11948:             $msg .= '</p>';
1.984     raeburn  11949:             return ('existingfile',$msg);
1.661     raeburn  11950:         }
                   11951:     }
                   11952: }
                   11953: 
1.987     raeburn  11954: sub check_for_traversal {
                   11955:     my ($path,$url,$toplevel) = @_;
                   11956:     my @parts=split(/\//,$path);
                   11957:     my $cleanpath;
                   11958:     my $fullpath = $url;
                   11959:     for (my $i=0;$i<@parts;$i++) {
                   11960:         next if ($parts[$i] eq '.');
                   11961:         if ($parts[$i] eq '..') {
                   11962:             $fullpath =~ s{([^/]+/)$}{};
                   11963:         } else {
                   11964:             $fullpath .= $parts[$i].'/';
                   11965:         }
                   11966:     }
                   11967:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   11968:         $cleanpath = $1;
                   11969:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   11970:         my $curr_toprel = $1;
                   11971:         my @parts = split(/\//,$curr_toprel);
                   11972:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   11973:         my @urlparts = split(/\//,$url_toprel);
                   11974:         my $doubledots;
                   11975:         my $startdiff = -1;
                   11976:         for (my $i=0; $i<@urlparts; $i++) {
                   11977:             if ($startdiff == -1) {
                   11978:                 unless ($urlparts[$i] eq $parts[$i]) {
                   11979:                     $startdiff = $i;
                   11980:                     $doubledots .= '../';
                   11981:                 }
                   11982:             } else {
                   11983:                 $doubledots .= '../';
                   11984:             }
                   11985:         }
                   11986:         if ($startdiff > -1) {
                   11987:             $cleanpath = $doubledots;
                   11988:             for (my $i=$startdiff; $i<@parts; $i++) {
                   11989:                 $cleanpath .= $parts[$i].'/';
                   11990:             }
                   11991:         }
                   11992:     }
                   11993:     $cleanpath =~ s{(/)$}{};
                   11994:     return $cleanpath;
                   11995: }
1.31      albertel 11996: 
1.1053    raeburn  11997: sub is_archive_file {
                   11998:     my ($mimetype) = @_;
                   11999:     if (($mimetype eq 'application/octet-stream') ||
                   12000:         ($mimetype eq 'application/x-stuffit') ||
                   12001:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   12002:         return 1;
                   12003:     }
                   12004:     return;
                   12005: }
                   12006: 
                   12007: sub decompress_form {
1.1065    raeburn  12008:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  12009:     my %lt = &Apache::lonlocal::texthash (
                   12010:         this => 'This file is an archive file.',
1.1067    raeburn  12011:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  12012:         itsc => 'Its contents are as follows:',
1.1053    raeburn  12013:         youm => 'You may wish to extract its contents.',
                   12014:         extr => 'Extract contents',
1.1067    raeburn  12015:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   12016:         proa => 'Process automatically?',
1.1053    raeburn  12017:         yes  => 'Yes',
                   12018:         no   => 'No',
1.1067    raeburn  12019:         fold => 'Title for folder containing movie',
                   12020:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  12021:     );
1.1065    raeburn  12022:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  12023:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  12024:     my $info = &list_archive_contents($fileloc,\@paths);
                   12025:     if (@paths) {
                   12026:         foreach my $path (@paths) {
                   12027:             $path =~ s{^/}{};
1.1067    raeburn  12028:             if ($path =~ m{^([^/]+)/$}) {
                   12029:                 $topdir = $1;
                   12030:             }
1.1065    raeburn  12031:             if ($path =~ m{^([^/]+)/}) {
                   12032:                 $toplevel{$1} = $path;
                   12033:             } else {
                   12034:                 $toplevel{$path} = $path;
                   12035:             }
                   12036:         }
                   12037:     }
1.1067    raeburn  12038:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1075.2.59  raeburn  12039:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  12040:                         "$topdir/media/",
                   12041:                         "$topdir/media/$topdir.mp4",
                   12042:                         "$topdir/media/FirstFrame.png",
                   12043:                         "$topdir/media/player.swf",
                   12044:                         "$topdir/media/swfobject.js",
                   12045:                         "$topdir/media/expressInstall.swf");
1.1075.2.81  raeburn  12046:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1075.2.59  raeburn  12047:                          "$topdir/$topdir.mp4",
                   12048:                          "$topdir/$topdir\_config.xml",
                   12049:                          "$topdir/$topdir\_controller.swf",
                   12050:                          "$topdir/$topdir\_embed.css",
                   12051:                          "$topdir/$topdir\_First_Frame.png",
                   12052:                          "$topdir/$topdir\_player.html",
                   12053:                          "$topdir/$topdir\_Thumbnails.png",
                   12054:                          "$topdir/playerProductInstall.swf",
                   12055:                          "$topdir/scripts/",
                   12056:                          "$topdir/scripts/config_xml.js",
                   12057:                          "$topdir/scripts/handlebars.js",
                   12058:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   12059:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   12060:                          "$topdir/scripts/modernizr.js",
                   12061:                          "$topdir/scripts/player-min.js",
                   12062:                          "$topdir/scripts/swfobject.js",
                   12063:                          "$topdir/skins/",
                   12064:                          "$topdir/skins/configuration_express.xml",
                   12065:                          "$topdir/skins/express_show/",
                   12066:                          "$topdir/skins/express_show/player-min.css",
                   12067:                          "$topdir/skins/express_show/spritesheet.png");
1.1075.2.81  raeburn  12068:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   12069:                          "$topdir/$topdir.mp4",
                   12070:                          "$topdir/$topdir\_config.xml",
                   12071:                          "$topdir/$topdir\_controller.swf",
                   12072:                          "$topdir/$topdir\_embed.css",
                   12073:                          "$topdir/$topdir\_First_Frame.png",
                   12074:                          "$topdir/$topdir\_player.html",
                   12075:                          "$topdir/$topdir\_Thumbnails.png",
                   12076:                          "$topdir/playerProductInstall.swf",
                   12077:                          "$topdir/scripts/",
                   12078:                          "$topdir/scripts/config_xml.js",
                   12079:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   12080:                          "$topdir/skins/",
                   12081:                          "$topdir/skins/configuration_express.xml",
                   12082:                          "$topdir/skins/express_show/",
                   12083:                          "$topdir/skins/express_show/spritesheet.min.css",
                   12084:                          "$topdir/skins/express_show/spritesheet.png",
                   12085:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1075.2.59  raeburn  12086:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  12087:         if (@diffs == 0) {
1.1075.2.59  raeburn  12088:             $is_camtasia = 6;
                   12089:         } else {
1.1075.2.81  raeburn  12090:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1075.2.59  raeburn  12091:             if (@diffs == 0) {
                   12092:                 $is_camtasia = 8;
1.1075.2.81  raeburn  12093:             } else {
                   12094:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   12095:                 if (@diffs == 0) {
                   12096:                     $is_camtasia = 8;
                   12097:                 }
1.1075.2.59  raeburn  12098:             }
1.1067    raeburn  12099:         }
                   12100:     }
                   12101:     my $output;
                   12102:     if ($is_camtasia) {
                   12103:         $output = <<"ENDCAM";
                   12104: <script type="text/javascript" language="Javascript">
                   12105: // <![CDATA[
                   12106: 
                   12107: function camtasiaToggle() {
                   12108:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   12109:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1075.2.59  raeburn  12110:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  12111:                 document.getElementById('camtasia_titles').style.display='block';
                   12112:             } else {
                   12113:                 document.getElementById('camtasia_titles').style.display='none';
                   12114:             }
                   12115:         }
                   12116:     }
                   12117:     return;
                   12118: }
                   12119: 
                   12120: // ]]>
                   12121: </script>
                   12122: <p>$lt{'camt'}</p>
                   12123: ENDCAM
1.1065    raeburn  12124:     } else {
1.1067    raeburn  12125:         $output = '<p>'.$lt{'this'};
                   12126:         if ($info eq '') {
                   12127:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   12128:         } else {
                   12129:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   12130:                        '<div><pre>'.$info.'</pre></div>';
                   12131:         }
1.1065    raeburn  12132:     }
1.1067    raeburn  12133:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  12134:     my $duplicates;
                   12135:     my $num = 0;
                   12136:     if (ref($dirlist) eq 'ARRAY') {
                   12137:         foreach my $item (@{$dirlist}) {
                   12138:             if (ref($item) eq 'ARRAY') {
                   12139:                 if (exists($toplevel{$item->[0]})) {
                   12140:                     $duplicates .= 
                   12141:                         &start_data_table_row().
                   12142:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12143:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   12144:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12145:                         'value="1" />'.&mt('Yes').'</label>'.
                   12146:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   12147:                         '<td>'.$item->[0].'</td>';
                   12148:                     if ($item->[2]) {
                   12149:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   12150:                     } else {
                   12151:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   12152:                     }
                   12153:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   12154:                                    '<td>'.
                   12155:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   12156:                                    '</td>'.
                   12157:                                    &end_data_table_row();
                   12158:                     $num ++;
                   12159:                 }
                   12160:             }
                   12161:         }
                   12162:     }
                   12163:     my $itemcount;
                   12164:     if (@paths > 0) {
                   12165:         $itemcount = scalar(@paths);
                   12166:     } else {
                   12167:         $itemcount = 1;
                   12168:     }
1.1067    raeburn  12169:     if ($is_camtasia) {
                   12170:         $output .= $lt{'auto'}.'<br />'.
                   12171:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1075.2.59  raeburn  12172:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  12173:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   12174:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   12175:                    $lt{'no'}.'</label></span><br />'.
                   12176:                    '<div id="camtasia_titles" style="display:block">'.
                   12177:                    &Apache::lonhtmlcommon::start_pick_box().
                   12178:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   12179:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   12180:                    &Apache::lonhtmlcommon::row_closure().
                   12181:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   12182:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   12183:                    &Apache::lonhtmlcommon::row_closure(1).
                   12184:                    &Apache::lonhtmlcommon::end_pick_box().
                   12185:                    '</div>';
                   12186:     }
1.1065    raeburn  12187:     $output .= 
                   12188:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  12189:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   12190:         "\n";
1.1065    raeburn  12191:     if ($duplicates ne '') {
                   12192:         $output .= '<p><span class="LC_warning">'.
                   12193:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   12194:                    &start_data_table().
                   12195:                    &start_data_table_header_row().
                   12196:                    '<th>'.&mt('Overwrite?').'</th>'.
                   12197:                    '<th>'.&mt('Name').'</th>'.
                   12198:                    '<th>'.&mt('Type').'</th>'.
                   12199:                    '<th>'.&mt('Size').'</th>'.
                   12200:                    '<th>'.&mt('Last modified').'</th>'.
                   12201:                    &end_data_table_header_row().
                   12202:                    $duplicates.
                   12203:                    &end_data_table().
                   12204:                    '</p>';
                   12205:     }
1.1067    raeburn  12206:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  12207:     if (ref($hiddenelements) eq 'HASH') {
                   12208:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   12209:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   12210:         }
                   12211:     }
                   12212:     $output .= <<"END";
1.1067    raeburn  12213: <br />
1.1053    raeburn  12214: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   12215: </form>
                   12216: $noextract
                   12217: END
                   12218:     return $output;
                   12219: }
                   12220: 
1.1065    raeburn  12221: sub decompression_utility {
                   12222:     my ($program) = @_;
                   12223:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   12224:     my $location;
                   12225:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   12226:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   12227:                          '/usr/sbin/') {
                   12228:             if (-x $dir.$program) {
                   12229:                 $location = $dir.$program;
                   12230:                 last;
                   12231:             }
                   12232:         }
                   12233:     }
                   12234:     return $location;
                   12235: }
                   12236: 
                   12237: sub list_archive_contents {
                   12238:     my ($file,$pathsref) = @_;
                   12239:     my (@cmd,$output);
                   12240:     my $needsregexp;
                   12241:     if ($file =~ /\.zip$/) {
                   12242:         @cmd = (&decompression_utility('unzip'),"-l");
                   12243:         $needsregexp = 1;
                   12244:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   12245:              ($file =~ /\.tgz$/)) {
                   12246:         @cmd = (&decompression_utility('tar'),"-ztf");
                   12247:     } elsif ($file =~ /\.tar\.bz2$/) {
                   12248:         @cmd = (&decompression_utility('tar'),"-jtf");
                   12249:     } elsif ($file =~ m|\.tar$|) {
                   12250:         @cmd = (&decompression_utility('tar'),"-tf");
                   12251:     }
                   12252:     if (@cmd) {
                   12253:         undef($!);
                   12254:         undef($@);
                   12255:         if (open(my $fh,"-|", @cmd, $file)) {
                   12256:             while (my $line = <$fh>) {
                   12257:                 $output .= $line;
                   12258:                 chomp($line);
                   12259:                 my $item;
                   12260:                 if ($needsregexp) {
                   12261:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   12262:                 } else {
                   12263:                     $item = $line;
                   12264:                 }
                   12265:                 if ($item ne '') {
                   12266:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   12267:                         push(@{$pathsref},$item);
                   12268:                     } 
                   12269:                 }
                   12270:             }
                   12271:             close($fh);
                   12272:         }
                   12273:     }
                   12274:     return $output;
                   12275: }
                   12276: 
1.1053    raeburn  12277: sub decompress_uploaded_file {
                   12278:     my ($file,$dir) = @_;
                   12279:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   12280:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   12281:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   12282:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   12283:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   12284:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   12285:     my $decompressed = $env{'cgi.decompressed'};
                   12286:     &Apache::lonnet::delenv('cgi.file');
                   12287:     &Apache::lonnet::delenv('cgi.dir');
                   12288:     &Apache::lonnet::delenv('cgi.decompressed');
                   12289:     return ($decompressed,$result);
                   12290: }
                   12291: 
1.1055    raeburn  12292: sub process_decompression {
                   12293:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1075.2.128  raeburn  12294:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   12295:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12296:                &mt('Unexpected file path.').'</p>'."\n";
                   12297:     }
                   12298:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   12299:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12300:                &mt('Unexpected course context.').'</p>'."\n";
                   12301:     }
                   12302:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
                   12303:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12304:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   12305:     }
1.1055    raeburn  12306:     my ($dir,$error,$warning,$output);
1.1075.2.69  raeburn  12307:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1075.2.34  raeburn  12308:         $error = &mt('Filename not a supported archive file type.').
                   12309:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  12310:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   12311:     } else {
                   12312:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12313:         if ($docuhome eq 'no_host') {
                   12314:             $error = &mt('Could not determine home server for course.');
                   12315:         } else {
                   12316:             my @ids=&Apache::lonnet::current_machine_ids();
                   12317:             my $currdir = "$dir_root/$destination";
                   12318:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12319:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   12320:                        "$dir_root/$destination";
                   12321:             } else {
                   12322:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   12323:                        "$dir_root/$docudom/$docuname/$destination";
                   12324:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   12325:                     $error = &mt('Archive file not found.');
                   12326:                 }
                   12327:             }
1.1065    raeburn  12328:             my (@to_overwrite,@to_skip);
                   12329:             if ($env{'form.archive_overwrite_total'} > 0) {
                   12330:                 my $total = $env{'form.archive_overwrite_total'};
                   12331:                 for (my $i=0; $i<$total; $i++) {
                   12332:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   12333:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   12334:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   12335:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   12336:                     }
                   12337:                 }
                   12338:             }
                   12339:             my $numskip = scalar(@to_skip);
1.1075.2.128  raeburn  12340:             my $numoverwrite = scalar(@to_overwrite);
                   12341:             if (($numskip) && (!$numoverwrite)) {
1.1065    raeburn  12342:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   12343:             } elsif ($dir eq '') {
1.1055    raeburn  12344:                 $error = &mt('Directory containing archive file unavailable.');
                   12345:             } elsif (!$error) {
1.1065    raeburn  12346:                 my ($decompressed,$display);
1.1075.2.128  raeburn  12347:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  12348:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   12349:                     mkdir("$dir/$tempdir",0755);
1.1075.2.128  raeburn  12350:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   12351:                         ($decompressed,$display) =
                   12352:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   12353:                         foreach my $item (@to_skip) {
                   12354:                             if (($item ne '') && ($item !~ /\.\./)) {
                   12355:                                 if (-f "$dir/$tempdir/$item") {
                   12356:                                     unlink("$dir/$tempdir/$item");
                   12357:                                 } elsif (-d "$dir/$tempdir/$item") {
                   12358:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
                   12359:                                 }
                   12360:                             }
                   12361:                         }
                   12362:                         foreach my $item (@to_overwrite) {
                   12363:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   12364:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   12365:                                     if (-f "$dir/$item") {
                   12366:                                         unlink("$dir/$item");
                   12367:                                     } elsif (-d "$dir/$item") {
                   12368:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
                   12369:                                     }
                   12370:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   12371:                                 }
1.1065    raeburn  12372:                             }
                   12373:                         }
1.1075.2.128  raeburn  12374:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
                   12375:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
                   12376:                         }
1.1065    raeburn  12377:                     }
                   12378:                 } else {
                   12379:                     ($decompressed,$display) = 
                   12380:                         &decompress_uploaded_file($file,$dir);
                   12381:                 }
1.1055    raeburn  12382:                 if ($decompressed eq 'ok') {
1.1065    raeburn  12383:                     $output = '<p class="LC_info">'.
                   12384:                               &mt('Files extracted successfully from archive.').
                   12385:                               '</p>'."\n";
1.1055    raeburn  12386:                     my ($warning,$result,@contents);
                   12387:                     my ($newdirlistref,$newlisterror) =
                   12388:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   12389:                                                  $docuname,1);
                   12390:                     my (%is_dir,%changes,@newitems);
                   12391:                     my $dirptr = 16384;
1.1065    raeburn  12392:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  12393:                         foreach my $dir_line (@{$newdirlistref}) {
                   12394:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1075.2.128  raeburn  12395:                             unless (($item =~ /^\.+$/) || ($item eq $file)) { 
1.1055    raeburn  12396:                                 push(@newitems,$item);
                   12397:                                 if ($dirptr&$testdir) {
                   12398:                                     $is_dir{$item} = 1;
                   12399:                                 }
                   12400:                                 $changes{$item} = 1;
                   12401:                             }
                   12402:                         }
                   12403:                     }
                   12404:                     if (keys(%changes) > 0) {
                   12405:                         foreach my $item (sort(@newitems)) {
                   12406:                             if ($changes{$item}) {
                   12407:                                 push(@contents,$item);
                   12408:                             }
                   12409:                         }
                   12410:                     }
                   12411:                     if (@contents > 0) {
1.1067    raeburn  12412:                         my $wantform;
                   12413:                         unless ($env{'form.autoextract_camtasia'}) {
                   12414:                             $wantform = 1;
                   12415:                         }
1.1056    raeburn  12416:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  12417:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   12418:                                                                 $currdir,\%is_dir,
                   12419:                                                                 \%children,\%parent,
1.1056    raeburn  12420:                                                                 \@contents,\%dirorder,
                   12421:                                                                 \%titles,$wantform);
1.1055    raeburn  12422:                         if ($datatable ne '') {
                   12423:                             $output .= &archive_options_form('decompressed',$datatable,
                   12424:                                                              $count,$hiddenelem);
1.1065    raeburn  12425:                             my $startcount = 6;
1.1055    raeburn  12426:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  12427:                                                            \%titles,\%children);
1.1055    raeburn  12428:                         }
1.1067    raeburn  12429:                         if ($env{'form.autoextract_camtasia'}) {
1.1075.2.59  raeburn  12430:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  12431:                             my %displayed;
                   12432:                             my $total = 1;
                   12433:                             $env{'form.archive_directory'} = [];
                   12434:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   12435:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   12436:                                 $path =~ s{/$}{};
                   12437:                                 my $item;
                   12438:                                 if ($path ne '') {
                   12439:                                     $item = "$path/$titles{$i}";
                   12440:                                 } else {
                   12441:                                     $item = $titles{$i};
                   12442:                                 }
                   12443:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   12444:                                 if ($item eq $contents[0]) {
                   12445:                                     push(@{$env{'form.archive_directory'}},$i);
                   12446:                                     $env{'form.archive_'.$i} = 'display';
                   12447:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   12448:                                     $displayed{'folder'} = $i;
1.1075.2.59  raeburn  12449:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   12450:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067    raeburn  12451:                                     $env{'form.archive_'.$i} = 'display';
                   12452:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   12453:                                     $displayed{'web'} = $i;
                   12454:                                 } else {
1.1075.2.59  raeburn  12455:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   12456:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   12457:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  12458:                                         push(@{$env{'form.archive_directory'}},$i);
                   12459:                                     }
                   12460:                                     $env{'form.archive_'.$i} = 'dependency';
                   12461:                                 }
                   12462:                                 $total ++;
                   12463:                             }
                   12464:                             for (my $i=1; $i<$total; $i++) {
                   12465:                                 next if ($i == $displayed{'web'});
                   12466:                                 next if ($i == $displayed{'folder'});
                   12467:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   12468:                             }
                   12469:                             $env{'form.phase'} = 'decompress_cleanup';
                   12470:                             $env{'form.archivedelete'} = 1;
                   12471:                             $env{'form.archive_count'} = $total-1;
                   12472:                             $output .=
                   12473:                                 &process_extracted_files('coursedocs',$docudom,
                   12474:                                                          $docuname,$destination,
                   12475:                                                          $dir_root,$hiddenelem);
                   12476:                         }
1.1055    raeburn  12477:                     } else {
                   12478:                         $warning = &mt('No new items extracted from archive file.');
                   12479:                     }
                   12480:                 } else {
                   12481:                     $output = $display;
                   12482:                     $error = &mt('An error occurred during extraction from the archive file.');
                   12483:                 }
                   12484:             }
                   12485:         }
                   12486:     }
                   12487:     if ($error) {
                   12488:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12489:                    $error.'</p>'."\n";
                   12490:     }
                   12491:     if ($warning) {
                   12492:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   12493:     }
                   12494:     return $output;
                   12495: }
                   12496: 
                   12497: sub get_extracted {
1.1056    raeburn  12498:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   12499:         $titles,$wantform) = @_;
1.1055    raeburn  12500:     my $count = 0;
                   12501:     my $depth = 0;
                   12502:     my $datatable;
1.1056    raeburn  12503:     my @hierarchy;
1.1055    raeburn  12504:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  12505:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   12506:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  12507:     foreach my $item (@{$contents}) {
                   12508:         $count ++;
1.1056    raeburn  12509:         @{$dirorder->{$count}} = @hierarchy;
                   12510:         $titles->{$count} = $item;
1.1055    raeburn  12511:         &archive_hierarchy($depth,$count,$parent,$children);
                   12512:         if ($wantform) {
                   12513:             $datatable .= &archive_row($is_dir->{$item},$item,
                   12514:                                        $currdir,$depth,$count);
                   12515:         }
                   12516:         if ($is_dir->{$item}) {
                   12517:             $depth ++;
1.1056    raeburn  12518:             push(@hierarchy,$count);
                   12519:             $parent->{$depth} = $count;
1.1055    raeburn  12520:             $datatable .=
                   12521:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  12522:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   12523:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  12524:             $depth --;
1.1056    raeburn  12525:             pop(@hierarchy);
1.1055    raeburn  12526:         }
                   12527:     }
                   12528:     return ($count,$datatable);
                   12529: }
                   12530: 
                   12531: sub recurse_extracted_archive {
1.1056    raeburn  12532:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   12533:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  12534:     my $result='';
1.1056    raeburn  12535:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   12536:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   12537:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  12538:         return $result;
                   12539:     }
                   12540:     my $dirptr = 16384;
                   12541:     my ($newdirlistref,$newlisterror) =
                   12542:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   12543:     if (ref($newdirlistref) eq 'ARRAY') {
                   12544:         foreach my $dir_line (@{$newdirlistref}) {
                   12545:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   12546:             unless ($item =~ /^\.+$/) {
                   12547:                 $$count ++;
1.1056    raeburn  12548:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   12549:                 $titles->{$$count} = $item;
1.1055    raeburn  12550:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  12551: 
1.1055    raeburn  12552:                 my $is_dir;
                   12553:                 if ($dirptr&$testdir) {
                   12554:                     $is_dir = 1;
                   12555:                 }
                   12556:                 if ($wantform) {
                   12557:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   12558:                 }
                   12559:                 if ($is_dir) {
                   12560:                     $$depth ++;
1.1056    raeburn  12561:                     push(@{$hierarchy},$$count);
                   12562:                     $parent->{$$depth} = $$count;
1.1055    raeburn  12563:                     $result .=
                   12564:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   12565:                                                    $docuname,$depth,$count,
1.1056    raeburn  12566:                                                    $hierarchy,$dirorder,$children,
                   12567:                                                    $parent,$titles,$wantform);
1.1055    raeburn  12568:                     $$depth --;
1.1056    raeburn  12569:                     pop(@{$hierarchy});
1.1055    raeburn  12570:                 }
                   12571:             }
                   12572:         }
                   12573:     }
                   12574:     return $result;
                   12575: }
                   12576: 
                   12577: sub archive_hierarchy {
                   12578:     my ($depth,$count,$parent,$children) =@_;
                   12579:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   12580:         if (exists($parent->{$depth})) {
                   12581:              $children->{$parent->{$depth}} .= $count.':';
                   12582:         }
                   12583:     }
                   12584:     return;
                   12585: }
                   12586: 
                   12587: sub archive_row {
                   12588:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   12589:     my ($name) = ($item =~ m{([^/]+)$});
                   12590:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  12591:                                        'display'    => 'Add as file',
1.1055    raeburn  12592:                                        'dependency' => 'Include as dependency',
                   12593:                                        'discard'    => 'Discard',
                   12594:                                       );
                   12595:     if ($is_dir) {
1.1059    raeburn  12596:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  12597:     }
1.1056    raeburn  12598:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   12599:     my $offset = 0;
1.1055    raeburn  12600:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  12601:         $offset ++;
1.1065    raeburn  12602:         if ($action ne 'display') {
                   12603:             $offset ++;
                   12604:         }  
1.1055    raeburn  12605:         $output .= '<td><span class="LC_nobreak">'.
                   12606:                    '<label><input type="radio" name="archive_'.$count.
                   12607:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   12608:         my $text = $choices{$action};
                   12609:         if ($is_dir) {
                   12610:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   12611:             if ($action eq 'display') {
1.1059    raeburn  12612:                 $text = &mt('Add as folder');
1.1055    raeburn  12613:             }
1.1056    raeburn  12614:         } else {
                   12615:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   12616: 
                   12617:         }
                   12618:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   12619:         if ($action eq 'dependency') {
                   12620:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   12621:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   12622:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   12623:                        '<option value=""></option>'."\n".
                   12624:                        '</select>'."\n".
                   12625:                        '</div>';
1.1059    raeburn  12626:         } elsif ($action eq 'display') {
                   12627:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   12628:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   12629:                        '</div>';
1.1055    raeburn  12630:         }
1.1056    raeburn  12631:         $output .= '</td>';
1.1055    raeburn  12632:     }
                   12633:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   12634:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   12635:     for (my $i=0; $i<$depth; $i++) {
                   12636:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   12637:     }
                   12638:     if ($is_dir) {
                   12639:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   12640:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   12641:     } else {
                   12642:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   12643:     }
                   12644:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   12645:                &end_data_table_row();
                   12646:     return $output;
                   12647: }
                   12648: 
                   12649: sub archive_options_form {
1.1065    raeburn  12650:     my ($form,$display,$count,$hiddenelem) = @_;
                   12651:     my %lt = &Apache::lonlocal::texthash(
                   12652:                perm => 'Permanently remove archive file?',
                   12653:                hows => 'How should each extracted item be incorporated in the course?',
                   12654:                cont => 'Content actions for all',
                   12655:                addf => 'Add as folder/file',
                   12656:                incd => 'Include as dependency for a displayed file',
                   12657:                disc => 'Discard',
                   12658:                no   => 'No',
                   12659:                yes  => 'Yes',
                   12660:                save => 'Save',
                   12661:     );
                   12662:     my $output = <<"END";
                   12663: <form name="$form" method="post" action="">
                   12664: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   12665: <label>
                   12666:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   12667: </label>
                   12668: &nbsp;
                   12669: <label>
                   12670:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   12671: </span>
                   12672: </p>
                   12673: <input type="hidden" name="phase" value="decompress_cleanup" />
                   12674: <br />$lt{'hows'}
                   12675: <div class="LC_columnSection">
                   12676:   <fieldset>
                   12677:     <legend>$lt{'cont'}</legend>
                   12678:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   12679:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   12680:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   12681:   </fieldset>
                   12682: </div>
                   12683: END
                   12684:     return $output.
1.1055    raeburn  12685:            &start_data_table()."\n".
1.1065    raeburn  12686:            $display."\n".
1.1055    raeburn  12687:            &end_data_table()."\n".
                   12688:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   12689:            $hiddenelem.
1.1065    raeburn  12690:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  12691:            '</form>';
                   12692: }
                   12693: 
                   12694: sub archive_javascript {
1.1056    raeburn  12695:     my ($startcount,$numitems,$titles,$children) = @_;
                   12696:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  12697:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  12698:     my $scripttag = <<START;
                   12699: <script type="text/javascript">
                   12700: // <![CDATA[
                   12701: 
                   12702: function checkAll(form,prefix) {
                   12703:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   12704:     for (var i=0; i < form.elements.length; i++) {
                   12705:         var id = form.elements[i].id;
                   12706:         if ((id != '') && (id != undefined)) {
                   12707:             if (idstr.test(id)) {
                   12708:                 if (form.elements[i].type == 'radio') {
                   12709:                     form.elements[i].checked = true;
1.1056    raeburn  12710:                     var nostart = i-$startcount;
1.1059    raeburn  12711:                     var offset = nostart%7;
                   12712:                     var count = (nostart-offset)/7;    
1.1056    raeburn  12713:                     dependencyCheck(form,count,offset);
1.1055    raeburn  12714:                 }
                   12715:             }
                   12716:         }
                   12717:     }
                   12718: }
                   12719: 
                   12720: function propagateCheck(form,count) {
                   12721:     if (count > 0) {
1.1059    raeburn  12722:         var startelement = $startcount + ((count-1) * 7);
                   12723:         for (var j=1; j<6; j++) {
                   12724:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  12725:                 var item = startelement + j; 
                   12726:                 if (form.elements[item].type == 'radio') {
                   12727:                     if (form.elements[item].checked) {
                   12728:                         containerCheck(form,count,j);
                   12729:                         break;
                   12730:                     }
1.1055    raeburn  12731:                 }
                   12732:             }
                   12733:         }
                   12734:     }
                   12735: }
                   12736: 
                   12737: numitems = $numitems
1.1056    raeburn  12738: var titles = new Array(numitems);
                   12739: var parents = new Array(numitems);
1.1055    raeburn  12740: for (var i=0; i<numitems; i++) {
1.1056    raeburn  12741:     parents[i] = new Array;
1.1055    raeburn  12742: }
1.1059    raeburn  12743: var maintitle = '$maintitle';
1.1055    raeburn  12744: 
                   12745: START
                   12746: 
1.1056    raeburn  12747:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   12748:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  12749:         for (my $i=0; $i<@contents; $i ++) {
                   12750:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   12751:         }
                   12752:     }
                   12753: 
1.1056    raeburn  12754:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   12755:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   12756:     }
                   12757: 
1.1055    raeburn  12758:     $scripttag .= <<END;
                   12759: 
                   12760: function containerCheck(form,count,offset) {
                   12761:     if (count > 0) {
1.1056    raeburn  12762:         dependencyCheck(form,count,offset);
1.1059    raeburn  12763:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  12764:         form.elements[item].checked = true;
                   12765:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12766:             if (parents[count].length > 0) {
                   12767:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  12768:                     containerCheck(form,parents[count][j],offset);
                   12769:                 }
                   12770:             }
                   12771:         }
                   12772:     }
                   12773: }
                   12774: 
                   12775: function dependencyCheck(form,count,offset) {
                   12776:     if (count > 0) {
1.1059    raeburn  12777:         var chosen = (offset+$startcount)+7*(count-1);
                   12778:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  12779:         var currtype = form.elements[depitem].type;
                   12780:         if (form.elements[chosen].value == 'dependency') {
                   12781:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   12782:             form.elements[depitem].options.length = 0;
                   12783:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11  raeburn  12784:             for (var i=1; i<=numitems; i++) {
                   12785:                 if (i == count) {
                   12786:                     continue;
                   12787:                 }
1.1059    raeburn  12788:                 var startelement = $startcount + (i-1) * 7;
                   12789:                 for (var j=1; j<6; j++) {
                   12790:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  12791:                         var item = startelement + j;
                   12792:                         if (form.elements[item].type == 'radio') {
                   12793:                             if (form.elements[item].checked) {
                   12794:                                 if (form.elements[item].value == 'display') {
                   12795:                                     var n = form.elements[depitem].options.length;
                   12796:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   12797:                                 }
                   12798:                             }
                   12799:                         }
                   12800:                     }
                   12801:                 }
                   12802:             }
                   12803:         } else {
                   12804:             document.getElementById('arc_depon_'+count).style.display='none';
                   12805:             form.elements[depitem].options.length = 0;
                   12806:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   12807:         }
1.1059    raeburn  12808:         titleCheck(form,count,offset);
1.1056    raeburn  12809:     }
                   12810: }
                   12811: 
                   12812: function propagateSelect(form,count,offset) {
                   12813:     if (count > 0) {
1.1065    raeburn  12814:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  12815:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   12816:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12817:             if (parents[count].length > 0) {
                   12818:                 for (var j=0; j<parents[count].length; j++) {
                   12819:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  12820:                 }
                   12821:             }
                   12822:         }
                   12823:     }
                   12824: }
1.1056    raeburn  12825: 
                   12826: function containerSelect(form,count,offset,picked) {
                   12827:     if (count > 0) {
1.1065    raeburn  12828:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  12829:         if (form.elements[item].type == 'radio') {
                   12830:             if (form.elements[item].value == 'dependency') {
                   12831:                 if (form.elements[item+1].type == 'select-one') {
                   12832:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   12833:                         if (form.elements[item+1].options[i].value == picked) {
                   12834:                             form.elements[item+1].selectedIndex = i;
                   12835:                             break;
                   12836:                         }
                   12837:                     }
                   12838:                 }
                   12839:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12840:                     if (parents[count].length > 0) {
                   12841:                         for (var j=0; j<parents[count].length; j++) {
                   12842:                             containerSelect(form,parents[count][j],offset,picked);
                   12843:                         }
                   12844:                     }
                   12845:                 }
                   12846:             }
                   12847:         }
                   12848:     }
                   12849: }
                   12850: 
1.1059    raeburn  12851: function titleCheck(form,count,offset) {
                   12852:     if (count > 0) {
                   12853:         var chosen = (offset+$startcount)+7*(count-1);
                   12854:         var depitem = $startcount + ((count-1) * 7) + 2;
                   12855:         var currtype = form.elements[depitem].type;
                   12856:         if (form.elements[chosen].value == 'display') {
                   12857:             document.getElementById('arc_title_'+count).style.display='block';
                   12858:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   12859:                 document.getElementById('archive_title_'+count).value=maintitle;
                   12860:             }
                   12861:         } else {
                   12862:             document.getElementById('arc_title_'+count).style.display='none';
                   12863:             if (currtype == 'text') { 
                   12864:                 document.getElementById('archive_title_'+count).value='';
                   12865:             }
                   12866:         }
                   12867:     }
                   12868:     return;
                   12869: }
                   12870: 
1.1055    raeburn  12871: // ]]>
                   12872: </script>
                   12873: END
                   12874:     return $scripttag;
                   12875: }
                   12876: 
                   12877: sub process_extracted_files {
1.1067    raeburn  12878:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  12879:     my $numitems = $env{'form.archive_count'};
1.1075.2.128  raeburn  12880:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  12881:     my @ids=&Apache::lonnet::current_machine_ids();
                   12882:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  12883:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  12884:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12885:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12886:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   12887:         $pathtocheck = "$dir_root/$destination";
                   12888:         $dir = $dir_root;
                   12889:         $ishome = 1;
                   12890:     } else {
                   12891:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   12892:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1075.2.128  raeburn  12893:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  12894:     }
                   12895:     my $currdir = "$dir_root/$destination";
                   12896:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   12897:     if ($env{'form.folderpath'}) {
                   12898:         my @items = split('&',$env{'form.folderpath'});
                   12899:         $folders{'0'} = $items[-2];
1.1075.2.17  raeburn  12900:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   12901:             $containers{'0'}='page';
                   12902:         } else {
                   12903:             $containers{'0'}='sequence';
                   12904:         }
1.1055    raeburn  12905:     }
                   12906:     my @archdirs = &get_env_multiple('form.archive_directory');
                   12907:     if ($numitems) {
                   12908:         for (my $i=1; $i<=$numitems; $i++) {
                   12909:             my $path = $env{'form.archive_content_'.$i};
                   12910:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   12911:                 my $item = $1;
                   12912:                 $toplevelitems{$item} = $i;
                   12913:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   12914:                     $is_dir{$item} = 1;
                   12915:                 }
                   12916:             }
                   12917:         }
                   12918:     }
1.1067    raeburn  12919:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  12920:     if (keys(%toplevelitems) > 0) {
                   12921:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  12922:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   12923:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  12924:     }
1.1066    raeburn  12925:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  12926:     if ($numitems) {
                   12927:         for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11  raeburn  12928:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  12929:             my $path = $env{'form.archive_content_'.$i};
                   12930:             if ($path =~ /^\Q$pathtocheck\E/) {
                   12931:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   12932:                     if ($prefix ne '' && $path ne '') {
                   12933:                         if (-e $prefix.$path) {
1.1066    raeburn  12934:                             if ((@archdirs > 0) && 
                   12935:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   12936:                                 $todeletedir{$prefix.$path} = 1;
                   12937:                             } else {
                   12938:                                 $todelete{$prefix.$path} = 1;
                   12939:                             }
1.1055    raeburn  12940:                         }
                   12941:                     }
                   12942:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  12943:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  12944:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  12945:                     $docstitle = $env{'form.archive_title_'.$i};
                   12946:                     if ($docstitle eq '') {
                   12947:                         $docstitle = $title;
                   12948:                     }
1.1055    raeburn  12949:                     $outer = 0;
1.1056    raeburn  12950:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   12951:                         if (@{$dirorder{$i}} > 0) {
                   12952:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  12953:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   12954:                                     $outer = $item;
                   12955:                                     last;
                   12956:                                 }
                   12957:                             }
                   12958:                         }
                   12959:                     }
                   12960:                     my ($errtext,$fatal) = 
                   12961:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   12962:                                                '/'.$folders{$outer}.'.'.
                   12963:                                                $containers{$outer});
                   12964:                     next if ($fatal);
                   12965:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   12966:                         if ($context eq 'coursedocs') {
1.1056    raeburn  12967:                             $mapinner{$i} = time;
1.1055    raeburn  12968:                             $folders{$i} = 'default_'.$mapinner{$i};
                   12969:                             $containers{$i} = 'sequence';
                   12970:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   12971:                                       $folders{$i}.'.'.$containers{$i};
                   12972:                             my $newidx = &LONCAPA::map::getresidx();
                   12973:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  12974:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  12975:                             push(@LONCAPA::map::order,$newidx);
                   12976:                             my ($outtext,$errtext) =
                   12977:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   12978:                                                         $docuname.'/'.$folders{$outer}.
1.1075.2.11  raeburn  12979:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  12980:                             $newseqid{$i} = $newidx;
1.1067    raeburn  12981:                             unless ($errtext) {
1.1075.2.128  raeburn  12982:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   12983:                                                        &HTML::Entities::encode($docstitle,'<>&"'))..
                   12984:                                             '</li>'."\n";
1.1067    raeburn  12985:                             }
1.1055    raeburn  12986:                         }
                   12987:                     } else {
                   12988:                         if ($context eq 'coursedocs') {
                   12989:                             my $newidx=&LONCAPA::map::getresidx();
                   12990:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   12991:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   12992:                                       $title;
1.1075.2.128  raeburn  12993:                             if (($outer !~ /\D/) && ($mapinner{$outer} !~ /\D/) && ($newidx !~ /\D/)) {
                   12994:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   12995:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
1.1067    raeburn  12996:                                 }
1.1075.2.128  raeburn  12997:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   12998:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   12999:                                 }
                   13000:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13001:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   13002:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   13003:                                         unless ($ishome) {
                   13004:                                             my $fetch = "$newdest{$i}/$title";
                   13005:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   13006:                                             $prompttofetch{$fetch} = 1;
                   13007:                                         }
                   13008:                                    }
                   13009:                                 }
                   13010:                                 $LONCAPA::map::resources[$newidx]=
                   13011:                                     $docstitle.':'.$url.':false:normal:res';
                   13012:                                 push(@LONCAPA::map::order, $newidx);
                   13013:                                 my ($outtext,$errtext)=
                   13014:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13015:                                                             $docuname.'/'.$folders{$outer}.
                   13016:                                                             '.'.$containers{$outer},1,1);
                   13017:                                 unless ($errtext) {
                   13018:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   13019:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   13020:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   13021:                                                    '</li>'."\n";
                   13022:                                     }
1.1067    raeburn  13023:                                 }
1.1075.2.128  raeburn  13024:                             } else {
                   13025:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13026:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1067    raeburn  13027:                             }
1.1055    raeburn  13028:                         }
                   13029:                     }
1.1075.2.11  raeburn  13030:                 }
                   13031:             } else {
1.1075.2.128  raeburn  13032:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13033:                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1075.2.11  raeburn  13034:             }
                   13035:         }
                   13036:         for (my $i=1; $i<=$numitems; $i++) {
                   13037:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   13038:             my $path = $env{'form.archive_content_'.$i};
                   13039:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13040:                 my ($title) = ($path =~ m{/([^/]+)$});
                   13041:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   13042:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   13043:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13044:                         my ($itemidx,$fullpath,$relpath);
                   13045:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   13046:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  13047:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11  raeburn  13048:                                 if ($dirorder{$i}->[$j] eq $container) {
                   13049:                                     $itemidx = $j;
1.1056    raeburn  13050:                                 }
                   13051:                             }
1.1075.2.11  raeburn  13052:                         }
                   13053:                         if ($itemidx eq '') {
                   13054:                             $itemidx =  0;
                   13055:                         }
                   13056:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   13057:                             if ($mapinner{$referrer{$i}}) {
                   13058:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   13059:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13060:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13061:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13062:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13063:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13064:                                             if (!-e $fullpath) {
                   13065:                                                 mkdir($fullpath,0755);
1.1056    raeburn  13066:                                             }
                   13067:                                         }
1.1075.2.11  raeburn  13068:                                     } else {
                   13069:                                         last;
1.1056    raeburn  13070:                                     }
1.1075.2.11  raeburn  13071:                                 }
                   13072:                             }
                   13073:                         } elsif ($newdest{$referrer{$i}}) {
                   13074:                             $fullpath = $newdest{$referrer{$i}};
                   13075:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13076:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   13077:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   13078:                                     last;
                   13079:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13080:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13081:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13082:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13083:                                         if (!-e $fullpath) {
                   13084:                                             mkdir($fullpath,0755);
1.1056    raeburn  13085:                                         }
                   13086:                                     }
1.1075.2.11  raeburn  13087:                                 } else {
                   13088:                                     last;
1.1056    raeburn  13089:                                 }
1.1075.2.11  raeburn  13090:                             }
                   13091:                         }
                   13092:                         if ($fullpath ne '') {
                   13093:                             if (-e "$prefix$path") {
1.1075.2.128  raeburn  13094:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   13095:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   13096:                                 }
1.1075.2.11  raeburn  13097:                             }
                   13098:                             if (-e "$fullpath/$title") {
                   13099:                                 my $showpath;
                   13100:                                 if ($relpath ne '') {
                   13101:                                     $showpath = "$relpath/$title";
                   13102:                                 } else {
                   13103:                                     $showpath = "/$title";
1.1056    raeburn  13104:                                 }
1.1075.2.128  raeburn  13105:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   13106:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   13107:                                            '</li>'."\n";
                   13108:                                 unless ($ishome) {
                   13109:                                     my $fetch = "$fullpath/$title";
                   13110:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   13111:                                     $prompttofetch{$fetch} = 1;
                   13112:                                 }
1.1055    raeburn  13113:                             }
                   13114:                         }
                   13115:                     }
1.1075.2.11  raeburn  13116:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   13117:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1075.2.128  raeburn  13118:                                     &HTML::Entities::encode($path,'<>&"'),
                   13119:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   13120:                                 '<br />';
1.1055    raeburn  13121:                 }
                   13122:             } else {
1.1075.2.128  raeburn  13123:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13124:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  13125:             }
                   13126:         }
                   13127:         if (keys(%todelete)) {
                   13128:             foreach my $key (keys(%todelete)) {
                   13129:                 unlink($key);
1.1066    raeburn  13130:             }
                   13131:         }
                   13132:         if (keys(%todeletedir)) {
                   13133:             foreach my $key (keys(%todeletedir)) {
                   13134:                 rmdir($key);
                   13135:             }
                   13136:         }
                   13137:         foreach my $dir (sort(keys(%is_dir))) {
                   13138:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   13139:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  13140:             }
                   13141:         }
1.1067    raeburn  13142:         if ($result ne '') {
                   13143:             $output .= '<ul>'."\n".
                   13144:                        $result."\n".
                   13145:                        '</ul>';
                   13146:         }
                   13147:         unless ($ishome) {
                   13148:             my $replicationfail;
                   13149:             foreach my $item (keys(%prompttofetch)) {
                   13150:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   13151:                 unless ($fetchresult eq 'ok') {
                   13152:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   13153:                 }
                   13154:             }
                   13155:             if ($replicationfail) {
                   13156:                 $output .= '<p class="LC_error">'.
                   13157:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   13158:                            $replicationfail.
                   13159:                            '</ul></p>';
                   13160:             }
                   13161:         }
1.1055    raeburn  13162:     } else {
                   13163:         $warning = &mt('No items found in archive.');
                   13164:     }
                   13165:     if ($error) {
                   13166:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   13167:                    $error.'</p>'."\n";
                   13168:     }
                   13169:     if ($warning) {
                   13170:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   13171:     }
                   13172:     return $output;
                   13173: }
                   13174: 
1.1066    raeburn  13175: sub cleanup_empty_dirs {
                   13176:     my ($path) = @_;
                   13177:     if (($path ne '') && (-d $path)) {
                   13178:         if (opendir(my $dirh,$path)) {
                   13179:             my @dircontents = grep(!/^\./,readdir($dirh));
                   13180:             my $numitems = 0;
                   13181:             foreach my $item (@dircontents) {
                   13182:                 if (-d "$path/$item") {
1.1075.2.28  raeburn  13183:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  13184:                     if (-e "$path/$item") {
                   13185:                         $numitems ++;
                   13186:                     }
                   13187:                 } else {
                   13188:                     $numitems ++;
                   13189:                 }
                   13190:             }
                   13191:             if ($numitems == 0) {
                   13192:                 rmdir($path);
                   13193:             }
                   13194:             closedir($dirh);
                   13195:         }
                   13196:     }
                   13197:     return;
                   13198: }
                   13199: 
1.41      ng       13200: =pod
1.45      matthew  13201: 
1.1075.2.56  raeburn  13202: =item * &get_folder_hierarchy()
1.1068    raeburn  13203: 
                   13204: Provides hierarchy of names of folders/sub-folders containing the current
                   13205: item,
                   13206: 
                   13207: Inputs: 3
                   13208:      - $navmap - navmaps object
                   13209: 
                   13210:      - $map - url for map (either the trigger itself, or map containing
                   13211:                            the resource, which is the trigger).
                   13212: 
                   13213:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   13214: 
                   13215: Outputs: 1 @pathitems - array of folder/subfolder names.
                   13216: 
                   13217: =cut
                   13218: 
                   13219: sub get_folder_hierarchy {
                   13220:     my ($navmap,$map,$showitem) = @_;
                   13221:     my @pathitems;
                   13222:     if (ref($navmap)) {
                   13223:         my $mapres = $navmap->getResourceByUrl($map);
                   13224:         if (ref($mapres)) {
                   13225:             my $pcslist = $mapres->map_hierarchy();
                   13226:             if ($pcslist ne '') {
                   13227:                 my @pcs = split(/,/,$pcslist);
                   13228:                 foreach my $pc (@pcs) {
                   13229:                     if ($pc == 1) {
1.1075.2.38  raeburn  13230:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  13231:                     } else {
                   13232:                         my $res = $navmap->getByMapPc($pc);
                   13233:                         if (ref($res)) {
                   13234:                             my $title = $res->compTitle();
                   13235:                             $title =~ s/\W+/_/g;
                   13236:                             if ($title ne '') {
                   13237:                                 push(@pathitems,$title);
                   13238:                             }
                   13239:                         }
                   13240:                     }
                   13241:                 }
                   13242:             }
1.1071    raeburn  13243:             if ($showitem) {
                   13244:                 if ($mapres->{ID} eq '0.0') {
1.1075.2.38  raeburn  13245:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  13246:                 } else {
                   13247:                     my $maptitle = $mapres->compTitle();
                   13248:                     $maptitle =~ s/\W+/_/g;
                   13249:                     if ($maptitle ne '') {
                   13250:                         push(@pathitems,$maptitle);
                   13251:                     }
1.1068    raeburn  13252:                 }
                   13253:             }
                   13254:         }
                   13255:     }
                   13256:     return @pathitems;
                   13257: }
                   13258: 
                   13259: =pod
                   13260: 
1.1015    raeburn  13261: =item * &get_turnedin_filepath()
                   13262: 
                   13263: Determines path in a user's portfolio file for storage of files uploaded
                   13264: to a specific essayresponse or dropbox item.
                   13265: 
                   13266: Inputs: 3 required + 1 optional.
                   13267: $symb is symb for resource, $uname and $udom are for current user (required).
                   13268: $caller is optional (can be "submission", if routine is called when storing
                   13269: an upoaded file when "Submit Answer" button was pressed).
                   13270: 
                   13271: Returns array containing $path and $multiresp. 
                   13272: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   13273: than one file upload item.  Callers of routine should append partid as a 
                   13274: subdirectory to $path in cases where $multiresp is 1.
                   13275: 
                   13276: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   13277: 
                   13278: =cut
                   13279: 
                   13280: sub get_turnedin_filepath {
                   13281:     my ($symb,$uname,$udom,$caller) = @_;
                   13282:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   13283:     my $turnindir;
                   13284:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   13285:     $turnindir = $userhash{'turnindir'};
                   13286:     my ($path,$multiresp);
                   13287:     if ($turnindir eq '') {
                   13288:         if ($caller eq 'submission') {
                   13289:             $turnindir = &mt('turned in');
                   13290:             $turnindir =~ s/\W+/_/g;
                   13291:             my %newhash = (
                   13292:                             'turnindir' => $turnindir,
                   13293:                           );
                   13294:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   13295:         }
                   13296:     }
                   13297:     if ($turnindir ne '') {
                   13298:         $path = '/'.$turnindir.'/';
                   13299:         my ($multipart,$turnin,@pathitems);
                   13300:         my $navmap = Apache::lonnavmaps::navmap->new();
                   13301:         if (defined($navmap)) {
                   13302:             my $mapres = $navmap->getResourceByUrl($map);
                   13303:             if (ref($mapres)) {
                   13304:                 my $pcslist = $mapres->map_hierarchy();
                   13305:                 if ($pcslist ne '') {
                   13306:                     foreach my $pc (split(/,/,$pcslist)) {
                   13307:                         my $res = $navmap->getByMapPc($pc);
                   13308:                         if (ref($res)) {
                   13309:                             my $title = $res->compTitle();
                   13310:                             $title =~ s/\W+/_/g;
                   13311:                             if ($title ne '') {
1.1075.2.48  raeburn  13312:                                 if (($pc > 1) && (length($title) > 12)) {
                   13313:                                     $title = substr($title,0,12);
                   13314:                                 }
1.1015    raeburn  13315:                                 push(@pathitems,$title);
                   13316:                             }
                   13317:                         }
                   13318:                     }
                   13319:                 }
                   13320:                 my $maptitle = $mapres->compTitle();
                   13321:                 $maptitle =~ s/\W+/_/g;
                   13322:                 if ($maptitle ne '') {
1.1075.2.48  raeburn  13323:                     if (length($maptitle) > 12) {
                   13324:                         $maptitle = substr($maptitle,0,12);
                   13325:                     }
1.1015    raeburn  13326:                     push(@pathitems,$maptitle);
                   13327:                 }
                   13328:                 unless ($env{'request.state'} eq 'construct') {
                   13329:                     my $res = $navmap->getBySymb($symb);
                   13330:                     if (ref($res)) {
                   13331:                         my $partlist = $res->parts();
                   13332:                         my $totaluploads = 0;
                   13333:                         if (ref($partlist) eq 'ARRAY') {
                   13334:                             foreach my $part (@{$partlist}) {
                   13335:                                 my @types = $res->responseType($part);
                   13336:                                 my @ids = $res->responseIds($part);
                   13337:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   13338:                                     if ($types[$i] eq 'essay') {
                   13339:                                         my $partid = $part.'_'.$ids[$i];
                   13340:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   13341:                                             $totaluploads ++;
                   13342:                                         }
                   13343:                                     }
                   13344:                                 }
                   13345:                             }
                   13346:                             if ($totaluploads > 1) {
                   13347:                                 $multiresp = 1;
                   13348:                             }
                   13349:                         }
                   13350:                     }
                   13351:                 }
                   13352:             } else {
                   13353:                 return;
                   13354:             }
                   13355:         } else {
                   13356:             return;
                   13357:         }
                   13358:         my $restitle=&Apache::lonnet::gettitle($symb);
                   13359:         $restitle =~ s/\W+/_/g;
                   13360:         if ($restitle eq '') {
                   13361:             $restitle = ($resurl =~ m{/[^/]+$});
                   13362:             if ($restitle eq '') {
                   13363:                 $restitle = time;
                   13364:             }
                   13365:         }
1.1075.2.48  raeburn  13366:         if (length($restitle) > 12) {
                   13367:             $restitle = substr($restitle,0,12);
                   13368:         }
1.1015    raeburn  13369:         push(@pathitems,$restitle);
                   13370:         $path .= join('/',@pathitems);
                   13371:     }
                   13372:     return ($path,$multiresp);
                   13373: }
                   13374: 
                   13375: =pod
                   13376: 
1.464     albertel 13377: =back
1.41      ng       13378: 
1.112     bowersj2 13379: =head1 CSV Upload/Handling functions
1.38      albertel 13380: 
1.41      ng       13381: =over 4
                   13382: 
1.648     raeburn  13383: =item * &upfile_store($r)
1.41      ng       13384: 
                   13385: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 13386: needs $env{'form.upfile'}
1.41      ng       13387: returns $datatoken to be put into hidden field
                   13388: 
                   13389: =cut
1.31      albertel 13390: 
                   13391: sub upfile_store {
                   13392:     my $r=shift;
1.258     albertel 13393:     $env{'form.upfile'}=~s/\r/\n/gs;
                   13394:     $env{'form.upfile'}=~s/\f/\n/gs;
                   13395:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   13396:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 13397: 
1.1075.2.128  raeburn  13398:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   13399:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   13400:                                      time.'_'.$$);
                   13401:     return if ($datatoken eq '');
                   13402: 
1.31      albertel 13403:     {
1.158     raeburn  13404:         my $datafile = $r->dir_config('lonDaemons').
                   13405:                            '/tmp/'.$datatoken.'.tmp';
1.1075.2.128  raeburn  13406:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 13407:             print $fh $env{'form.upfile'};
1.158     raeburn  13408:             close($fh);
                   13409:         }
1.31      albertel 13410:     }
                   13411:     return $datatoken;
                   13412: }
                   13413: 
1.56      matthew  13414: =pod
                   13415: 
1.1075.2.128  raeburn  13416: =item * &load_tmp_file($r,$datatoken)
1.41      ng       13417: 
                   13418: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1075.2.128  raeburn  13419: $datatoken is the name to assign to the temporary file.
1.258     albertel 13420: sets $env{'form.upfile'} to the contents of the file
1.41      ng       13421: 
                   13422: =cut
1.31      albertel 13423: 
                   13424: sub load_tmp_file {
1.1075.2.128  raeburn  13425:     my ($r,$datatoken) = @_;
                   13426:     return if ($datatoken eq '');
1.31      albertel 13427:     my @studentdata=();
                   13428:     {
1.158     raeburn  13429:         my $studentfile = $r->dir_config('lonDaemons').
1.1075.2.128  raeburn  13430:                               '/tmp/'.$datatoken.'.tmp';
                   13431:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  13432:             @studentdata=<$fh>;
                   13433:             close($fh);
                   13434:         }
1.31      albertel 13435:     }
1.258     albertel 13436:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 13437: }
                   13438: 
1.1075.2.128  raeburn  13439: sub valid_datatoken {
                   13440:     my ($datatoken) = @_;
1.1075.2.131  raeburn  13441:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1075.2.128  raeburn  13442:         return $datatoken;
                   13443:     }
                   13444:     return;
                   13445: }
                   13446: 
1.56      matthew  13447: =pod
                   13448: 
1.648     raeburn  13449: =item * &upfile_record_sep()
1.41      ng       13450: 
                   13451: Separate uploaded file into records
                   13452: returns array of records,
1.258     albertel 13453: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       13454: 
                   13455: =cut
1.31      albertel 13456: 
                   13457: sub upfile_record_sep {
1.258     albertel 13458:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 13459:     } else {
1.248     albertel 13460: 	my @records;
1.258     albertel 13461: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 13462: 	    if ($line=~/^\s*$/) { next; }
                   13463: 	    push(@records,$line);
                   13464: 	}
                   13465: 	return @records;
1.31      albertel 13466:     }
                   13467: }
                   13468: 
1.56      matthew  13469: =pod
                   13470: 
1.648     raeburn  13471: =item * &record_sep($record)
1.41      ng       13472: 
1.258     albertel 13473: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       13474: 
                   13475: =cut
                   13476: 
1.263     www      13477: sub takeleft {
                   13478:     my $index=shift;
                   13479:     return substr('0000'.$index,-4,4);
                   13480: }
                   13481: 
1.31      albertel 13482: sub record_sep {
                   13483:     my $record=shift;
                   13484:     my %components=();
1.258     albertel 13485:     if ($env{'form.upfiletype'} eq 'xml') {
                   13486:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 13487:         my $i=0;
1.356     albertel 13488:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 13489:             $field=~s/^(\"|\')//;
                   13490:             $field=~s/(\"|\')$//;
1.263     www      13491:             $components{&takeleft($i)}=$field;
1.31      albertel 13492:             $i++;
                   13493:         }
1.258     albertel 13494:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 13495:         my $i=0;
1.356     albertel 13496:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 13497:             $field=~s/^(\"|\')//;
                   13498:             $field=~s/(\"|\')$//;
1.263     www      13499:             $components{&takeleft($i)}=$field;
1.31      albertel 13500:             $i++;
                   13501:         }
                   13502:     } else {
1.561     www      13503:         my $separator=',';
1.480     banghart 13504:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      13505:             $separator=';';
1.480     banghart 13506:         }
1.31      albertel 13507:         my $i=0;
1.561     www      13508: # the character we are looking for to indicate the end of a quote or a record 
                   13509:         my $looking_for=$separator;
                   13510: # do not add the characters to the fields
                   13511:         my $ignore=0;
                   13512: # we just encountered a separator (or the beginning of the record)
                   13513:         my $just_found_separator=1;
                   13514: # store the field we are working on here
                   13515:         my $field='';
                   13516: # work our way through all characters in record
                   13517:         foreach my $character ($record=~/(.)/g) {
                   13518:             if ($character eq $looking_for) {
                   13519:                if ($character ne $separator) {
                   13520: # Found the end of a quote, again looking for separator
                   13521:                   $looking_for=$separator;
                   13522:                   $ignore=1;
                   13523:                } else {
                   13524: # Found a separator, store away what we got
                   13525:                   $components{&takeleft($i)}=$field;
                   13526: 	          $i++;
                   13527:                   $just_found_separator=1;
                   13528:                   $ignore=0;
                   13529:                   $field='';
                   13530:                }
                   13531:                next;
                   13532:             }
                   13533: # single or double quotation marks after a separator indicate beginning of a quote
                   13534: # we are now looking for the end of the quote and need to ignore separators
                   13535:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   13536:                $looking_for=$character;
                   13537:                next;
                   13538:             }
                   13539: # ignore would be true after we reached the end of a quote
                   13540:             if ($ignore) { next; }
                   13541:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   13542:             $field.=$character;
                   13543:             $just_found_separator=0; 
1.31      albertel 13544:         }
1.561     www      13545: # catch the very last entry, since we never encountered the separator
                   13546:         $components{&takeleft($i)}=$field;
1.31      albertel 13547:     }
                   13548:     return %components;
                   13549: }
                   13550: 
1.144     matthew  13551: ######################################################
                   13552: ######################################################
                   13553: 
1.56      matthew  13554: =pod
                   13555: 
1.648     raeburn  13556: =item * &upfile_select_html()
1.41      ng       13557: 
1.144     matthew  13558: Return HTML code to select a file from the users machine and specify 
                   13559: the file type.
1.41      ng       13560: 
                   13561: =cut
                   13562: 
1.144     matthew  13563: ######################################################
                   13564: ######################################################
1.31      albertel 13565: sub upfile_select_html {
1.144     matthew  13566:     my %Types = (
                   13567:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 13568:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  13569:                  space => &mt('Space separated'),
                   13570:                  tab   => &mt('Tabulator separated'),
                   13571: #                 xml   => &mt('HTML/XML'),
                   13572:                  );
                   13573:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  13574:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  13575:     foreach my $type (sort(keys(%Types))) {
                   13576:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   13577:     }
                   13578:     $Str .= "</select>\n";
                   13579:     return $Str;
1.31      albertel 13580: }
                   13581: 
1.301     albertel 13582: sub get_samples {
                   13583:     my ($records,$toget) = @_;
                   13584:     my @samples=({});
                   13585:     my $got=0;
                   13586:     foreach my $rec (@$records) {
                   13587: 	my %temp = &record_sep($rec);
                   13588: 	if (! grep(/\S/, values(%temp))) { next; }
                   13589: 	if (%temp) {
                   13590: 	    $samples[$got]=\%temp;
                   13591: 	    $got++;
                   13592: 	    if ($got == $toget) { last; }
                   13593: 	}
                   13594:     }
                   13595:     return \@samples;
                   13596: }
                   13597: 
1.144     matthew  13598: ######################################################
                   13599: ######################################################
                   13600: 
1.56      matthew  13601: =pod
                   13602: 
1.648     raeburn  13603: =item * &csv_print_samples($r,$records)
1.41      ng       13604: 
                   13605: Prints a table of sample values from each column uploaded $r is an
                   13606: Apache Request ref, $records is an arrayref from
                   13607: &Apache::loncommon::upfile_record_sep
                   13608: 
                   13609: =cut
                   13610: 
1.144     matthew  13611: ######################################################
                   13612: ######################################################
1.31      albertel 13613: sub csv_print_samples {
                   13614:     my ($r,$records) = @_;
1.662     bisitz   13615:     my $samples = &get_samples($records,5);
1.301     albertel 13616: 
1.594     raeburn  13617:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   13618:               &start_data_table_header_row());
1.356     albertel 13619:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   13620:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  13621:     $r->print(&end_data_table_header_row());
1.301     albertel 13622:     foreach my $hash (@$samples) {
1.594     raeburn  13623: 	$r->print(&start_data_table_row());
1.356     albertel 13624: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 13625: 	    $r->print('<td>');
1.356     albertel 13626: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 13627: 	    $r->print('</td>');
                   13628: 	}
1.594     raeburn  13629: 	$r->print(&end_data_table_row());
1.31      albertel 13630:     }
1.594     raeburn  13631:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 13632: }
                   13633: 
1.144     matthew  13634: ######################################################
                   13635: ######################################################
                   13636: 
1.56      matthew  13637: =pod
                   13638: 
1.648     raeburn  13639: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       13640: 
                   13641: Prints a table to create associations between values and table columns.
1.144     matthew  13642: 
1.41      ng       13643: $r is an Apache Request ref,
                   13644: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  13645: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       13646: 
                   13647: =cut
                   13648: 
1.144     matthew  13649: ######################################################
                   13650: ######################################################
1.31      albertel 13651: sub csv_print_select_table {
                   13652:     my ($r,$records,$d) = @_;
1.301     albertel 13653:     my $i=0;
                   13654:     my $samples = &get_samples($records,1);
1.144     matthew  13655:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  13656: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  13657:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  13658:               '<th>'.&mt('Column').'</th>'.
                   13659:               &end_data_table_header_row()."\n");
1.356     albertel 13660:     foreach my $array_ref (@$d) {
                   13661: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  13662: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 13663: 
1.875     bisitz   13664: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  13665: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 13666: 	$r->print('<option value="none"></option>');
1.356     albertel 13667: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   13668: 	    $r->print('<option value="'.$sample.'"'.
                   13669:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   13670:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 13671: 	}
1.594     raeburn  13672: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 13673: 	$i++;
                   13674:     }
1.594     raeburn  13675:     $r->print(&end_data_table());
1.31      albertel 13676:     $i--;
                   13677:     return $i;
                   13678: }
1.56      matthew  13679: 
1.144     matthew  13680: ######################################################
                   13681: ######################################################
                   13682: 
1.56      matthew  13683: =pod
1.31      albertel 13684: 
1.648     raeburn  13685: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       13686: 
                   13687: Prints a table of sample values from the upload and can make associate samples to internal names.
                   13688: 
                   13689: $r is an Apache Request ref,
                   13690: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   13691: $d is an array of 2 element arrays (internal name, displayed name)
                   13692: 
                   13693: =cut
                   13694: 
1.144     matthew  13695: ######################################################
                   13696: ######################################################
1.31      albertel 13697: sub csv_samples_select_table {
                   13698:     my ($r,$records,$d) = @_;
                   13699:     my $i=0;
1.144     matthew  13700:     #
1.662     bisitz   13701:     my $max_samples = 5;
                   13702:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  13703:     $r->print(&start_data_table().
                   13704:               &start_data_table_header_row().'<th>'.
                   13705:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   13706:               &end_data_table_header_row());
1.301     albertel 13707: 
                   13708:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  13709: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  13710: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 13711: 	foreach my $option (@$d) {
                   13712: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  13713: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 13714:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  13715:                       $display.'</option>');
1.31      albertel 13716: 	}
                   13717: 	$r->print('</select></td><td>');
1.662     bisitz   13718: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 13719: 	    if (defined($samples->[$line]{$key})) { 
                   13720: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   13721: 	    }
                   13722: 	}
1.594     raeburn  13723: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 13724: 	$i++;
                   13725:     }
1.594     raeburn  13726:     $r->print(&end_data_table());
1.31      albertel 13727:     $i--;
                   13728:     return($i);
1.115     matthew  13729: }
                   13730: 
1.144     matthew  13731: ######################################################
                   13732: ######################################################
                   13733: 
1.115     matthew  13734: =pod
                   13735: 
1.648     raeburn  13736: =item * &clean_excel_name($name)
1.115     matthew  13737: 
                   13738: Returns a replacement for $name which does not contain any illegal characters.
                   13739: 
                   13740: =cut
                   13741: 
1.144     matthew  13742: ######################################################
                   13743: ######################################################
1.115     matthew  13744: sub clean_excel_name {
                   13745:     my ($name) = @_;
                   13746:     $name =~ s/[:\*\?\/\\]//g;
                   13747:     if (length($name) > 31) {
                   13748:         $name = substr($name,0,31);
                   13749:     }
                   13750:     return $name;
1.25      albertel 13751: }
1.84      albertel 13752: 
1.85      albertel 13753: =pod
                   13754: 
1.648     raeburn  13755: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 13756: 
                   13757: Returns either 1 or undef
                   13758: 
                   13759: 1 if the part is to be hidden, undef if it is to be shown
                   13760: 
                   13761: Arguments are:
                   13762: 
                   13763: $id the id of the part to be checked
                   13764: $symb, optional the symb of the resource to check
                   13765: $udom, optional the domain of the user to check for
                   13766: $uname, optional the username of the user to check for
                   13767: 
                   13768: =cut
1.84      albertel 13769: 
                   13770: sub check_if_partid_hidden {
                   13771:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 13772:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 13773: 					 $symb,$udom,$uname);
1.141     albertel 13774:     my $truth=1;
                   13775:     #if the string starts with !, then the list is the list to show not hide
                   13776:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 13777:     my @hiddenlist=split(/,/,$hiddenparts);
                   13778:     foreach my $checkid (@hiddenlist) {
1.141     albertel 13779: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 13780:     }
1.141     albertel 13781:     return !$truth;
1.84      albertel 13782: }
1.127     matthew  13783: 
1.138     matthew  13784: 
                   13785: ############################################################
                   13786: ############################################################
                   13787: 
                   13788: =pod
                   13789: 
1.157     matthew  13790: =back 
                   13791: 
1.138     matthew  13792: =head1 cgi-bin script and graphing routines
                   13793: 
1.157     matthew  13794: =over 4
                   13795: 
1.648     raeburn  13796: =item * &get_cgi_id()
1.138     matthew  13797: 
                   13798: Inputs: none
                   13799: 
                   13800: Returns an id which can be used to pass environment variables
                   13801: to various cgi-bin scripts.  These environment variables will
                   13802: be removed from the users environment after a given time by
                   13803: the routine &Apache::lonnet::transfer_profile_to_env.
                   13804: 
                   13805: =cut
                   13806: 
                   13807: ############################################################
                   13808: ############################################################
1.152     albertel 13809: my $uniq=0;
1.136     matthew  13810: sub get_cgi_id {
1.154     albertel 13811:     $uniq=($uniq+1)%100000;
1.280     albertel 13812:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  13813: }
                   13814: 
1.127     matthew  13815: ############################################################
                   13816: ############################################################
                   13817: 
                   13818: =pod
                   13819: 
1.648     raeburn  13820: =item * &DrawBarGraph()
1.127     matthew  13821: 
1.138     matthew  13822: Facilitates the plotting of data in a (stacked) bar graph.
                   13823: Puts plot definition data into the users environment in order for 
                   13824: graph.png to plot it.  Returns an <img> tag for the plot.
                   13825: The bars on the plot are labeled '1','2',...,'n'.
                   13826: 
                   13827: Inputs:
                   13828: 
                   13829: =over 4
                   13830: 
                   13831: =item $Title: string, the title of the plot
                   13832: 
                   13833: =item $xlabel: string, text describing the X-axis of the plot
                   13834: 
                   13835: =item $ylabel: string, text describing the Y-axis of the plot
                   13836: 
                   13837: =item $Max: scalar, the maximum Y value to use in the plot
                   13838: If $Max is < any data point, the graph will not be rendered.
                   13839: 
1.140     matthew  13840: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  13841: they are plotted.  If undefined, default values will be used.
                   13842: 
1.178     matthew  13843: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   13844: 
1.138     matthew  13845: =item @Values: An array of array references.  Each array reference holds data
                   13846: to be plotted in a stacked bar chart.
                   13847: 
1.239     matthew  13848: =item If the final element of @Values is a hash reference the key/value
                   13849: pairs will be added to the graph definition.
                   13850: 
1.138     matthew  13851: =back
                   13852: 
                   13853: Returns:
                   13854: 
                   13855: An <img> tag which references graph.png and the appropriate identifying
                   13856: information for the plot.
                   13857: 
1.127     matthew  13858: =cut
                   13859: 
                   13860: ############################################################
                   13861: ############################################################
1.134     matthew  13862: sub DrawBarGraph {
1.178     matthew  13863:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  13864:     #
                   13865:     if (! defined($colors)) {
                   13866:         $colors = ['#33ff00', 
                   13867:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   13868:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   13869:                   ]; 
                   13870:     }
1.228     matthew  13871:     my $extra_settings = {};
                   13872:     if (ref($Values[-1]) eq 'HASH') {
                   13873:         $extra_settings = pop(@Values);
                   13874:     }
1.127     matthew  13875:     #
1.136     matthew  13876:     my $identifier = &get_cgi_id();
                   13877:     my $id = 'cgi.'.$identifier;        
1.129     matthew  13878:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  13879:         return '';
                   13880:     }
1.225     matthew  13881:     #
                   13882:     my @Labels;
                   13883:     if (defined($labels)) {
                   13884:         @Labels = @$labels;
                   13885:     } else {
                   13886:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1075.2.119  raeburn  13887:             push(@Labels,$i+1);
1.225     matthew  13888:         }
                   13889:     }
                   13890:     #
1.129     matthew  13891:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  13892:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  13893:     my %ValuesHash;
                   13894:     my $NumSets=1;
                   13895:     foreach my $array (@Values) {
                   13896:         next if (! ref($array));
1.136     matthew  13897:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  13898:             join(',',@$array);
1.129     matthew  13899:     }
1.127     matthew  13900:     #
1.136     matthew  13901:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  13902:     if ($NumBars < 3) {
                   13903:         $width = 120+$NumBars*32;
1.220     matthew  13904:         $xskip = 1;
1.225     matthew  13905:         $bar_width = 30;
                   13906:     } elsif ($NumBars < 5) {
                   13907:         $width = 120+$NumBars*20;
                   13908:         $xskip = 1;
                   13909:         $bar_width = 20;
1.220     matthew  13910:     } elsif ($NumBars < 10) {
1.136     matthew  13911:         $width = 120+$NumBars*15;
                   13912:         $xskip = 1;
                   13913:         $bar_width = 15;
                   13914:     } elsif ($NumBars <= 25) {
                   13915:         $width = 120+$NumBars*11;
                   13916:         $xskip = 5;
                   13917:         $bar_width = 8;
                   13918:     } elsif ($NumBars <= 50) {
                   13919:         $width = 120+$NumBars*8;
                   13920:         $xskip = 5;
                   13921:         $bar_width = 4;
                   13922:     } else {
                   13923:         $width = 120+$NumBars*8;
                   13924:         $xskip = 5;
                   13925:         $bar_width = 4;
                   13926:     }
                   13927:     #
1.137     matthew  13928:     $Max = 1 if ($Max < 1);
                   13929:     if ( int($Max) < $Max ) {
                   13930:         $Max++;
                   13931:         $Max = int($Max);
                   13932:     }
1.127     matthew  13933:     $Title  = '' if (! defined($Title));
                   13934:     $xlabel = '' if (! defined($xlabel));
                   13935:     $ylabel = '' if (! defined($ylabel));
1.369     www      13936:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   13937:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   13938:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  13939:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  13940:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   13941:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   13942:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   13943:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   13944:     $ValuesHash{$id.'.height'}   = $height;
                   13945:     $ValuesHash{$id.'.width'}    = $width;
                   13946:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   13947:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   13948:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  13949:     #
1.228     matthew  13950:     # Deal with other parameters
                   13951:     while (my ($key,$value) = each(%$extra_settings)) {
                   13952:         $ValuesHash{$id.'.'.$key} = $value;
                   13953:     }
                   13954:     #
1.646     raeburn  13955:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  13956:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   13957: }
                   13958: 
                   13959: ############################################################
                   13960: ############################################################
                   13961: 
                   13962: =pod
                   13963: 
1.648     raeburn  13964: =item * &DrawXYGraph()
1.137     matthew  13965: 
1.138     matthew  13966: Facilitates the plotting of data in an XY graph.
                   13967: Puts plot definition data into the users environment in order for 
                   13968: graph.png to plot it.  Returns an <img> tag for the plot.
                   13969: 
                   13970: Inputs:
                   13971: 
                   13972: =over 4
                   13973: 
                   13974: =item $Title: string, the title of the plot
                   13975: 
                   13976: =item $xlabel: string, text describing the X-axis of the plot
                   13977: 
                   13978: =item $ylabel: string, text describing the Y-axis of the plot
                   13979: 
                   13980: =item $Max: scalar, the maximum Y value to use in the plot
                   13981: If $Max is < any data point, the graph will not be rendered.
                   13982: 
                   13983: =item $colors: Array ref containing the hex color codes for the data to be 
                   13984: plotted in.  If undefined, default values will be used.
                   13985: 
                   13986: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   13987: 
                   13988: =item $Ydata: Array ref containing Array refs.  
1.185     www      13989: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  13990: 
                   13991: =item %Values: hash indicating or overriding any default values which are 
                   13992: passed to graph.png.  
                   13993: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   13994: 
                   13995: =back
                   13996: 
                   13997: Returns:
                   13998: 
                   13999: An <img> tag which references graph.png and the appropriate identifying
                   14000: information for the plot.
                   14001: 
1.137     matthew  14002: =cut
                   14003: 
                   14004: ############################################################
                   14005: ############################################################
                   14006: sub DrawXYGraph {
                   14007:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   14008:     #
                   14009:     # Create the identifier for the graph
                   14010:     my $identifier = &get_cgi_id();
                   14011:     my $id = 'cgi.'.$identifier;
                   14012:     #
                   14013:     $Title  = '' if (! defined($Title));
                   14014:     $xlabel = '' if (! defined($xlabel));
                   14015:     $ylabel = '' if (! defined($ylabel));
                   14016:     my %ValuesHash = 
                   14017:         (
1.369     www      14018:          $id.'.title'  => &escape($Title),
                   14019:          $id.'.xlabel' => &escape($xlabel),
                   14020:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  14021:          $id.'.y_max_value'=> $Max,
                   14022:          $id.'.labels'     => join(',',@$Xlabels),
                   14023:          $id.'.PlotType'   => 'XY',
                   14024:          );
                   14025:     #
                   14026:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14027:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14028:     }
                   14029:     #
                   14030:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   14031:         return '';
                   14032:     }
                   14033:     my $NumSets=1;
1.138     matthew  14034:     foreach my $array (@{$Ydata}){
1.137     matthew  14035:         next if (! ref($array));
                   14036:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   14037:     }
1.138     matthew  14038:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  14039:     #
                   14040:     # Deal with other parameters
                   14041:     while (my ($key,$value) = each(%Values)) {
                   14042:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  14043:     }
                   14044:     #
1.646     raeburn  14045:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  14046:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14047: }
                   14048: 
                   14049: ############################################################
                   14050: ############################################################
                   14051: 
                   14052: =pod
                   14053: 
1.648     raeburn  14054: =item * &DrawXYYGraph()
1.138     matthew  14055: 
                   14056: Facilitates the plotting of data in an XY graph with two Y axes.
                   14057: Puts plot definition data into the users environment in order for 
                   14058: graph.png to plot it.  Returns an <img> tag for the plot.
                   14059: 
                   14060: Inputs:
                   14061: 
                   14062: =over 4
                   14063: 
                   14064: =item $Title: string, the title of the plot
                   14065: 
                   14066: =item $xlabel: string, text describing the X-axis of the plot
                   14067: 
                   14068: =item $ylabel: string, text describing the Y-axis of the plot
                   14069: 
                   14070: =item $colors: Array ref containing the hex color codes for the data to be 
                   14071: plotted in.  If undefined, default values will be used.
                   14072: 
                   14073: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14074: 
                   14075: =item $Ydata1: The first data set
                   14076: 
                   14077: =item $Min1: The minimum value of the left Y-axis
                   14078: 
                   14079: =item $Max1: The maximum value of the left Y-axis
                   14080: 
                   14081: =item $Ydata2: The second data set
                   14082: 
                   14083: =item $Min2: The minimum value of the right Y-axis
                   14084: 
                   14085: =item $Max2: The maximum value of the left Y-axis
                   14086: 
                   14087: =item %Values: hash indicating or overriding any default values which are 
                   14088: passed to graph.png.  
                   14089: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14090: 
                   14091: =back
                   14092: 
                   14093: Returns:
                   14094: 
                   14095: An <img> tag which references graph.png and the appropriate identifying
                   14096: information for the plot.
1.136     matthew  14097: 
                   14098: =cut
                   14099: 
                   14100: ############################################################
                   14101: ############################################################
1.137     matthew  14102: sub DrawXYYGraph {
                   14103:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   14104:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  14105:     #
                   14106:     # Create the identifier for the graph
                   14107:     my $identifier = &get_cgi_id();
                   14108:     my $id = 'cgi.'.$identifier;
                   14109:     #
                   14110:     $Title  = '' if (! defined($Title));
                   14111:     $xlabel = '' if (! defined($xlabel));
                   14112:     $ylabel = '' if (! defined($ylabel));
                   14113:     my %ValuesHash = 
                   14114:         (
1.369     www      14115:          $id.'.title'  => &escape($Title),
                   14116:          $id.'.xlabel' => &escape($xlabel),
                   14117:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  14118:          $id.'.labels' => join(',',@$Xlabels),
                   14119:          $id.'.PlotType' => 'XY',
                   14120:          $id.'.NumSets' => 2,
1.137     matthew  14121:          $id.'.two_axes' => 1,
                   14122:          $id.'.y1_max_value' => $Max1,
                   14123:          $id.'.y1_min_value' => $Min1,
                   14124:          $id.'.y2_max_value' => $Max2,
                   14125:          $id.'.y2_min_value' => $Min2,
1.136     matthew  14126:          );
                   14127:     #
1.137     matthew  14128:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14129:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14130:     }
                   14131:     #
                   14132:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   14133:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  14134:         return '';
                   14135:     }
                   14136:     my $NumSets=1;
1.137     matthew  14137:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  14138:         next if (! ref($array));
                   14139:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  14140:     }
                   14141:     #
                   14142:     # Deal with other parameters
                   14143:     while (my ($key,$value) = each(%Values)) {
                   14144:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  14145:     }
                   14146:     #
1.646     raeburn  14147:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 14148:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  14149: }
                   14150: 
                   14151: ############################################################
                   14152: ############################################################
                   14153: 
                   14154: =pod
                   14155: 
1.157     matthew  14156: =back 
                   14157: 
1.139     matthew  14158: =head1 Statistics helper routines?  
                   14159: 
                   14160: Bad place for them but what the hell.
                   14161: 
1.157     matthew  14162: =over 4
                   14163: 
1.648     raeburn  14164: =item * &chartlink()
1.139     matthew  14165: 
                   14166: Returns a link to the chart for a specific student.  
                   14167: 
                   14168: Inputs:
                   14169: 
                   14170: =over 4
                   14171: 
                   14172: =item $linktext: The text of the link
                   14173: 
                   14174: =item $sname: The students username
                   14175: 
                   14176: =item $sdomain: The students domain
                   14177: 
                   14178: =back
                   14179: 
1.157     matthew  14180: =back
                   14181: 
1.139     matthew  14182: =cut
                   14183: 
                   14184: ############################################################
                   14185: ############################################################
                   14186: sub chartlink {
                   14187:     my ($linktext, $sname, $sdomain) = @_;
                   14188:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      14189:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 14190:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  14191:        '">'.$linktext.'</a>';
1.153     matthew  14192: }
                   14193: 
                   14194: #######################################################
                   14195: #######################################################
                   14196: 
                   14197: =pod
                   14198: 
                   14199: =head1 Course Environment Routines
1.157     matthew  14200: 
                   14201: =over 4
1.153     matthew  14202: 
1.648     raeburn  14203: =item * &restore_course_settings()
1.153     matthew  14204: 
1.648     raeburn  14205: =item * &store_course_settings()
1.153     matthew  14206: 
                   14207: Restores/Store indicated form parameters from the course environment.
                   14208: Will not overwrite existing values of the form parameters.
                   14209: 
                   14210: Inputs: 
                   14211: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   14212: 
                   14213: a hash ref describing the data to be stored.  For example:
                   14214:    
                   14215: %Save_Parameters = ('Status' => 'scalar',
                   14216:     'chartoutputmode' => 'scalar',
                   14217:     'chartoutputdata' => 'scalar',
                   14218:     'Section' => 'array',
1.373     raeburn  14219:     'Group' => 'array',
1.153     matthew  14220:     'StudentData' => 'array',
                   14221:     'Maps' => 'array');
                   14222: 
                   14223: Returns: both routines return nothing
                   14224: 
1.631     raeburn  14225: =back
                   14226: 
1.153     matthew  14227: =cut
                   14228: 
                   14229: #######################################################
                   14230: #######################################################
                   14231: sub store_course_settings {
1.496     albertel 14232:     return &store_settings($env{'request.course.id'},@_);
                   14233: }
                   14234: 
                   14235: sub store_settings {
1.153     matthew  14236:     # save to the environment
                   14237:     # appenv the same items, just to be safe
1.300     albertel 14238:     my $udom  = $env{'user.domain'};
                   14239:     my $uname = $env{'user.name'};
1.496     albertel 14240:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14241:     my %SaveHash;
                   14242:     my %AppHash;
                   14243:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 14244:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 14245:         my $envname = 'environment.'.$basename;
1.258     albertel 14246:         if (exists($env{'form.'.$setting})) {
1.153     matthew  14247:             # Save this value away
                   14248:             if ($type eq 'scalar' &&
1.258     albertel 14249:                 (! exists($env{$envname}) || 
                   14250:                  $env{$envname} ne $env{'form.'.$setting})) {
                   14251:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   14252:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  14253:             } elsif ($type eq 'array') {
                   14254:                 my $stored_form;
1.258     albertel 14255:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  14256:                     $stored_form = join(',',
                   14257:                                         map {
1.369     www      14258:                                             &escape($_);
1.258     albertel 14259:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  14260:                 } else {
                   14261:                     $stored_form = 
1.369     www      14262:                         &escape($env{'form.'.$setting});
1.153     matthew  14263:                 }
                   14264:                 # Determine if the array contents are the same.
1.258     albertel 14265:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  14266:                     $SaveHash{$basename} = $stored_form;
                   14267:                     $AppHash{$envname}   = $stored_form;
                   14268:                 }
                   14269:             }
                   14270:         }
                   14271:     }
                   14272:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 14273:                                           $udom,$uname);
1.153     matthew  14274:     if ($put_result !~ /^(ok|delayed)/) {
                   14275:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   14276:                                  'got error:'.$put_result);
                   14277:     }
                   14278:     # Make sure these settings stick around in this session, too
1.646     raeburn  14279:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  14280:     return;
                   14281: }
                   14282: 
                   14283: sub restore_course_settings {
1.499     albertel 14284:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 14285: }
                   14286: 
                   14287: sub restore_settings {
                   14288:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14289:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 14290:         next if (exists($env{'form.'.$setting}));
1.496     albertel 14291:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  14292:             '.'.$setting;
1.258     albertel 14293:         if (exists($env{$envname})) {
1.153     matthew  14294:             if ($type eq 'scalar') {
1.258     albertel 14295:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  14296:             } elsif ($type eq 'array') {
1.258     albertel 14297:                 $env{'form.'.$setting} = [ 
1.153     matthew  14298:                                            map { 
1.369     www      14299:                                                &unescape($_); 
1.258     albertel 14300:                                            } split(',',$env{$envname})
1.153     matthew  14301:                                            ];
                   14302:             }
                   14303:         }
                   14304:     }
1.127     matthew  14305: }
                   14306: 
1.618     raeburn  14307: #######################################################
                   14308: #######################################################
                   14309: 
                   14310: =pod
                   14311: 
                   14312: =head1 Domain E-mail Routines  
                   14313: 
                   14314: =over 4
                   14315: 
1.648     raeburn  14316: =item * &build_recipient_list()
1.618     raeburn  14317: 
1.1075.2.44  raeburn  14318: Build recipient lists for following types of e-mail:
1.766     raeburn  14319: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1075.2.44  raeburn  14320: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   14321: module change checking, student/employee ID conflict checks, as
                   14322: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   14323: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  14324: 
                   14325: Inputs:
1.1075.2.44  raeburn  14326: defmail (scalar - email address of default recipient),
                   14327: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   14328: requestsmail, updatesmail, or idconflictsmail).
                   14329: 
1.619     raeburn  14330: defdom (domain for which to retrieve configuration settings),
1.1075.2.44  raeburn  14331: 
                   14332: origmail (scalar - email address of recipient from loncapa.conf,
                   14333: i.e., predates configuration by DC via domainprefs.pm
1.618     raeburn  14334: 
1.1075.2.139  raeburn  14335: $requname username of requester (if mailing type is helpdeskmail)
                   14336: 
                   14337: $requdom domain of requester (if mailing type is helpdeskmail)
                   14338: 
                   14339: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
                   14340: 
1.655     raeburn  14341: Returns: comma separated list of addresses to which to send e-mail.
                   14342: 
                   14343: =back
1.618     raeburn  14344: 
                   14345: =cut
                   14346: 
                   14347: ############################################################
                   14348: ############################################################
                   14349: sub build_recipient_list {
1.1075.2.139  raeburn  14350:     my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618     raeburn  14351:     my @recipients;
1.1075.2.122  raeburn  14352:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  14353:     my %domconfig =
1.1075.2.122  raeburn  14354:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  14355:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  14356:         if (exists($domconfig{'contacts'}{$mailing})) {
                   14357:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   14358:                 my @contacts = ('adminemail','supportemail');
                   14359:                 foreach my $item (@contacts) {
                   14360:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   14361:                         my $addr = $domconfig{'contacts'}{$item}; 
                   14362:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14363:                             push(@recipients,$addr);
                   14364:                         }
1.619     raeburn  14365:                     }
1.1075.2.122  raeburn  14366:                 }
                   14367:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   14368:                 if ($mailing eq 'helpdeskmail') {
                   14369:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   14370:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   14371:                         my @ok_bccs;
                   14372:                         foreach my $bcc (@bccs) {
                   14373:                             $bcc =~ s/^\s+//g;
                   14374:                             $bcc =~ s/\s+$//g;
                   14375:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14376:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14377:                                     push(@ok_bccs,$bcc);
                   14378:                                 }
                   14379:                             }
                   14380:                         }
                   14381:                         if (@ok_bccs > 0) {
                   14382:                             $allbcc = join(', ',@ok_bccs);
                   14383:                         }
                   14384:                     }
                   14385:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  14386:                 }
                   14387:             }
1.766     raeburn  14388:         } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14389:             $lastresort = $origmail;
1.618     raeburn  14390:         }
1.1075.2.139  raeburn  14391:         if ($mailing eq 'helpdeskmail') {
                   14392:             if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
                   14393:                 (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
                   14394:                 my ($inststatus,$inststatus_checked);
                   14395:                 if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
                   14396:                     ($env{'user.domain'} ne 'public')) {
                   14397:                     $inststatus_checked = 1;
                   14398:                     $inststatus = $env{'environment.inststatus'};
                   14399:                 }
                   14400:                 unless ($inststatus_checked) {
                   14401:                     if (($requname ne '') && ($requdom ne '')) {
                   14402:                         if (($requname =~ /^$match_username$/) &&
                   14403:                             ($requdom =~ /^$match_domain$/) &&
                   14404:                             (&Apache::lonnet::domain($requdom))) {
                   14405:                             my $requhome = &Apache::lonnet::homeserver($requname,
                   14406:                                                                       $requdom);
                   14407:                             unless ($requhome eq 'no_host') {
                   14408:                                 my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
                   14409:                                 $inststatus = $userenv{'inststatus'};
                   14410:                                 $inststatus_checked = 1;
                   14411:                             }
                   14412:                         }
                   14413:                     }
                   14414:                 }
                   14415:                 unless ($inststatus_checked) {
                   14416:                     if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
                   14417:                         my %srch = (srchby     => 'email',
                   14418:                                     srchdomain => $defdom,
                   14419:                                     srchterm   => $reqemail,
                   14420:                                     srchtype   => 'exact');
                   14421:                         my %srch_results = &Apache::lonnet::usersearch(\%srch);
                   14422:                         foreach my $uname (keys(%srch_results)) {
                   14423:                             if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14424:                                 $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14425:                                 $inststatus_checked = 1;
                   14426:                                 last;
                   14427:                             }
                   14428:                         }
                   14429:                         unless ($inststatus_checked) {
                   14430:                             my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
                   14431:                             if ($dirsrchres eq 'ok') {
                   14432:                                 foreach my $uname (keys(%srch_results)) {
                   14433:                                     if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14434:                                         $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14435:                                         $inststatus_checked = 1;
                   14436:                                         last;
                   14437:                                     }
                   14438:                                 }
                   14439:                             }
                   14440:                         }
                   14441:                     }
                   14442:                 }
                   14443:                 if ($inststatus ne '') {
                   14444:                     foreach my $status (split(/\:/,$inststatus)) {
                   14445:                         if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
                   14446:                             my @contacts = ('adminemail','supportemail');
                   14447:                             foreach my $item (@contacts) {
                   14448:                                 if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
                   14449:                                     my $addr = $domconfig{'contacts'}{'overrides'}{$status};
                   14450:                                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14451:                                         push(@recipients,$addr);
                   14452:                                     }
                   14453:                                 }
                   14454:                             }
                   14455:                             $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
                   14456:                             if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
                   14457:                                 my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
                   14458:                                 my @ok_bccs;
                   14459:                                 foreach my $bcc (@bccs) {
                   14460:                                     $bcc =~ s/^\s+//g;
                   14461:                                     $bcc =~ s/\s+$//g;
                   14462:                                     if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14463:                                         if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14464:                                             push(@ok_bccs,$bcc);
                   14465:                                         }
                   14466:                                     }
                   14467:                                 }
                   14468:                                 if (@ok_bccs > 0) {
                   14469:                                     $allbcc = join(', ',@ok_bccs);
                   14470:                                 }
                   14471:                             }
                   14472:                             $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
                   14473:                             last;
                   14474:                         }
                   14475:                     }
                   14476:                 }
                   14477:             }
                   14478:         }
1.619     raeburn  14479:     } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14480:         $lastresort = $origmail;
                   14481:     }
1.1075.2.128  raeburn  14482:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1075.2.122  raeburn  14483:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   14484:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   14485:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   14486:             my %what = (
                   14487:                           perlvar => 1,
                   14488:                        );
                   14489:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   14490:             if ($primary) {
                   14491:                 my $gotaddr;
                   14492:                 my ($result,$returnhash) =
                   14493:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   14494:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   14495:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   14496:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   14497:                         $gotaddr = 1;
                   14498:                     }
                   14499:                 }
                   14500:                 unless ($gotaddr) {
                   14501:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   14502:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   14503:                     unless ($uintdom eq $intdom) {
                   14504:                         my %domconfig =
                   14505:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   14506:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   14507:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   14508:                                 my @contacts = ('adminemail','supportemail');
                   14509:                                 foreach my $item (@contacts) {
                   14510:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   14511:                                         my $addr = $domconfig{'contacts'}{$item};
                   14512:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14513:                                             push(@recipients,$addr);
                   14514:                                         }
                   14515:                                     }
                   14516:                                 }
                   14517:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   14518:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   14519:                                 }
                   14520:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   14521:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   14522:                                     my @ok_bccs;
                   14523:                                     foreach my $bcc (@bccs) {
                   14524:                                         $bcc =~ s/^\s+//g;
                   14525:                                         $bcc =~ s/\s+$//g;
                   14526:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14527:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14528:                                                 push(@ok_bccs,$bcc);
                   14529:                                             }
                   14530:                                         }
                   14531:                                     }
                   14532:                                     if (@ok_bccs > 0) {
                   14533:                                         $allbcc = join(', ',@ok_bccs);
                   14534:                                     }
                   14535:                                 }
                   14536:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   14537:                             }
                   14538:                         }
                   14539:                     }
                   14540:                 }
                   14541:             }
                   14542:         }
1.618     raeburn  14543:     }
1.688     raeburn  14544:     if (defined($defmail)) {
                   14545:         if ($defmail ne '') {
                   14546:             push(@recipients,$defmail);
                   14547:         }
1.618     raeburn  14548:     }
                   14549:     if ($otheremails) {
1.619     raeburn  14550:         my @others;
                   14551:         if ($otheremails =~ /,/) {
                   14552:             @others = split(/,/,$otheremails);
1.618     raeburn  14553:         } else {
1.619     raeburn  14554:             push(@others,$otheremails);
                   14555:         }
                   14556:         foreach my $addr (@others) {
                   14557:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14558:                 push(@recipients,$addr);
                   14559:             }
1.618     raeburn  14560:         }
                   14561:     }
1.1075.2.128  raeburn  14562:     if ($mailing eq 'helpdeskmail') {
1.1075.2.122  raeburn  14563:         if ((!@recipients) && ($lastresort ne '')) {
                   14564:             push(@recipients,$lastresort);
                   14565:         }
                   14566:     } elsif ($lastresort ne '') {
                   14567:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   14568:             push(@recipients,$lastresort);
                   14569:         }
                   14570:     }
                   14571:     my $recipientlist = join(',',@recipients);
                   14572:     if (wantarray) {
                   14573:         return ($recipientlist,$allbcc,$addtext);
                   14574:     } else {
                   14575:         return $recipientlist;
                   14576:     }
1.618     raeburn  14577: }
                   14578: 
1.127     matthew  14579: ############################################################
                   14580: ############################################################
1.154     albertel 14581: 
1.655     raeburn  14582: =pod
                   14583: 
                   14584: =head1 Course Catalog Routines
                   14585: 
                   14586: =over 4
                   14587: 
                   14588: =item * &gather_categories()
                   14589: 
                   14590: Converts category definitions - keys of categories hash stored in  
                   14591: coursecategories in configuration.db on the primary library server in a 
                   14592: domain - to an array.  Also generates javascript and idx hash used to 
                   14593: generate Domain Coordinator interface for editing Course Categories.
                   14594: 
                   14595: Inputs:
1.663     raeburn  14596: 
1.655     raeburn  14597: categories (reference to hash of category definitions).
1.663     raeburn  14598: 
1.655     raeburn  14599: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14600:       categories and subcategories).
1.663     raeburn  14601: 
1.655     raeburn  14602: idx (reference to hash of counters used in Domain Coordinator interface for 
                   14603:       editing Course Categories).
1.663     raeburn  14604: 
1.655     raeburn  14605: jsarray (reference to array of categories used to create Javascript arrays for
                   14606:          Domain Coordinator interface for editing Course Categories).
                   14607: 
                   14608: Returns: nothing
                   14609: 
                   14610: Side effects: populates cats, idx and jsarray. 
                   14611: 
                   14612: =cut
                   14613: 
                   14614: sub gather_categories {
                   14615:     my ($categories,$cats,$idx,$jsarray) = @_;
                   14616:     my %counters;
                   14617:     my $num = 0;
                   14618:     foreach my $item (keys(%{$categories})) {
                   14619:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   14620:         if ($container eq '' && $depth == 0) {
                   14621:             $cats->[$depth][$categories->{$item}] = $cat;
                   14622:         } else {
                   14623:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   14624:         }
                   14625:         my ($escitem,$tail) = split(/:/,$item,2);
                   14626:         if ($counters{$tail} eq '') {
                   14627:             $counters{$tail} = $num;
                   14628:             $num ++;
                   14629:         }
                   14630:         if (ref($idx) eq 'HASH') {
                   14631:             $idx->{$item} = $counters{$tail};
                   14632:         }
                   14633:         if (ref($jsarray) eq 'ARRAY') {
                   14634:             push(@{$jsarray->[$counters{$tail}]},$item);
                   14635:         }
                   14636:     }
                   14637:     return;
                   14638: }
                   14639: 
                   14640: =pod
                   14641: 
                   14642: =item * &extract_categories()
                   14643: 
                   14644: Used to generate breadcrumb trails for course categories.
                   14645: 
                   14646: Inputs:
1.663     raeburn  14647: 
1.655     raeburn  14648: categories (reference to hash of category definitions).
1.663     raeburn  14649: 
1.655     raeburn  14650: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14651:       categories and subcategories).
1.663     raeburn  14652: 
1.655     raeburn  14653: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  14654: 
1.655     raeburn  14655: allitems (reference to hash - key is category key 
                   14656:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14657: 
1.655     raeburn  14658: idx (reference to hash of counters used in Domain Coordinator interface for
                   14659:       editing Course Categories).
1.663     raeburn  14660: 
1.655     raeburn  14661: jsarray (reference to array of categories used to create Javascript arrays for
                   14662:          Domain Coordinator interface for editing Course Categories).
                   14663: 
1.665     raeburn  14664: subcats (reference to hash of arrays containing all subcategories within each 
                   14665:          category, -recursive)
                   14666: 
1.1075.2.132  raeburn  14667: maxd (reference to hash used to hold max depth for all top-level categories).
                   14668: 
1.655     raeburn  14669: Returns: nothing
                   14670: 
                   14671: Side effects: populates trails and allitems hash references.
                   14672: 
                   14673: =cut
                   14674: 
                   14675: sub extract_categories {
1.1075.2.132  raeburn  14676:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655     raeburn  14677:     if (ref($categories) eq 'HASH') {
                   14678:         &gather_categories($categories,$cats,$idx,$jsarray);
                   14679:         if (ref($cats->[0]) eq 'ARRAY') {
                   14680:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   14681:                 my $name = $cats->[0][$i];
                   14682:                 my $item = &escape($name).'::0';
                   14683:                 my $trailstr;
                   14684:                 if ($name eq 'instcode') {
                   14685:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  14686:                 } elsif ($name eq 'communities') {
                   14687:                     $trailstr = &mt('Communities');
1.655     raeburn  14688:                 } else {
                   14689:                     $trailstr = $name;
                   14690:                 }
                   14691:                 if ($allitems->{$item} eq '') {
                   14692:                     push(@{$trails},$trailstr);
                   14693:                     $allitems->{$item} = scalar(@{$trails})-1;
                   14694:                 }
                   14695:                 my @parents = ($name);
                   14696:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   14697:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   14698:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  14699:                         if (ref($subcats) eq 'HASH') {
                   14700:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   14701:                         }
1.1075.2.132  raeburn  14702:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665     raeburn  14703:                     }
                   14704:                 } else {
                   14705:                     if (ref($subcats) eq 'HASH') {
                   14706:                         $subcats->{$item} = [];
1.655     raeburn  14707:                     }
1.1075.2.132  raeburn  14708:                     if (ref($maxd) eq 'HASH') {
                   14709:                         $maxd->{$name} = 1;
                   14710:                     }
1.655     raeburn  14711:                 }
                   14712:             }
                   14713:         }
                   14714:     }
                   14715:     return;
                   14716: }
                   14717: 
                   14718: =pod
                   14719: 
1.1075.2.56  raeburn  14720: =item * &recurse_categories()
1.655     raeburn  14721: 
                   14722: Recursively used to generate breadcrumb trails for course categories.
                   14723: 
                   14724: Inputs:
1.663     raeburn  14725: 
1.655     raeburn  14726: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14727:       categories and subcategories).
1.663     raeburn  14728: 
1.655     raeburn  14729: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  14730: 
                   14731: category (current course category, for which breadcrumb trail is being generated).
                   14732: 
                   14733: trails (reference to array of breadcrumb trails for each category).
                   14734: 
1.655     raeburn  14735: allitems (reference to hash - key is category key
                   14736:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14737: 
1.655     raeburn  14738: parents (array containing containers directories for current category, 
                   14739:          back to top level). 
                   14740: 
                   14741: Returns: nothing
                   14742: 
                   14743: Side effects: populates trails and allitems hash references
                   14744: 
                   14745: =cut
                   14746: 
                   14747: sub recurse_categories {
1.1075.2.132  raeburn  14748:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655     raeburn  14749:     my $shallower = $depth - 1;
                   14750:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   14751:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   14752:             my $name = $cats->[$depth]{$category}[$k];
                   14753:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   14754:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   14755:             if ($allitems->{$item} eq '') {
                   14756:                 push(@{$trails},$trailstr);
                   14757:                 $allitems->{$item} = scalar(@{$trails})-1;
                   14758:             }
                   14759:             my $deeper = $depth+1;
                   14760:             push(@{$parents},$category);
1.665     raeburn  14761:             if (ref($subcats) eq 'HASH') {
                   14762:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   14763:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   14764:                     my $higher;
                   14765:                     if ($j > 0) {
                   14766:                         $higher = &escape($parents->[$j]).':'.
                   14767:                                   &escape($parents->[$j-1]).':'.$j;
                   14768:                     } else {
                   14769:                         $higher = &escape($parents->[$j]).'::'.$j;
                   14770:                     }
                   14771:                     push(@{$subcats->{$higher}},$subcat);
                   14772:                 }
                   14773:             }
                   14774:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1075.2.132  raeburn  14775:                                 $subcats,$maxd);
1.655     raeburn  14776:             pop(@{$parents});
                   14777:         }
                   14778:     } else {
                   14779:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.132  raeburn  14780:         my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  14781:         if ($allitems->{$item} eq '') {
                   14782:             push(@{$trails},$trailstr);
                   14783:             $allitems->{$item} = scalar(@{$trails})-1;
                   14784:         }
1.1075.2.132  raeburn  14785:         if (ref($maxd) eq 'HASH') {
                   14786:             if ($depth > $maxd->{$parents->[0]}) {
                   14787:                 $maxd->{$parents->[0]} = $depth;
                   14788:             }
                   14789:         }
1.655     raeburn  14790:     }
                   14791:     return;
                   14792: }
                   14793: 
1.663     raeburn  14794: =pod
                   14795: 
1.1075.2.56  raeburn  14796: =item * &assign_categories_table()
1.663     raeburn  14797: 
                   14798: Create a datatable for display of hierarchical categories in a domain,
                   14799: with checkboxes to allow a course to be categorized. 
                   14800: 
                   14801: Inputs:
                   14802: 
                   14803: cathash - reference to hash of categories defined for the domain (from
                   14804:           configuration.db)
                   14805: 
                   14806: currcat - scalar with an & separated list of categories assigned to a course. 
                   14807: 
1.919     raeburn  14808: type    - scalar contains course type (Course or Community).
                   14809: 
1.1075.2.117  raeburn  14810: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   14811:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   14812: 
1.663     raeburn  14813: Returns: $output (markup to be displayed) 
                   14814: 
                   14815: =cut
                   14816: 
                   14817: sub assign_categories_table {
1.1075.2.117  raeburn  14818:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  14819:     my $output;
                   14820:     if (ref($cathash) eq 'HASH') {
1.1075.2.132  raeburn  14821:         my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
                   14822:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663     raeburn  14823:         $maxdepth = scalar(@cats);
                   14824:         if (@cats > 0) {
                   14825:             my $itemcount = 0;
                   14826:             if (ref($cats[0]) eq 'ARRAY') {
                   14827:                 my @currcategories;
                   14828:                 if ($currcat ne '') {
                   14829:                     @currcategories = split('&',$currcat);
                   14830:                 }
1.919     raeburn  14831:                 my $table;
1.663     raeburn  14832:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   14833:                     my $parent = $cats[0][$i];
1.919     raeburn  14834:                     next if ($parent eq 'instcode');
                   14835:                     if ($type eq 'Community') {
                   14836:                         next unless ($parent eq 'communities');
                   14837:                     } else {
                   14838:                         next if ($parent eq 'communities');
                   14839:                     }
1.663     raeburn  14840:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   14841:                     my $item = &escape($parent).'::0';
                   14842:                     my $checked = '';
                   14843:                     if (@currcategories > 0) {
                   14844:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   14845:                             $checked = ' checked="checked"';
1.663     raeburn  14846:                         }
                   14847:                     }
1.919     raeburn  14848:                     my $parent_title = $parent;
                   14849:                     if ($parent eq 'communities') {
                   14850:                         $parent_title = &mt('Communities');
                   14851:                     }
                   14852:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   14853:                               '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  14854:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  14855:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  14856:                     my $depth = 1;
                   14857:                     push(@path,$parent);
1.1075.2.117  raeburn  14858:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  14859:                     pop(@path);
1.919     raeburn  14860:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  14861:                     $itemcount ++;
                   14862:                 }
1.919     raeburn  14863:                 if ($itemcount) {
                   14864:                     $output = &Apache::loncommon::start_data_table().
                   14865:                               $table.
                   14866:                               &Apache::loncommon::end_data_table();
                   14867:                 }
1.663     raeburn  14868:             }
                   14869:         }
                   14870:     }
                   14871:     return $output;
                   14872: }
                   14873: 
                   14874: =pod
                   14875: 
1.1075.2.56  raeburn  14876: =item * &assign_category_rows()
1.663     raeburn  14877: 
                   14878: Create a datatable row for display of nested categories in a domain,
                   14879: with checkboxes to allow a course to be categorized,called recursively.
                   14880: 
                   14881: Inputs:
                   14882: 
                   14883: itemcount - track row number for alternating colors
                   14884: 
                   14885: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   14886:       categories and subcategories.
                   14887: 
                   14888: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   14889: 
                   14890: parent - parent of current category item
                   14891: 
                   14892: path - Array containing all categories back up through the hierarchy from the
                   14893:        current category to the top level.
                   14894: 
                   14895: currcategories - reference to array of current categories assigned to the course
                   14896: 
1.1075.2.117  raeburn  14897: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   14898:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   14899: 
1.663     raeburn  14900: Returns: $output (markup to be displayed).
                   14901: 
                   14902: =cut
                   14903: 
                   14904: sub assign_category_rows {
1.1075.2.117  raeburn  14905:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  14906:     my ($text,$name,$item,$chgstr);
                   14907:     if (ref($cats) eq 'ARRAY') {
                   14908:         my $maxdepth = scalar(@{$cats});
                   14909:         if (ref($cats->[$depth]) eq 'HASH') {
                   14910:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   14911:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   14912:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1075.2.45  raeburn  14913:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  14914:                 for (my $j=0; $j<$numchildren; $j++) {
                   14915:                     $name = $cats->[$depth]{$parent}[$j];
                   14916:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   14917:                     my $deeper = $depth+1;
                   14918:                     my $checked = '';
                   14919:                     if (ref($currcategories) eq 'ARRAY') {
                   14920:                         if (@{$currcategories} > 0) {
                   14921:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   14922:                                 $checked = ' checked="checked"';
1.663     raeburn  14923:                             }
                   14924:                         }
                   14925:                     }
1.664     raeburn  14926:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   14927:                              '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  14928:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  14929:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   14930:                              '</td><td>';
1.663     raeburn  14931:                     if (ref($path) eq 'ARRAY') {
                   14932:                         push(@{$path},$name);
1.1075.2.117  raeburn  14933:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  14934:                         pop(@{$path});
                   14935:                     }
                   14936:                     $text .= '</td></tr>';
                   14937:                 }
                   14938:                 $text .= '</table></td>';
                   14939:             }
                   14940:         }
                   14941:     }
                   14942:     return $text;
                   14943: }
                   14944: 
1.1075.2.69  raeburn  14945: =pod
                   14946: 
                   14947: =back
                   14948: 
                   14949: =cut
                   14950: 
1.655     raeburn  14951: ############################################################
                   14952: ############################################################
                   14953: 
                   14954: 
1.443     albertel 14955: sub commit_customrole {
1.664     raeburn  14956:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  14957:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 14958:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   14959:                          ($end?', ending '.localtime($end):'').': <b>'.
                   14960:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  14961:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 14962:                  '</b><br />';
                   14963:     return $output;
                   14964: }
                   14965: 
                   14966: sub commit_standardrole {
1.1075.2.31  raeburn  14967:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541     raeburn  14968:     my ($output,$logmsg,$linefeed);
                   14969:     if ($context eq 'auto') {
                   14970:         $linefeed = "\n";
                   14971:     } else {
                   14972:         $linefeed = "<br />\n";
                   14973:     }  
1.443     albertel 14974:     if ($three eq 'st') {
1.541     raeburn  14975:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31  raeburn  14976:                                          $one,$two,$sec,$context,$credits);
1.541     raeburn  14977:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  14978:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   14979:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 14980:         } else {
1.541     raeburn  14981:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 14982:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  14983:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   14984:             if ($context eq 'auto') {
                   14985:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   14986:             } else {
                   14987:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   14988:                &mt('Add to classlist').': <b>ok</b>';
                   14989:             }
                   14990:             $output .= $linefeed;
1.443     albertel 14991:         }
                   14992:     } else {
                   14993:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   14994:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  14995:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  14996:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  14997:         if ($context eq 'auto') {
                   14998:             $output .= $result.$linefeed;
                   14999:         } else {
                   15000:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   15001:         }
1.443     albertel 15002:     }
                   15003:     return $output;
                   15004: }
                   15005: 
                   15006: sub commit_studentrole {
1.1075.2.31  raeburn  15007:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
                   15008:         $credits) = @_;
1.626     raeburn  15009:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  15010:     if ($context eq 'auto') {
                   15011:         $linefeed = "\n";
                   15012:     } else {
                   15013:         $linefeed = '<br />'."\n";
                   15014:     }
1.443     albertel 15015:     if (defined($one) && defined($two)) {
                   15016:         my $cid=$one.'_'.$two;
                   15017:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   15018:         my $secchange = 0;
                   15019:         my $expire_role_result;
                   15020:         my $modify_section_result;
1.628     raeburn  15021:         if ($oldsec ne '-1') { 
                   15022:             if ($oldsec ne $sec) {
1.443     albertel 15023:                 $secchange = 1;
1.628     raeburn  15024:                 my $now = time;
1.443     albertel 15025:                 my $uurl='/'.$cid;
                   15026:                 $uurl=~s/\_/\//g;
                   15027:                 if ($oldsec) {
                   15028:                     $uurl.='/'.$oldsec;
                   15029:                 }
1.626     raeburn  15030:                 $oldsecurl = $uurl;
1.628     raeburn  15031:                 $expire_role_result = 
1.652     raeburn  15032:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  15033:                 if ($env{'request.course.sec'} ne '') { 
                   15034:                     if ($expire_role_result eq 'refused') {
                   15035:                         my @roles = ('st');
                   15036:                         my @statuses = ('previous');
                   15037:                         my @roledoms = ($one);
                   15038:                         my $withsec = 1;
                   15039:                         my %roleshash = 
                   15040:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   15041:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   15042:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   15043:                             my ($oldstart,$oldend) = 
                   15044:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   15045:                             if ($oldend > 0 && $oldend <= $now) {
                   15046:                                 $expire_role_result = 'ok';
                   15047:                             }
                   15048:                         }
                   15049:                     }
                   15050:                 }
1.443     albertel 15051:                 $result = $expire_role_result;
                   15052:             }
                   15053:         }
                   15054:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31  raeburn  15055:             $modify_section_result = 
                   15056:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   15057:                                                            undef,undef,undef,$sec,
                   15058:                                                            $end,$start,'','',$cid,
                   15059:                                                            '',$context,$credits);
1.443     albertel 15060:             if ($modify_section_result =~ /^ok/) {
                   15061:                 if ($secchange == 1) {
1.628     raeburn  15062:                     if ($sec eq '') {
                   15063:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   15064:                     } else {
                   15065:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   15066:                     }
1.443     albertel 15067:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  15068:                     if ($sec eq '') {
                   15069:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   15070:                     } else {
                   15071:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15072:                     }
1.443     albertel 15073:                 } else {
1.628     raeburn  15074:                     if ($sec eq '') {
                   15075:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   15076:                     } else {
                   15077:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15078:                     }
1.443     albertel 15079:                 }
                   15080:             } else {
1.628     raeburn  15081:                 if ($secchange) {       
                   15082:                     $$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;
                   15083:                 } else {
                   15084:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   15085:                 }
1.443     albertel 15086:             }
                   15087:             $result = $modify_section_result;
                   15088:         } elsif ($secchange == 1) {
1.628     raeburn  15089:             if ($oldsec eq '') {
1.1075.2.20  raeburn  15090:                 $$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  15091:             } else {
                   15092:                 $$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;
                   15093:             }
1.626     raeburn  15094:             if ($expire_role_result eq 'refused') {
                   15095:                 my $newsecurl = '/'.$cid;
                   15096:                 $newsecurl =~ s/\_/\//g;
                   15097:                 if ($sec ne '') {
                   15098:                     $newsecurl.='/'.$sec;
                   15099:                 }
                   15100:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   15101:                     if ($sec eq '') {
                   15102:                         $$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;
                   15103:                     } else {
                   15104:                         $$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;
                   15105:                     }
                   15106:                 }
                   15107:             }
1.443     albertel 15108:         }
                   15109:     } else {
1.626     raeburn  15110:         $$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 15111:         $result = "error: incomplete course id\n";
                   15112:     }
                   15113:     return $result;
                   15114: }
                   15115: 
1.1075.2.25  raeburn  15116: sub show_role_extent {
                   15117:     my ($scope,$context,$role) = @_;
                   15118:     $scope =~ s{^/}{};
                   15119:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   15120:     push(@courseroles,'co');
                   15121:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   15122:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   15123:         $scope =~ s{/}{_};
                   15124:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   15125:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   15126:         my ($audom,$auname) = split(/\//,$scope);
                   15127:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   15128:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   15129:     } else {
                   15130:         $scope =~ s{/$}{};
                   15131:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   15132:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   15133:     }
                   15134: }
                   15135: 
1.443     albertel 15136: ############################################################
                   15137: ############################################################
                   15138: 
1.566     albertel 15139: sub check_clone {
1.578     raeburn  15140:     my ($args,$linefeed) = @_;
1.566     albertel 15141:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   15142:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   15143:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   15144:     my $clonemsg;
                   15145:     my $can_clone = 0;
1.944     raeburn  15146:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  15147:     if ($lctype ne 'community') {
                   15148:         $lctype = 'course';
                   15149:     }
1.566     albertel 15150:     if ($clonehome eq 'no_host') {
1.944     raeburn  15151:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15152:             $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
                   15153:         } else {
                   15154:             $clonemsg = &mt('No new course created.').$linefeed.&mt('A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
                   15155:         }     
1.566     albertel 15156:     } else {
                   15157: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  15158:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15159:             if ($clonedesc{'type'} ne 'Community') {
                   15160:                  $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
                   15161:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15162:             }
                   15163:         }
1.1075.2.119  raeburn  15164: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  15165:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 15166: 	    $can_clone = 1;
                   15167: 	} else {
1.1075.2.95  raeburn  15168: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 15169: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1075.2.95  raeburn  15170:             if ($clonehash{'cloners'} eq '') {
                   15171:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   15172:                 if ($domdefs{'canclone'}) {
                   15173:                     unless ($domdefs{'canclone'} eq 'none') {
                   15174:                         if ($domdefs{'canclone'} eq 'domain') {
                   15175:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   15176:                                 $can_clone = 1;
                   15177:                             }
                   15178:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15179:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   15180:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   15181:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   15182:                                 $can_clone = 1;
                   15183:                             }
                   15184:                         }
                   15185:                     }
1.908     raeburn  15186:                 }
1.1075.2.95  raeburn  15187:             } else {
                   15188: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   15189:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  15190:                     $can_clone = 1;
1.1075.2.95  raeburn  15191:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  15192:                     $can_clone = 1;
1.1075.2.96  raeburn  15193:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   15194:                     $can_clone = 1;
1.1075.2.95  raeburn  15195:                 }
                   15196:                 unless ($can_clone) {
1.1075.2.96  raeburn  15197:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15198:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1075.2.95  raeburn  15199:                         my (%gotdomdefaults,%gotcodedefaults);
                   15200:                         foreach my $cloner (@cloners) {
                   15201:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   15202:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   15203:                                 my (%codedefaults,@code_order);
                   15204:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   15205:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   15206:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   15207:                                     }
                   15208:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   15209:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   15210:                                     }
                   15211:                                 } else {
                   15212:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   15213:                                                                             \%codedefaults,
                   15214:                                                                             \@code_order);
                   15215:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   15216:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   15217:                                 }
                   15218:                                 if (@code_order > 0) {
                   15219:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   15220:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   15221:                                                                                 $args->{'crscode'})) {
                   15222:                                         $can_clone = 1;
                   15223:                                         last;
                   15224:                                     }
                   15225:                                 }
                   15226:                             }
                   15227:                         }
                   15228:                     }
1.1075.2.96  raeburn  15229:                 }
                   15230:             }
                   15231:             unless ($can_clone) {
                   15232:                 my $ccrole = 'cc';
                   15233:                 if ($args->{'crstype'} eq 'Community') {
                   15234:                     $ccrole = 'co';
                   15235:                 }
                   15236:                 my %roleshash =
                   15237:                     &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   15238:                                                   $args->{'ccdomain'},
                   15239:                                                   'userroles',['active'],[$ccrole],
                   15240:                                                   [$args->{'clonedomain'}]);
                   15241:                 if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   15242:                     $can_clone = 1;
                   15243:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   15244:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   15245:                     $can_clone = 1;
1.1075.2.95  raeburn  15246:                 }
                   15247:             }
                   15248:             unless ($can_clone) {
                   15249:                 if ($args->{'crstype'} eq 'Community') {
                   15250:                     $clonemsg = &mt('No new community created.').$linefeed.&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]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
                   15251:                 } else {
                   15252:                     $clonemsg = &mt('No new course created.').$linefeed.&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]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
1.578     raeburn  15253: 	        }
1.566     albertel 15254: 	    }
1.578     raeburn  15255:         }
1.566     albertel 15256:     }
                   15257:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15258: }
                   15259: 
1.444     albertel 15260: sub construct_course {
1.1075.2.119  raeburn  15261:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
                   15262:         $cnum,$category,$coderef) = @_;
1.444     albertel 15263:     my $outcome;
1.541     raeburn  15264:     my $linefeed =  '<br />'."\n";
                   15265:     if ($context eq 'auto') {
                   15266:         $linefeed = "\n";
                   15267:     }
1.566     albertel 15268: 
                   15269: #
                   15270: # Are we cloning?
                   15271: #
                   15272:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15273:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  15274: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 15275: 	if ($context ne 'auto') {
1.578     raeburn  15276:             if ($clonemsg ne '') {
                   15277: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   15278:             }
1.566     albertel 15279: 	}
                   15280: 	$outcome .= $clonemsg.$linefeed;
                   15281: 
                   15282:         if (!$can_clone) {
                   15283: 	    return (0,$outcome);
                   15284: 	}
                   15285:     }
                   15286: 
1.444     albertel 15287: #
                   15288: # Open course
                   15289: #
                   15290:     my $crstype = lc($args->{'crstype'});
                   15291:     my %cenv=();
                   15292:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   15293:                                              $args->{'cdescr'},
                   15294:                                              $args->{'curl'},
                   15295:                                              $args->{'course_home'},
                   15296:                                              $args->{'nonstandard'},
                   15297:                                              $args->{'crscode'},
                   15298:                                              $args->{'ccuname'}.':'.
                   15299:                                              $args->{'ccdomain'},
1.882     raeburn  15300:                                              $args->{'crstype'},
1.885     raeburn  15301:                                              $cnum,$context,$category);
1.444     albertel 15302: 
                   15303:     # Note: The testing routines depend on this being output; see 
                   15304:     # Utils::Course. This needs to at least be output as a comment
                   15305:     # if anyone ever decides to not show this, and Utils::Course::new
                   15306:     # will need to be suitably modified.
1.541     raeburn  15307:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  15308:     if ($$courseid =~ /^error:/) {
                   15309:         return (0,$outcome);
                   15310:     }
                   15311: 
1.444     albertel 15312: #
                   15313: # Check if created correctly
                   15314: #
1.479     albertel 15315:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 15316:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  15317:     if ($crsuhome eq 'no_host') {
                   15318:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   15319:         return (0,$outcome);
                   15320:     }
1.541     raeburn  15321:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 15322: 
1.444     albertel 15323: #
1.566     albertel 15324: # Do the cloning
                   15325: #   
                   15326:     if ($can_clone && $cloneid) {
                   15327: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   15328: 	if ($context ne 'auto') {
                   15329: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   15330: 	}
                   15331: 	$outcome .= $clonemsg.$linefeed;
                   15332: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 15333: # Copy all files
1.637     www      15334: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 15335: # Restore URL
1.566     albertel 15336: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 15337: # Restore title
1.566     albertel 15338: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  15339: # Restore creation date, creator and creation context.
                   15340:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   15341:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   15342:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 15343: # Mark as cloned
1.566     albertel 15344: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      15345: # Need to clone grading mode
                   15346:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   15347:         $cenv{'grading'}=$newenv{'grading'};
                   15348: # Do not clone these environment entries
                   15349:         &Apache::lonnet::del('environment',
                   15350:                   ['default_enrollment_start_date',
                   15351:                    'default_enrollment_end_date',
                   15352:                    'question.email',
                   15353:                    'policy.email',
                   15354:                    'comment.email',
                   15355:                    'pch.users.denied',
1.725     raeburn  15356:                    'plc.users.denied',
                   15357:                    'hidefromcat',
1.1075.2.36  raeburn  15358:                    'checkforpriv',
1.1075.2.59  raeburn  15359:                    'categories',
                   15360:                    'internal.uniquecode'],
1.638     www      15361:                    $$crsudom,$$crsunum);
1.1075.2.63  raeburn  15362:         if ($args->{'textbook'}) {
                   15363:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   15364:         }
1.444     albertel 15365:     }
1.566     albertel 15366: 
1.444     albertel 15367: #
                   15368: # Set environment (will override cloned, if existing)
                   15369: #
                   15370:     my @sections = ();
                   15371:     my @xlists = ();
                   15372:     if ($args->{'crstype'}) {
                   15373:         $cenv{'type'}=$args->{'crstype'};
                   15374:     }
                   15375:     if ($args->{'crsid'}) {
                   15376:         $cenv{'courseid'}=$args->{'crsid'};
                   15377:     }
                   15378:     if ($args->{'crscode'}) {
                   15379:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   15380:     }
                   15381:     if ($args->{'crsquota'} ne '') {
                   15382:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   15383:     } else {
                   15384:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   15385:     }
                   15386:     if ($args->{'ccuname'}) {
                   15387:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   15388:                                         ':'.$args->{'ccdomain'};
                   15389:     } else {
                   15390:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   15391:     }
1.1075.2.31  raeburn  15392:     if ($args->{'defaultcredits'}) {
                   15393:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   15394:     }
1.444     albertel 15395:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   15396:     if ($args->{'crssections'}) {
                   15397:         $cenv{'internal.sectionnums'} = '';
                   15398:         if ($args->{'crssections'} =~ m/,/) {
                   15399:             @sections = split/,/,$args->{'crssections'};
                   15400:         } else {
                   15401:             $sections[0] = $args->{'crssections'};
                   15402:         }
                   15403:         if (@sections > 0) {
                   15404:             foreach my $item (@sections) {
                   15405:                 my ($sec,$gp) = split/:/,$item;
                   15406:                 my $class = $args->{'crscode'}.$sec;
                   15407:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   15408:                 $cenv{'internal.sectionnums'} .= $item.',';
                   15409:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  15410:                     push(@badclasses,$class);
1.444     albertel 15411:                 }
                   15412:             }
                   15413:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   15414:         }
                   15415:     }
                   15416: # do not hide course coordinator from staff listing, 
                   15417: # even if privileged
                   15418:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36  raeburn  15419: # add course coordinator's domain to domains to check for privileged users
                   15420: # if different to course domain
                   15421:     if ($$crsudom ne $args->{'ccdomain'}) {
                   15422:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   15423:     }
1.444     albertel 15424: # add crosslistings
                   15425:     if ($args->{'crsxlist'}) {
                   15426:         $cenv{'internal.crosslistings'}='';
                   15427:         if ($args->{'crsxlist'} =~ m/,/) {
                   15428:             @xlists = split/,/,$args->{'crsxlist'};
                   15429:         } else {
                   15430:             $xlists[0] = $args->{'crsxlist'};
                   15431:         }
                   15432:         if (@xlists > 0) {
                   15433:             foreach my $item (@xlists) {
                   15434:                 my ($xl,$gp) = split/:/,$item;
                   15435:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   15436:                 $cenv{'internal.crosslistings'} .= $item.',';
                   15437:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  15438:                     push(@badclasses,$xl);
1.444     albertel 15439:                 }
                   15440:             }
                   15441:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   15442:         }
                   15443:     }
                   15444:     if ($args->{'autoadds'}) {
                   15445:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   15446:     }
                   15447:     if ($args->{'autodrops'}) {
                   15448:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   15449:     }
                   15450: # check for notification of enrollment changes
                   15451:     my @notified = ();
                   15452:     if ($args->{'notify_owner'}) {
                   15453:         if ($args->{'ccuname'} ne '') {
                   15454:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   15455:         }
                   15456:     }
                   15457:     if ($args->{'notify_dc'}) {
                   15458:         if ($uname ne '') { 
1.630     raeburn  15459:             push(@notified,$uname.':'.$udom);
1.444     albertel 15460:         }
                   15461:     }
                   15462:     if (@notified > 0) {
                   15463:         my $notifylist;
                   15464:         if (@notified > 1) {
                   15465:             $notifylist = join(',',@notified);
                   15466:         } else {
                   15467:             $notifylist = $notified[0];
                   15468:         }
                   15469:         $cenv{'internal.notifylist'} = $notifylist;
                   15470:     }
                   15471:     if (@badclasses > 0) {
                   15472:         my %lt=&Apache::lonlocal::texthash(
1.1075.2.119  raeburn  15473:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   15474:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   15475:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 15476:         );
1.1075.2.119  raeburn  15477:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   15478:                            &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  15479:         if ($context eq 'auto') {
                   15480:             $outcome .= $badclass_msg.$linefeed;
1.1075.2.119  raeburn  15481:         } else {
1.566     albertel 15482:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1075.2.119  raeburn  15483:         }
                   15484:         foreach my $item (@badclasses) {
1.541     raeburn  15485:             if ($context eq 'auto') {
1.1075.2.119  raeburn  15486:                 $outcome .= " - $item\n";
1.541     raeburn  15487:             } else {
1.1075.2.119  raeburn  15488:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  15489:             }
1.1075.2.119  raeburn  15490:         }
                   15491:         if ($context eq 'auto') {
                   15492:             $outcome .= $linefeed;
                   15493:         } else {
                   15494:             $outcome .= "</ul><br /><br /></div>\n";
                   15495:         }
1.444     albertel 15496:     }
                   15497:     if ($args->{'no_end_date'}) {
                   15498:         $args->{'endaccess'} = 0;
                   15499:     }
                   15500:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   15501:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   15502:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   15503:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   15504:     if ($args->{'showphotos'}) {
                   15505:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   15506:     }
                   15507:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   15508:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   15509:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   15510:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  15511:             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'); 
                   15512:             if ($context eq 'auto') {
                   15513:                 $outcome .= $krb_msg;
                   15514:             } else {
1.566     albertel 15515:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  15516:             }
                   15517:             $outcome .= $linefeed;
1.444     albertel 15518:         }
                   15519:     }
                   15520:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   15521:        if ($args->{'setpolicy'}) {
                   15522:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15523:        }
                   15524:        if ($args->{'setcontent'}) {
                   15525:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15526:        }
1.1075.2.110  raeburn  15527:        if ($args->{'setcomment'}) {
                   15528:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15529:        }
1.444     albertel 15530:     }
                   15531:     if ($args->{'reshome'}) {
                   15532: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   15533: 	$cenv{'reshome'}=~s/\/+$/\//;
                   15534:     }
                   15535: #
                   15536: # course has keyed access
                   15537: #
                   15538:     if ($args->{'setkeys'}) {
                   15539:        $cenv{'keyaccess'}='yes';
                   15540:     }
                   15541: # if specified, key authority is not course, but user
                   15542: # only active if keyaccess is yes
                   15543:     if ($args->{'keyauth'}) {
1.487     albertel 15544: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   15545: 	$user = &LONCAPA::clean_username($user);
                   15546: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     15547: 	if ($user ne '' && $domain ne '') {
1.487     albertel 15548: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 15549: 	}
                   15550:     }
                   15551: 
1.1075.2.59  raeburn  15552: #
                   15553: #  generate and store uniquecode (available to course requester), if course should have one.
                   15554: #
                   15555:     if ($args->{'uniquecode'}) {
                   15556:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   15557:         if ($code) {
                   15558:             $cenv{'internal.uniquecode'} = $code;
                   15559:             my %crsinfo =
                   15560:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   15561:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   15562:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   15563:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   15564:             }
                   15565:             if (ref($coderef)) {
                   15566:                 $$coderef = $code;
                   15567:             }
                   15568:         }
                   15569:     }
                   15570: 
1.444     albertel 15571:     if ($args->{'disresdis'}) {
                   15572:         $cenv{'pch.roles.denied'}='st';
                   15573:     }
                   15574:     if ($args->{'disablechat'}) {
                   15575:         $cenv{'plc.roles.denied'}='st';
                   15576:     }
                   15577: 
                   15578:     # Record we've not yet viewed the Course Initialization Helper for this 
                   15579:     # course
                   15580:     $cenv{'course.helper.not.run'} = 1;
                   15581:     #
                   15582:     # Use new Randomseed
                   15583:     #
                   15584:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   15585:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   15586:     #
                   15587:     # The encryption code and receipt prefix for this course
                   15588:     #
                   15589:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   15590:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   15591:     #
                   15592:     # By default, use standard grading
                   15593:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   15594: 
1.541     raeburn  15595:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   15596:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15597: #
                   15598: # Open all assignments
                   15599: #
                   15600:     if ($args->{'openall'}) {
1.1075.2.146  raeburn  15601:        my $opendate = time;
                   15602:        if ($args->{'openallfrom'} =~ /^\d+$/) {
                   15603:            $opendate = $args->{'openallfrom'};
                   15604:        }
1.444     albertel 15605:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1075.2.146  raeburn  15606:        my %storecontent = ($storeunder         => $opendate,
1.444     albertel 15607:                            $storeunder.'.type' => 'date_start');
1.1075.2.146  raeburn  15608:        $outcome .= &mt('All assignments open starting [_1]',
                   15609:                        &Apache::lonlocal::locallocaltime($opendate)).': '.
                   15610:                    &Apache::lonnet::cput
                   15611:                        ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15612:    }
                   15613: #
                   15614: # Set first page
                   15615: #
                   15616:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   15617: 	    || ($cloneid)) {
1.445     albertel 15618: 	use LONCAPA::map;
1.444     albertel 15619: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 15620: 
                   15621: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   15622:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   15623: 
1.444     albertel 15624:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   15625:         my $title; my $url;
                   15626:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   15627: 	    $title=&mt('Syllabus');
1.444     albertel 15628:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   15629:         } else {
1.963     raeburn  15630:             $title=&mt('Table of Contents');
1.444     albertel 15631:             $url='/adm/navmaps';
                   15632:         }
1.445     albertel 15633: 
                   15634:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   15635: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   15636: 
                   15637: 	if ($errtext) { $fatal=2; }
1.541     raeburn  15638:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 15639:     }
1.566     albertel 15640: 
                   15641:     return (1,$outcome);
1.444     albertel 15642: }
                   15643: 
1.1075.2.59  raeburn  15644: sub make_unique_code {
                   15645:     my ($cdom,$cnum) = @_;
                   15646:     # get lock on uniquecodes db
                   15647:     my $lockhash = {
                   15648:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   15649:                                                   ':'.$env{'user.domain'},
                   15650:                    };
                   15651:     my $tries = 0;
                   15652:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15653:     my ($code,$error);
                   15654: 
                   15655:     while (($gotlock ne 'ok') && ($tries<3)) {
                   15656:         $tries ++;
                   15657:         sleep 1;
                   15658:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15659:     }
                   15660:     if ($gotlock eq 'ok') {
                   15661:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   15662:         my $gotcode;
                   15663:         my $attempts = 0;
                   15664:         while ((!$gotcode) && ($attempts < 100)) {
                   15665:             $code = &generate_code();
                   15666:             if (!exists($currcodes{$code})) {
                   15667:                 $gotcode = 1;
                   15668:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   15669:                     $error = 'nostore';
                   15670:                 }
                   15671:             }
                   15672:             $attempts ++;
                   15673:         }
                   15674:         my @del_lock = ($cnum."\0".'uniquecodes');
                   15675:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   15676:     } else {
                   15677:         $error = 'nolock';
                   15678:     }
                   15679:     return ($code,$error);
                   15680: }
                   15681: 
                   15682: sub generate_code {
                   15683:     my $code;
                   15684:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   15685:     for (my $i=0; $i<6; $i++) {
                   15686:         my $lettnum = int (rand 2);
                   15687:         my $item = '';
                   15688:         if ($lettnum) {
                   15689:             $item = $letts[int( rand(18) )];
                   15690:         } else {
                   15691:             $item = 1+int( rand(8) );
                   15692:         }
                   15693:         $code .= $item;
                   15694:     }
                   15695:     return $code;
                   15696: }
                   15697: 
1.444     albertel 15698: ############################################################
                   15699: ############################################################
                   15700: 
1.953     droeschl 15701: #SD
                   15702: # only Community and Course, or anything else?
1.378     raeburn  15703: sub course_type {
                   15704:     my ($cid) = @_;
                   15705:     if (!defined($cid)) {
                   15706:         $cid = $env{'request.course.id'};
                   15707:     }
1.404     albertel 15708:     if (defined($env{'course.'.$cid.'.type'})) {
                   15709:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  15710:     } else {
                   15711:         return 'Course';
1.377     raeburn  15712:     }
                   15713: }
1.156     albertel 15714: 
1.406     raeburn  15715: sub group_term {
                   15716:     my $crstype = &course_type();
                   15717:     my %names = (
                   15718:                   'Course' => 'group',
1.865     raeburn  15719:                   'Community' => 'group',
1.406     raeburn  15720:                 );
                   15721:     return $names{$crstype};
                   15722: }
                   15723: 
1.902     raeburn  15724: sub course_types {
1.1075.2.59  raeburn  15725:     my @types = ('official','unofficial','community','textbook');
1.902     raeburn  15726:     my %typename = (
                   15727:                          official   => 'Official course',
                   15728:                          unofficial => 'Unofficial course',
                   15729:                          community  => 'Community',
1.1075.2.59  raeburn  15730:                          textbook   => 'Textbook course',
1.902     raeburn  15731:                    );
                   15732:     return (\@types,\%typename);
                   15733: }
                   15734: 
1.156     albertel 15735: sub icon {
                   15736:     my ($file)=@_;
1.505     albertel 15737:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 15738:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 15739:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 15740:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   15741: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   15742: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   15743: 	            $curfext.".gif") {
                   15744: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   15745: 		$curfext.".gif";
                   15746: 	}
                   15747:     }
1.249     albertel 15748:     return &lonhttpdurl($iconname);
1.154     albertel 15749: } 
1.84      albertel 15750: 
1.575     albertel 15751: sub lonhttpdurl {
1.692     www      15752: #
                   15753: # Had been used for "small fry" static images on separate port 8080.
                   15754: # Modify here if lightweight http functionality desired again.
                   15755: # Currently eliminated due to increasing firewall issues.
                   15756: #
1.575     albertel 15757:     my ($url)=@_;
1.692     www      15758:     return $url;
1.215     albertel 15759: }
                   15760: 
1.213     albertel 15761: sub connection_aborted {
                   15762:     my ($r)=@_;
                   15763:     $r->print(" ");$r->rflush();
                   15764:     my $c = $r->connection;
                   15765:     return $c->aborted();
                   15766: }
                   15767: 
1.221     foxr     15768: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     15769: #    strings as 'strings'.
                   15770: sub escape_single {
1.221     foxr     15771:     my ($input) = @_;
1.223     albertel 15772:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     15773:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   15774:     return $input;
                   15775: }
1.223     albertel 15776: 
1.222     foxr     15777: #  Same as escape_single, but escape's "'s  This 
                   15778: #  can be used for  "strings"
                   15779: sub escape_double {
                   15780:     my ($input) = @_;
                   15781:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   15782:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   15783:     return $input;
                   15784: }
1.223     albertel 15785:  
1.222     foxr     15786: #   Escapes the last element of a full URL.
                   15787: sub escape_url {
                   15788:     my ($url)   = @_;
1.238     raeburn  15789:     my @urlslices = split(/\//, $url,-1);
1.369     www      15790:     my $lastitem = &escape(pop(@urlslices));
1.1075.2.83  raeburn  15791:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     15792: }
1.462     albertel 15793: 
1.820     raeburn  15794: sub compare_arrays {
                   15795:     my ($arrayref1,$arrayref2) = @_;
                   15796:     my (@difference,%count);
                   15797:     @difference = ();
                   15798:     %count = ();
                   15799:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   15800:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   15801:         foreach my $element (keys(%count)) {
                   15802:             if ($count{$element} == 1) {
                   15803:                 push(@difference,$element);
                   15804:             }
                   15805:         }
                   15806:     }
                   15807:     return @difference;
                   15808: }
                   15809: 
1.1075.2.152  raeburn  15810: sub lon_status_items {
                   15811:     my %defaults = (
                   15812:                      E         => 100,
                   15813:                      W         => 4,
                   15814:                      N         => 1,
                   15815:                      U         => 5,
                   15816:                      threshold => 200,
                   15817:                      sysmail   => 2500,
                   15818:                    );
                   15819:     my %names = (
                   15820:                    E => 'Errors',
                   15821:                    W => 'Warnings',
                   15822:                    N => 'Notices',
                   15823:                    U => 'Unsent',
                   15824:                 );
                   15825:     return (\%defaults,\%names);
                   15826: }
                   15827: 
1.817     bisitz   15828: # -------------------------------------------------------- Initialize user login
1.462     albertel 15829: sub init_user_environment {
1.463     albertel 15830:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 15831:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   15832: 
                   15833:     my $public=($username eq 'public' && $domain eq 'public');
                   15834: 
                   15835: # See if old ID present, if so, remove
                   15836: 
1.1062    raeburn  15837:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 15838:     my $now=time;
                   15839: 
                   15840:     if ($public) {
                   15841: 	my $max_public=100;
                   15842: 	my $oldest;
                   15843: 	my $oldest_time=0;
                   15844: 	for(my $next=1;$next<=$max_public;$next++) {
                   15845: 	    if (-e $lonids."/publicuser_$next.id") {
                   15846: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   15847: 		if ($mtime<$oldest_time || !$oldest_time) {
                   15848: 		    $oldest_time=$mtime;
                   15849: 		    $oldest=$next;
                   15850: 		}
                   15851: 	    } else {
                   15852: 		$cookie="publicuser_$next";
                   15853: 		last;
                   15854: 	    }
                   15855: 	}
                   15856: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   15857:     } else {
1.463     albertel 15858: 	# if this isn't a robot, kill any existing non-robot sessions
                   15859: 	if (!$args->{'robot'}) {
                   15860: 	    opendir(DIR,$lonids);
                   15861: 	    while ($filename=readdir(DIR)) {
                   15862: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1075.2.136  raeburn  15863:                     if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
                   15864:                             &GDBM_READER(),0640)) {
                   15865:                         my $linkedfile;
                   15866:                         if (exists($oldenv{'user.linkedenv'})) {
                   15867:                             $linkedfile = $oldenv{'user.linkedenv'};
                   15868:                         }
                   15869:                         untie(%oldenv);
                   15870:                         if (unlink("$lonids/$filename")) {
                   15871:                             if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                   15872:                                 if (-l "$lonids/$linkedfile.id") {
                   15873:                                     unlink("$lonids/$linkedfile.id");
                   15874:                                 }
                   15875:                             }
                   15876:                         }
                   15877:                     } else {
                   15878:                         unlink($lonids.'/'.$filename);
                   15879:                     }
1.463     albertel 15880: 		}
1.462     albertel 15881: 	    }
1.463     albertel 15882: 	    closedir(DIR);
1.1075.2.84  raeburn  15883: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   15884:             my $namespace = 'nohist_courseeditor';
                   15885:             my $lockingkey = 'paste'."\0".'locked_num';
                   15886:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   15887:                                                 $domain,$username);
                   15888:             if (exists($lockhash{$lockingkey})) {
                   15889:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   15890:                 unless ($delresult eq 'ok') {
                   15891:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   15892:                 }
                   15893:             }
1.462     albertel 15894: 	}
                   15895: # Give them a new cookie
1.463     albertel 15896: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      15897: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 15898: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 15899:     
                   15900: # Initialize roles
                   15901: 
1.1062    raeburn  15902: 	($userroles,$firstaccenv,$timerintenv) = 
                   15903:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 15904:     }
                   15905: # ------------------------------------ Check browser type and MathML capability
                   15906: 
1.1075.2.77  raeburn  15907:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   15908:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 15909: 
                   15910: # ------------------------------------------------------------- Get environment
                   15911: 
                   15912:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   15913:     my ($tmp) = keys(%userenv);
                   15914:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   15915:     } else {
                   15916: 	undef(%userenv);
                   15917:     }
                   15918:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   15919: 	$form->{'interface'}=$userenv{'interface'};
                   15920:     }
                   15921:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   15922: 
                   15923: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   15924:     foreach my $option ('interface','localpath','localres') {
                   15925:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 15926:     }
                   15927: # --------------------------------------------------------- Write first profile
                   15928: 
                   15929:     {
1.1075.2.150  raeburn  15930:         my $ip = &Apache::lonnet::get_requestor_ip();
1.462     albertel 15931: 	my %initial_env = 
                   15932: 	    ("user.name"          => $username,
                   15933: 	     "user.domain"        => $domain,
                   15934: 	     "user.home"          => $authhost,
                   15935: 	     "browser.type"       => $clientbrowser,
                   15936: 	     "browser.version"    => $clientversion,
                   15937: 	     "browser.mathml"     => $clientmathml,
                   15938: 	     "browser.unicode"    => $clientunicode,
                   15939: 	     "browser.os"         => $clientos,
1.1075.2.42  raeburn  15940:              "browser.mobile"     => $clientmobile,
                   15941:              "browser.info"       => $clientinfo,
1.1075.2.77  raeburn  15942:              "browser.osversion"  => $clientosversion,
1.462     albertel 15943: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   15944: 	     "request.course.fn"  => '',
                   15945: 	     "request.course.uri" => '',
                   15946: 	     "request.course.sec" => '',
                   15947: 	     "request.role"       => 'cm',
                   15948: 	     "request.role.adv"   => $env{'user.adv'},
1.1075.2.150  raeburn  15949: 	     "request.host"       => $ip,);
1.462     albertel 15950: 
                   15951:         if ($form->{'localpath'}) {
                   15952: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   15953: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   15954:         }
                   15955: 	
                   15956: 	if ($form->{'interface'}) {
                   15957: 	    $form->{'interface'}=~s/\W//gs;
                   15958: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   15959: 	    $env{'browser.interface'}=$form->{'interface'};
                   15960: 	}
                   15961: 
1.1075.2.54  raeburn  15962:         if ($form->{'iptoken'}) {
                   15963:             my $lonhost = $r->dir_config('lonHostID');
                   15964:             $initial_env{"user.noloadbalance"} = $lonhost;
                   15965:             $env{'user.noloadbalance'} = $lonhost;
                   15966:         }
                   15967: 
1.1075.2.120  raeburn  15968:         if ($form->{'noloadbalance'}) {
                   15969:             my @hosts = &Apache::lonnet::current_machine_ids();
                   15970:             my $hosthere = $form->{'noloadbalance'};
                   15971:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   15972:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   15973:                 $env{'user.noloadbalance'} = $hosthere;
                   15974:             }
                   15975:         }
                   15976: 
1.1016    raeburn  15977:         unless ($domain eq 'public') {
1.1075.2.125  raeburn  15978:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   15979:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
1.980     raeburn  15980: 
1.1075.2.125  raeburn  15981:             foreach my $tool ('aboutme','blog','webdav','portfolio') {
                   15982:                 $userenv{'availabletools.'.$tool} = 
                   15983:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   15984:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   15985:             }
1.724     raeburn  15986: 
1.1075.2.125  raeburn  15987:             foreach my $crstype ('official','unofficial','community','textbook') {
                   15988:                 $userenv{'canrequest.'.$crstype} =
                   15989:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   15990:                                                       'reload','requestcourses',
                   15991:                                                       \%userenv,\%domdef,\%is_adv);
                   15992:             }
1.765     raeburn  15993: 
1.1075.2.125  raeburn  15994:             $userenv{'canrequest.author'} =
                   15995:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   15996:                                                   'reload','requestauthor',
                   15997:                                                   \%userenv,\%domdef,\%is_adv);
                   15998:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   15999:                                                  $domain,$username);
                   16000:             my $reqstatus = $reqauthor{'author_status'};
                   16001:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
                   16002:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   16003:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   16004:                                                       $reqauthor{'author'}{'timestamp'};
                   16005:                 }
1.1075.2.14  raeburn  16006:             }
                   16007:         }
                   16008: 
1.462     albertel 16009: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  16010: 
1.462     albertel 16011: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   16012: 		 &GDBM_WRCREAT(),0640)) {
                   16013: 	    &_add_to_env(\%disk_env,\%initial_env);
                   16014: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   16015: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  16016:             if (ref($firstaccenv) eq 'HASH') {
                   16017:                 &_add_to_env(\%disk_env,$firstaccenv);
                   16018:             }
                   16019:             if (ref($timerintenv) eq 'HASH') {
                   16020:                 &_add_to_env(\%disk_env,$timerintenv);
                   16021:             }
1.463     albertel 16022: 	    if (ref($args->{'extra_env'})) {
                   16023: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   16024: 	    }
1.462     albertel 16025: 	    untie(%disk_env);
                   16026: 	} else {
1.705     tempelho 16027: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   16028: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 16029: 	    return 'error: '.$!;
                   16030: 	}
                   16031:     }
                   16032:     $env{'request.role'}='cm';
                   16033:     $env{'request.role.adv'}=$env{'user.adv'};
                   16034:     $env{'browser.type'}=$clientbrowser;
                   16035: 
                   16036:     return $cookie;
                   16037: 
                   16038: }
                   16039: 
                   16040: sub _add_to_env {
                   16041:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  16042:     if (ref($env_data) eq 'HASH') {
                   16043:         while (my ($key,$value) = each(%$env_data)) {
                   16044: 	    $idf->{$prefix.$key} = $value;
                   16045: 	    $env{$prefix.$key}   = $value;
                   16046:         }
1.462     albertel 16047:     }
                   16048: }
                   16049: 
1.685     tempelho 16050: # --- Get the symbolic name of a problem and the url
                   16051: sub get_symb {
                   16052:     my ($request,$silent) = @_;
1.726     raeburn  16053:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 16054:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   16055:     if ($symb eq '') {
                   16056:         if (!$silent) {
1.1071    raeburn  16057:             if (ref($request)) { 
                   16058:                 $request->print("Unable to handle ambiguous references:$url:.");
                   16059:             }
1.685     tempelho 16060:             return ();
                   16061:         }
                   16062:     }
                   16063:     &Apache::lonenc::check_decrypt(\$symb);
                   16064:     return ($symb);
                   16065: }
                   16066: 
                   16067: # --------------------------------------------------------------Get annotation
                   16068: 
                   16069: sub get_annotation {
                   16070:     my ($symb,$enc) = @_;
                   16071: 
                   16072:     my $key = $symb;
                   16073:     if (!$enc) {
                   16074:         $key =
                   16075:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   16076:     }
                   16077:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   16078:     return $annotation{$key};
                   16079: }
                   16080: 
                   16081: sub clean_symb {
1.731     raeburn  16082:     my ($symb,$delete_enc) = @_;
1.685     tempelho 16083: 
                   16084:     &Apache::lonenc::check_decrypt(\$symb);
                   16085:     my $enc = $env{'request.enc'};
1.731     raeburn  16086:     if ($delete_enc) {
1.730     raeburn  16087:         delete($env{'request.enc'});
                   16088:     }
1.685     tempelho 16089: 
                   16090:     return ($symb,$enc);
                   16091: }
1.462     albertel 16092: 
1.1075.2.69  raeburn  16093: ############################################################
                   16094: ############################################################
                   16095: 
                   16096: =pod
                   16097: 
                   16098: =head1 Routines for building display used to search for courses
                   16099: 
                   16100: 
                   16101: =over 4
                   16102: 
                   16103: =item * &build_filters()
                   16104: 
                   16105: Create markup for a table used to set filters to use when selecting
                   16106: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   16107: and quotacheck.pl
                   16108: 
                   16109: 
                   16110: Inputs:
                   16111: 
                   16112: filterlist - anonymous array of fields to include as potential filters
                   16113: 
                   16114: crstype - course type
                   16115: 
                   16116: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   16117:               to pop-open a course selector (will contain "extra element").
                   16118: 
                   16119: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   16120: 
                   16121: filter - anonymous hash of criteria and their values
                   16122: 
                   16123: action - form action
                   16124: 
                   16125: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   16126: 
                   16127: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
                   16128: 
                   16129: cloneruname - username of owner of new course who wants to clone
                   16130: 
                   16131: clonerudom - domain of owner of new course who wants to clone
                   16132: 
                   16133: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
                   16134: 
                   16135: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   16136: 
                   16137: codedom - domain
                   16138: 
                   16139: formname - value of form element named "form".
                   16140: 
                   16141: fixeddom - domain, if fixed.
                   16142: 
                   16143: prevphase - value to assign to form element named "phase" when going back to the previous screen
                   16144: 
                   16145: cnameelement - name of form element in form on opener page which will receive title of selected course
                   16146: 
                   16147: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   16148: 
                   16149: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   16150: 
                   16151: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   16152: 
                   16153: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   16154: 
                   16155: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   16156: 
                   16157: 
                   16158: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   16159: 
                   16160: 
                   16161: Side Effects: None
                   16162: 
                   16163: =cut
                   16164: 
                   16165: # ---------------------------------------------- search for courses based on last activity etc.
                   16166: 
                   16167: sub build_filters {
                   16168:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   16169:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   16170:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   16171:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   16172:         $clonetext,$clonewarning) = @_;
                   16173:     my ($list,$jscript);
                   16174:     my $onchange = 'javascript:updateFilters(this)';
                   16175:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   16176:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   16177:         $typeselectform,$instcodetitle);
                   16178:     if ($formname eq '') {
                   16179:         $formname = $caller;
                   16180:     }
                   16181:     foreach my $item (@{$filterlist}) {
                   16182:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   16183:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   16184:             if ($item eq 'domainfilter') {
                   16185:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   16186:             } elsif ($item eq 'coursefilter') {
                   16187:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   16188:             } elsif ($item eq 'ownerfilter') {
                   16189:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16190:             } elsif ($item eq 'ownerdomfilter') {
                   16191:                 $filter->{'ownerdomfilter'} =
                   16192:                     &LONCAPA::clean_domain($filter->{$item});
                   16193:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   16194:                                                        'ownerdomfilter',1);
                   16195:             } elsif ($item eq 'personfilter') {
                   16196:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16197:             } elsif ($item eq 'persondomfilter') {
                   16198:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   16199:                                                         'persondomfilter',1);
                   16200:             } else {
                   16201:                 $filter->{$item} =~ s/\W//g;
                   16202:             }
                   16203:             if (!$filter->{$item}) {
                   16204:                 $filter->{$item} = '';
                   16205:             }
                   16206:         }
                   16207:         if ($item eq 'domainfilter') {
                   16208:             my $allow_blank = 1;
                   16209:             if ($formname eq 'portform') {
                   16210:                 $allow_blank=0;
                   16211:             } elsif ($formname eq 'studentform') {
                   16212:                 $allow_blank=0;
                   16213:             }
                   16214:             if ($fixeddom) {
                   16215:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   16216:                                     ' value="'.$codedom.'" />'.
                   16217:                                     &Apache::lonnet::domain($codedom,'description');
                   16218:             } else {
                   16219:                 $domainselectform = &select_dom_form($filter->{$item},
                   16220:                                                      'domainfilter',
                   16221:                                                       $allow_blank,'',$onchange);
                   16222:             }
                   16223:         } else {
                   16224:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   16225:         }
                   16226:     }
                   16227: 
                   16228:     # last course activity filter and selection
                   16229:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   16230: 
                   16231:     # course created filter and selection
                   16232:     if (exists($filter->{'createdfilter'})) {
                   16233:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   16234:     }
                   16235: 
                   16236:     my %lt = &Apache::lonlocal::texthash(
                   16237:                 'cac' => "$crstype Activity",
                   16238:                 'ccr' => "$crstype Created",
                   16239:                 'cde' => "$crstype Title",
                   16240:                 'cdo' => "$crstype Domain",
                   16241:                 'ins' => 'Institutional Code',
                   16242:                 'inc' => 'Institutional Categorization',
                   16243:                 'cow' => "$crstype Owner/Co-owner",
                   16244:                 'cop' => "$crstype Personnel Includes",
                   16245:                 'cog' => 'Type',
                   16246:              );
                   16247: 
                   16248:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16249:         my $typeval = 'Course';
                   16250:         if ($crstype eq 'Community') {
                   16251:             $typeval = 'Community';
                   16252:         }
                   16253:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   16254:     } else {
                   16255:         $typeselectform =  '<select name="type" size="1"';
                   16256:         if ($onchange) {
                   16257:             $typeselectform .= ' onchange="'.$onchange.'"';
                   16258:         }
                   16259:         $typeselectform .= '>'."\n";
                   16260:         foreach my $posstype ('Course','Community') {
                   16261:             $typeselectform.='<option value="'.$posstype.'"'.
                   16262:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
                   16263:         }
                   16264:         $typeselectform.="</select>";
                   16265:     }
                   16266: 
                   16267:     my ($cloneableonlyform,$cloneabletitle);
                   16268:     if (exists($filter->{'cloneableonly'})) {
                   16269:         my $cloneableon = '';
                   16270:         my $cloneableoff = ' checked="checked"';
                   16271:         if ($filter->{'cloneableonly'}) {
                   16272:             $cloneableon = $cloneableoff;
                   16273:             $cloneableoff = '';
                   16274:         }
                   16275:         $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>';
                   16276:         if ($formname eq 'ccrs') {
1.1075.2.71  raeburn  16277:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1075.2.69  raeburn  16278:         } else {
                   16279:             $cloneabletitle = &mt('Cloneable by you');
                   16280:         }
                   16281:     }
                   16282:     my $officialjs;
                   16283:     if ($crstype eq 'Course') {
                   16284:         if (exists($filter->{'instcodefilter'})) {
                   16285: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   16286: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   16287:             if ($codedom) {
                   16288:                 $officialjs = 1;
                   16289:                 ($instcodeform,$jscript,$$numtitlesref) =
                   16290:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   16291:                                                                   $officialjs,$codetitlesref);
                   16292:                 if ($jscript) {
                   16293:                     $jscript = '<script type="text/javascript">'."\n".
                   16294:                                '// <![CDATA['."\n".
                   16295:                                $jscript."\n".
                   16296:                                '// ]]>'."\n".
                   16297:                                '</script>'."\n";
                   16298:                 }
                   16299:             }
                   16300:             if ($instcodeform eq '') {
                   16301:                 $instcodeform =
                   16302:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   16303:                     $list->{'instcodefilter'}.'" />';
                   16304:                 $instcodetitle = $lt{'ins'};
                   16305:             } else {
                   16306:                 $instcodetitle = $lt{'inc'};
                   16307:             }
                   16308:             if ($fixeddom) {
                   16309:                 $instcodetitle .= '<br />('.$codedom.')';
                   16310:             }
                   16311:         }
                   16312:     }
                   16313:     my $output = qq|
                   16314: <form method="post" name="filterpicker" action="$action">
                   16315: <input type="hidden" name="form" value="$formname" />
                   16316: |;
                   16317:     if ($formname eq 'modifycourse') {
                   16318:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   16319:                    '<input type="hidden" name="prevphase" value="'.
                   16320:                    $prevphase.'" />'."\n";
1.1075.2.82  raeburn  16321:     } elsif ($formname eq 'quotacheck') {
                   16322:         $output .= qq|
                   16323: <input type="hidden" name="sortby" value="" />
                   16324: <input type="hidden" name="sortorder" value="" />
                   16325: |;
                   16326:     } else {
1.1075.2.69  raeburn  16327:         my $name_input;
                   16328:         if ($cnameelement ne '') {
                   16329:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   16330:                           $cnameelement.'" />';
                   16331:         }
                   16332:         $output .= qq|
                   16333: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   16334: <input type="hidden" name="cdomelement" value="$cdomelement" />
                   16335: $name_input
                   16336: $roleelement
                   16337: $multelement
                   16338: $typeelement
                   16339: |;
                   16340:         if ($formname eq 'portform') {
                   16341:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   16342:         }
                   16343:     }
                   16344:     if ($fixeddom) {
                   16345:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   16346:     }
                   16347:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   16348:     if ($sincefilterform) {
                   16349:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   16350:                   .$sincefilterform
                   16351:                   .&Apache::lonhtmlcommon::row_closure();
                   16352:     }
                   16353:     if ($createdfilterform) {
                   16354:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   16355:                   .$createdfilterform
                   16356:                   .&Apache::lonhtmlcommon::row_closure();
                   16357:     }
                   16358:     if ($domainselectform) {
                   16359:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   16360:                   .$domainselectform
                   16361:                   .&Apache::lonhtmlcommon::row_closure();
                   16362:     }
                   16363:     if ($typeselectform) {
                   16364:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16365:             $output .= $typeselectform;
                   16366:         } else {
                   16367:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   16368:                       .$typeselectform
                   16369:                       .&Apache::lonhtmlcommon::row_closure();
                   16370:         }
                   16371:     }
                   16372:     if ($instcodeform) {
                   16373:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   16374:                   .$instcodeform
                   16375:                   .&Apache::lonhtmlcommon::row_closure();
                   16376:     }
                   16377:     if (exists($filter->{'ownerfilter'})) {
                   16378:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   16379:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16380:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   16381:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16382:                    $ownerdomselectform.'</td></tr></table>'.
                   16383:                    &Apache::lonhtmlcommon::row_closure();
                   16384:     }
                   16385:     if (exists($filter->{'personfilter'})) {
                   16386:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   16387:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16388:                    '<input type="text" name="personfilter" size="20" value="'.
                   16389:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16390:                    $persondomselectform.'</td></tr></table>'.
                   16391:                    &Apache::lonhtmlcommon::row_closure();
                   16392:     }
                   16393:     if (exists($filter->{'coursefilter'})) {
                   16394:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   16395:                   .'<input type="text" name="coursefilter" size="25" value="'
                   16396:                   .$list->{'coursefilter'}.'" />'
                   16397:                   .&Apache::lonhtmlcommon::row_closure();
                   16398:     }
                   16399:     if ($cloneableonlyform) {
                   16400:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   16401:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   16402:     }
                   16403:     if (exists($filter->{'descriptfilter'})) {
                   16404:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   16405:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   16406:                   .$list->{'descriptfilter'}.'" />'
                   16407:                   .&Apache::lonhtmlcommon::row_closure(1);
                   16408:     }
                   16409:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   16410:                '<input type="hidden" name="updater" value="" />'."\n".
                   16411:                '<input type="submit" name="gosearch" value="'.
                   16412:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   16413:     return $jscript.$clonewarning.$output;
                   16414: }
                   16415: 
                   16416: =pod
                   16417: 
                   16418: =item * &timebased_select_form()
                   16419: 
                   16420: Create markup for a dropdown list used to select a time-based
                   16421: filter e.g., Course Activity, Course Created, when searching for courses
                   16422: or communities
                   16423: 
                   16424: Inputs:
                   16425: 
                   16426: item - name of form element (sincefilter or createdfilter)
                   16427: 
                   16428: filter - anonymous hash of criteria and their values
                   16429: 
                   16430: Returns: HTML for a select box contained a blank, then six time selections,
                   16431:          with value set in incoming form variables currently selected.
                   16432: 
                   16433: Side Effects: None
                   16434: 
                   16435: =cut
                   16436: 
                   16437: sub timebased_select_form {
                   16438:     my ($item,$filter) = @_;
                   16439:     if (ref($filter) eq 'HASH') {
                   16440:         $filter->{$item} =~ s/[^\d-]//g;
                   16441:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   16442:         return &select_form(
                   16443:                             $filter->{$item},
                   16444:                             $item,
                   16445:                             {      '-1' => '',
                   16446:                                 '86400' => &mt('today'),
                   16447:                                '604800' => &mt('last week'),
                   16448:                               '2592000' => &mt('last month'),
                   16449:                               '7776000' => &mt('last three months'),
                   16450:                              '15552000' => &mt('last six months'),
                   16451:                              '31104000' => &mt('last year'),
                   16452:                     'select_form_order' =>
                   16453:                            ['-1','86400','604800','2592000','7776000',
                   16454:                             '15552000','31104000']});
                   16455:     }
                   16456: }
                   16457: 
                   16458: =pod
                   16459: 
                   16460: =item * &js_changer()
                   16461: 
                   16462: Create script tag containing Javascript used to submit course search form
                   16463: when course type or domain is changed, and also to hide 'Searching ...' on
                   16464: page load completion for page showing search result.
                   16465: 
                   16466: Inputs: None
                   16467: 
                   16468: Returns: markup containing updateFilters() and hideSearching() javascript functions.
                   16469: 
                   16470: Side Effects: None
                   16471: 
                   16472: =cut
                   16473: 
                   16474: sub js_changer {
                   16475:     return <<ENDJS;
                   16476: <script type="text/javascript">
                   16477: // <![CDATA[
                   16478: function updateFilters(caller) {
                   16479:     if (typeof(caller) != "undefined") {
                   16480:         document.filterpicker.updater.value = caller.name;
                   16481:     }
                   16482:     document.filterpicker.submit();
                   16483: }
                   16484: 
                   16485: function hideSearching() {
                   16486:     if (document.getElementById('searching')) {
                   16487:         document.getElementById('searching').style.display = 'none';
                   16488:     }
                   16489:     return;
                   16490: }
                   16491: 
                   16492: // ]]>
                   16493: </script>
                   16494: 
                   16495: ENDJS
                   16496: }
                   16497: 
                   16498: =pod
                   16499: 
                   16500: =item * &search_courses()
                   16501: 
                   16502: Process selected filters form course search form and pass to lonnet::courseiddump
                   16503: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   16504: 
                   16505: Inputs:
                   16506: 
                   16507: dom - domain being searched
                   16508: 
                   16509: type - course type ('Course' or 'Community' or '.' if any).
                   16510: 
                   16511: filter - anonymous hash of criteria and their values
                   16512: 
                   16513: numtitles - for institutional codes - number of categories
                   16514: 
                   16515: cloneruname - optional username of new course owner
                   16516: 
                   16517: clonerudom - optional domain of new course owner
                   16518: 
1.1075.2.95  raeburn  16519: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1075.2.69  raeburn  16520:             (used when DC is using course creation form)
                   16521: 
                   16522: codetitles - reference to array of titles of components in institutional codes (official courses).
                   16523: 
1.1075.2.95  raeburn  16524: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   16525:            (and so can clone automatically)
                   16526: 
                   16527: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   16528: 
                   16529: reqinstcode - institutional code of new course, where search_courses is used to identify potential
                   16530:               courses to clone
1.1075.2.69  raeburn  16531: 
                   16532: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   16533: 
                   16534: 
                   16535: Side Effects: None
                   16536: 
                   16537: =cut
                   16538: 
                   16539: 
                   16540: sub search_courses {
1.1075.2.95  raeburn  16541:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   16542:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1075.2.69  raeburn  16543:     my (%courses,%showcourses,$cloner);
                   16544:     if (($filter->{'ownerfilter'} ne '') ||
                   16545:         ($filter->{'ownerdomfilter'} ne '')) {
                   16546:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   16547:                                        $filter->{'ownerdomfilter'};
                   16548:     }
                   16549:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   16550:         if (!$filter->{$item}) {
                   16551:             $filter->{$item}='.';
                   16552:         }
                   16553:     }
                   16554:     my $now = time;
                   16555:     my $timefilter =
                   16556:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   16557:     my ($createdbefore,$createdafter);
                   16558:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   16559:         $createdbefore = $now;
                   16560:         $createdafter = $now-$filter->{'createdfilter'};
                   16561:     }
                   16562:     my ($instcodefilter,$regexpok);
                   16563:     if ($numtitles) {
                   16564:         if ($env{'form.official'} eq 'on') {
                   16565:             $instcodefilter =
                   16566:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16567:             $regexpok = 1;
                   16568:         } elsif ($env{'form.official'} eq 'off') {
                   16569:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16570:             unless ($instcodefilter eq '') {
                   16571:                 $regexpok = -1;
                   16572:             }
                   16573:         }
                   16574:     } else {
                   16575:         $instcodefilter = $filter->{'instcodefilter'};
                   16576:     }
                   16577:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   16578:     if ($type eq '') { $type = '.'; }
                   16579: 
                   16580:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   16581:         $cloner = $cloneruname.':'.$clonerudom;
                   16582:     }
                   16583:     %courses = &Apache::lonnet::courseiddump($dom,
                   16584:                                              $filter->{'descriptfilter'},
                   16585:                                              $timefilter,
                   16586:                                              $instcodefilter,
                   16587:                                              $filter->{'combownerfilter'},
                   16588:                                              $filter->{'coursefilter'},
                   16589:                                              undef,undef,$type,$regexpok,undef,undef,
1.1075.2.95  raeburn  16590:                                              undef,undef,$cloner,$cc_clone,
1.1075.2.69  raeburn  16591:                                              $filter->{'cloneableonly'},
                   16592:                                              $createdbefore,$createdafter,undef,
1.1075.2.95  raeburn  16593:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1075.2.69  raeburn  16594:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   16595:         my $ccrole;
                   16596:         if ($type eq 'Community') {
                   16597:             $ccrole = 'co';
                   16598:         } else {
                   16599:             $ccrole = 'cc';
                   16600:         }
                   16601:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   16602:                                                      $filter->{'persondomfilter'},
                   16603:                                                      'userroles',undef,
                   16604:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   16605:                                                      $dom);
                   16606:         foreach my $role (keys(%rolehash)) {
                   16607:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   16608:             my $cid = $cdom.'_'.$cnum;
                   16609:             if (exists($courses{$cid})) {
                   16610:                 if (ref($courses{$cid}) eq 'HASH') {
                   16611:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   16612:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1075.2.119  raeburn  16613:                             push(@{$courses{$cid}{roles}},$courserole);
1.1075.2.69  raeburn  16614:                         }
                   16615:                     } else {
                   16616:                         $courses{$cid}{roles} = [$courserole];
                   16617:                     }
                   16618:                     $showcourses{$cid} = $courses{$cid};
                   16619:                 }
                   16620:             }
                   16621:         }
                   16622:         %courses = %showcourses;
                   16623:     }
                   16624:     return %courses;
                   16625: }
                   16626: 
                   16627: =pod
                   16628: 
                   16629: =back
                   16630: 
1.1075.2.88  raeburn  16631: =head1 Routines for version requirements for current course.
                   16632: 
                   16633: =over 4
                   16634: 
                   16635: =item * &check_release_required()
                   16636: 
                   16637: Compares required LON-CAPA version with version on server, and
                   16638: if required version is newer looks for a server with the required version.
                   16639: 
                   16640: Looks first at servers in user's owen domain; if none suitable, looks at
                   16641: servers in course's domain are permitted to host sessions for user's domain.
                   16642: 
                   16643: Inputs:
                   16644: 
                   16645: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16646: 
                   16647: $courseid - Course ID of current course
                   16648: 
                   16649: $rolecode - User's current role in course (for switchserver query string).
                   16650: 
                   16651: $required - LON-CAPA version needed by course (format: Major.Minor).
                   16652: 
                   16653: 
                   16654: Returns:
                   16655: 
                   16656: $switchserver - query string tp append to /adm/switchserver call (if
                   16657:                 current server's LON-CAPA version is too old.
                   16658: 
                   16659: $warning - Message is displayed if no suitable server could be found.
                   16660: 
                   16661: =cut
                   16662: 
                   16663: sub check_release_required {
                   16664:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   16665:     my ($switchserver,$warning);
                   16666:     if ($required ne '') {
                   16667:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   16668:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16669:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   16670:             my $otherserver;
                   16671:             if (($major eq '' && $minor eq '') ||
                   16672:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   16673:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   16674:                 my $switchlcrev =
                   16675:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   16676:                                                            $userdomserver);
                   16677:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16678:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   16679:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   16680:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   16681:                     if ($cdom ne $env{'user.domain'}) {
                   16682:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   16683:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   16684:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   16685:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   16686:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   16687:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   16688:                         my $canhost =
                   16689:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   16690:                                                               $coursedomserver,
                   16691:                                                               $remoterev,
                   16692:                                                               $udomdefaults{'remotesessions'},
                   16693:                                                               $defdomdefaults{'hostedsessions'});
                   16694: 
                   16695:                         if ($canhost) {
                   16696:                             $otherserver = $coursedomserver;
                   16697:                         } else {
                   16698:                             $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.");
                   16699:                         }
                   16700:                     } else {
                   16701:                         $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).");
                   16702:                     }
                   16703:                 } else {
                   16704:                     $otherserver = $userdomserver;
                   16705:                 }
                   16706:             }
                   16707:             if ($otherserver ne '') {
                   16708:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   16709:             }
                   16710:         }
                   16711:     }
                   16712:     return ($switchserver,$warning);
                   16713: }
                   16714: 
                   16715: =pod
                   16716: 
                   16717: =item * &check_release_result()
                   16718: 
                   16719: Inputs:
                   16720: 
                   16721: $switchwarning - Warning message if no suitable server found to host session.
                   16722: 
                   16723: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   16724:                 and current role.
                   16725: 
                   16726: Returns: HTML to display with information about requirement to switch server.
                   16727:          Either displaying warning with link to Roles/Courses screen or
                   16728:          display link to switchserver.
                   16729: 
1.1075.2.69  raeburn  16730: =cut
                   16731: 
1.1075.2.88  raeburn  16732: sub check_release_result {
                   16733:     my ($switchwarning,$switchserver) = @_;
                   16734:     my $output = &start_page('Selected course unavailable on this server').
                   16735:                  '<p class="LC_warning">';
                   16736:     if ($switchwarning) {
                   16737:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   16738:         if (&show_course()) {
                   16739:             $output .= &mt('Display courses');
                   16740:         } else {
                   16741:             $output .= &mt('Display roles');
                   16742:         }
                   16743:         $output .= '</a>';
                   16744:     } elsif ($switchserver) {
                   16745:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   16746:                    '<br />'.
                   16747:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   16748:                    &mt('Switch Server').
                   16749:                    '</a>';
                   16750:     }
                   16751:     $output .= '</p>'.&end_page();
                   16752:     return $output;
                   16753: }
                   16754: 
                   16755: =pod
                   16756: 
                   16757: =item * &needs_coursereinit()
                   16758: 
                   16759: Determine if course contents stored for user's session needs to be
                   16760: refreshed, because content has changed since "Big Hash" last tied.
                   16761: 
                   16762: Check for change is made if time last checked is more than 10 minutes ago
                   16763: (by default).
                   16764: 
                   16765: Inputs:
                   16766: 
                   16767: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16768: 
                   16769: $interval (optional) - Time which may elapse (in s) between last check for content
                   16770:                        change in current course. (default: 600 s).
                   16771: 
                   16772: Returns: an array; first element is:
                   16773: 
                   16774: =over 4
                   16775: 
                   16776: 'switch' - if content updates mean user's session
                   16777:            needs to be switched to a server running a newer LON-CAPA version
                   16778: 
                   16779: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   16780:            on current server hosting user's session
                   16781: 
                   16782: ''       - if no action required.
                   16783: 
                   16784: =back
                   16785: 
                   16786: If first item element is 'switch':
                   16787: 
                   16788: second item is $switchwarning - Warning message if no suitable server found to host session.
                   16789: 
                   16790: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   16791:                               and current role.
                   16792: 
                   16793: otherwise: no other elements returned.
                   16794: 
                   16795: =back
                   16796: 
                   16797: =cut
                   16798: 
                   16799: sub needs_coursereinit {
                   16800:     my ($loncaparev,$interval) = @_;
                   16801:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   16802:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   16803:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   16804:     my $now = time;
                   16805:     if ($interval eq '') {
                   16806:         $interval = 600;
                   16807:     }
                   16808:     if (($now-$env{'request.course.timechecked'})>$interval) {
                   16809:         my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
                   16810:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
                   16811:         if ($lastchange > $env{'request.course.tied'}) {
                   16812:             my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   16813:             if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   16814:                 my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   16815:                 if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   16816:                     &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   16817:                                              $curr_reqd_hash{'internal.releaserequired'}});
                   16818:                     my ($switchserver,$switchwarning) =
                   16819:                         &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   16820:                                                 $curr_reqd_hash{'internal.releaserequired'});
                   16821:                     if ($switchwarning ne '' || $switchserver ne '') {
                   16822:                         return ('switch',$switchwarning,$switchserver);
                   16823:                     }
                   16824:                 }
                   16825:             }
                   16826:             return ('update');
                   16827:         }
                   16828:     }
                   16829:     return ();
                   16830: }
1.1075.2.69  raeburn  16831: 
1.1075.2.11  raeburn  16832: sub update_content_constraints {
                   16833:     my ($cdom,$cnum,$chome,$cid) = @_;
                   16834:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   16835:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   16836:     my %checkresponsetypes;
                   16837:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   16838:         my ($item,$name,$value) = split(/:/,$key);
                   16839:         if ($item eq 'resourcetag') {
                   16840:             if ($name eq 'responsetype') {
                   16841:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   16842:             }
                   16843:         }
                   16844:     }
                   16845:     my $navmap = Apache::lonnavmaps::navmap->new();
                   16846:     if (defined($navmap)) {
                   16847:         my %allresponses;
                   16848:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
                   16849:             my %responses = $res->responseTypes();
                   16850:             foreach my $key (keys(%responses)) {
                   16851:                 next unless(exists($checkresponsetypes{$key}));
                   16852:                 $allresponses{$key} += $responses{$key};
                   16853:             }
                   16854:         }
                   16855:         foreach my $key (keys(%allresponses)) {
                   16856:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   16857:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   16858:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   16859:             }
                   16860:         }
                   16861:         undef($navmap);
                   16862:     }
                   16863:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   16864:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   16865:     }
                   16866:     return;
                   16867: }
                   16868: 
1.1075.2.27  raeburn  16869: sub allmaps_incourse {
                   16870:     my ($cdom,$cnum,$chome,$cid) = @_;
                   16871:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   16872:         $cid = $env{'request.course.id'};
                   16873:         $cdom = $env{'course.'.$cid.'.domain'};
                   16874:         $cnum = $env{'course.'.$cid.'.num'};
                   16875:         $chome = $env{'course.'.$cid.'.home'};
                   16876:     }
                   16877:     my %allmaps = ();
                   16878:     my $lastchange =
                   16879:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   16880:     if ($lastchange > $env{'request.course.tied'}) {
                   16881:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   16882:         unless ($ferr) {
                   16883:             &update_content_constraints($cdom,$cnum,$chome,$cid);
                   16884:         }
                   16885:     }
                   16886:     my $navmap = Apache::lonnavmaps::navmap->new();
                   16887:     if (defined($navmap)) {
                   16888:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   16889:             $allmaps{$res->src()} = 1;
                   16890:         }
                   16891:     }
                   16892:     return \%allmaps;
                   16893: }
                   16894: 
1.1075.2.11  raeburn  16895: sub parse_supplemental_title {
                   16896:     my ($title) = @_;
                   16897: 
                   16898:     my ($foldertitle,$renametitle);
                   16899:     if ($title =~ /&amp;&amp;&amp;/) {
                   16900:         $title = &HTML::Entites::decode($title);
                   16901:     }
                   16902:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   16903:         $renametitle=$4;
                   16904:         my ($time,$uname,$udom) = ($1,$2,$3);
                   16905:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   16906:         my $name =  &plainname($uname,$udom);
                   16907:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   16908:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
                   16909:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
                   16910:             $name.': <br />'.$foldertitle;
                   16911:     }
                   16912:     if (wantarray) {
                   16913:         return ($title,$foldertitle,$renametitle);
                   16914:     }
                   16915:     return $title;
                   16916: }
                   16917: 
1.1075.2.43  raeburn  16918: sub recurse_supplemental {
                   16919:     my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
                   16920:     if ($suppmap) {
                   16921:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   16922:         if ($fatal) {
                   16923:             $errors ++;
                   16924:         } else {
                   16925:             if ($#LONCAPA::map::resources > 0) {
                   16926:                 foreach my $res (@LONCAPA::map::resources) {
                   16927:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
                   16928:                     if (($src ne '') && ($status eq 'res')) {
1.1075.2.46  raeburn  16929:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
                   16930:                             ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1075.2.43  raeburn  16931:                         } else {
                   16932:                             $numfiles ++;
                   16933:                         }
                   16934:                     }
                   16935:                 }
                   16936:             }
                   16937:         }
                   16938:     }
                   16939:     return ($numfiles,$errors);
                   16940: }
                   16941: 
1.1075.2.18  raeburn  16942: sub symb_to_docspath {
1.1075.2.119  raeburn  16943:     my ($symb,$navmapref) = @_;
                   16944:     return unless ($symb && ref($navmapref));
1.1075.2.18  raeburn  16945:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   16946:     if ($resurl=~/\.(sequence|page)$/) {
                   16947:         $mapurl=$resurl;
                   16948:     } elsif ($resurl eq 'adm/navmaps') {
                   16949:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   16950:     }
                   16951:     my $mapresobj;
1.1075.2.119  raeburn  16952:     unless (ref($$navmapref)) {
                   16953:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   16954:     }
                   16955:     if (ref($$navmapref)) {
                   16956:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1075.2.18  raeburn  16957:     }
                   16958:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   16959:     my $type=$2;
                   16960:     my $path;
                   16961:     if (ref($mapresobj)) {
                   16962:         my $pcslist = $mapresobj->map_hierarchy();
                   16963:         if ($pcslist ne '') {
                   16964:             foreach my $pc (split(/,/,$pcslist)) {
                   16965:                 next if ($pc <= 1);
1.1075.2.119  raeburn  16966:                 my $res = $$navmapref->getByMapPc($pc);
1.1075.2.18  raeburn  16967:                 if (ref($res)) {
                   16968:                     my $thisurl = $res->src();
                   16969:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   16970:                     my $thistitle = $res->title();
                   16971:                     $path .= '&'.
                   16972:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1075.2.46  raeburn  16973:                              &escape($thistitle).
1.1075.2.18  raeburn  16974:                              ':'.$res->randompick().
                   16975:                              ':'.$res->randomout().
                   16976:                              ':'.$res->encrypted().
                   16977:                              ':'.$res->randomorder().
                   16978:                              ':'.$res->is_page();
                   16979:                 }
                   16980:             }
                   16981:         }
                   16982:         $path =~ s/^\&//;
                   16983:         my $maptitle = $mapresobj->title();
                   16984:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  16985:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  16986:         }
                   16987:         $path .= (($path ne '')? '&' : '').
                   16988:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  16989:                  &escape($maptitle).
1.1075.2.18  raeburn  16990:                  ':'.$mapresobj->randompick().
                   16991:                  ':'.$mapresobj->randomout().
                   16992:                  ':'.$mapresobj->encrypted().
                   16993:                  ':'.$mapresobj->randomorder().
                   16994:                  ':'.$mapresobj->is_page();
                   16995:     } else {
                   16996:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   16997:         my $ispage = (($type eq 'page')? 1 : '');
                   16998:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  16999:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17000:         }
                   17001:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17002:                 &escape($maptitle).':::::'.$ispage;
1.1075.2.18  raeburn  17003:     }
                   17004:     unless ($mapurl eq 'default') {
                   17005:         $path = 'default&'.
1.1075.2.46  raeburn  17006:                 &escape('Main Content').
1.1075.2.18  raeburn  17007:                 ':::::&'.$path;
                   17008:     }
                   17009:     return $path;
                   17010: }
                   17011: 
1.1075.2.14  raeburn  17012: sub captcha_display {
1.1075.2.137  raeburn  17013:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17014:     my ($output,$error);
1.1075.2.107  raeburn  17015:     my ($captcha,$pubkey,$privkey,$version) =
1.1075.2.137  raeburn  17016:         &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17017:     if ($captcha eq 'original') {
                   17018:         $output = &create_captcha();
                   17019:         unless ($output) {
                   17020:             $error = 'captcha';
                   17021:         }
                   17022:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17023:         $output = &create_recaptcha($pubkey,$version);
1.1075.2.14  raeburn  17024:         unless ($output) {
                   17025:             $error = 'recaptcha';
                   17026:         }
                   17027:     }
1.1075.2.107  raeburn  17028:     return ($output,$error,$captcha,$version);
1.1075.2.14  raeburn  17029: }
                   17030: 
                   17031: sub captcha_response {
1.1075.2.137  raeburn  17032:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17033:     my ($captcha_chk,$captcha_error);
1.1075.2.137  raeburn  17034:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17035:     if ($captcha eq 'original') {
                   17036:         ($captcha_chk,$captcha_error) = &check_captcha();
                   17037:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17038:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1075.2.14  raeburn  17039:     } else {
                   17040:         $captcha_chk = 1;
                   17041:     }
                   17042:     return ($captcha_chk,$captcha_error);
                   17043: }
                   17044: 
                   17045: sub get_captcha_config {
1.1075.2.137  raeburn  17046:     my ($context,$lonhost,$dom_in_effect) = @_;
1.1075.2.107  raeburn  17047:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1075.2.14  raeburn  17048:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   17049:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   17050:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   17051:     if ($context eq 'usercreation') {
                   17052:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   17053:         if (ref($domconfig{$context}) eq 'HASH') {
                   17054:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   17055:             if (ref($hashtocheck) eq 'HASH') {
                   17056:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   17057:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   17058:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   17059:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   17060:                     }
                   17061:                     if ($privkey && $pubkey) {
                   17062:                         $captcha = 'recaptcha';
1.1075.2.107  raeburn  17063:                         $version = $hashtocheck->{'recaptchaversion'};
                   17064:                         if ($version ne '2') {
                   17065:                             $version = 1;
                   17066:                         }
1.1075.2.14  raeburn  17067:                     } else {
                   17068:                         $captcha = 'original';
                   17069:                     }
                   17070:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   17071:                     $captcha = 'original';
                   17072:                 }
                   17073:             }
                   17074:         } else {
                   17075:             $captcha = 'captcha';
                   17076:         }
                   17077:     } elsif ($context eq 'login') {
                   17078:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   17079:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   17080:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   17081:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
                   17082:             if ($privkey && $pubkey) {
                   17083:                 $captcha = 'recaptcha';
1.1075.2.107  raeburn  17084:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   17085:                 if ($version ne '2') {
                   17086:                     $version = 1;
                   17087:                 }
1.1075.2.14  raeburn  17088:             } else {
                   17089:                 $captcha = 'original';
                   17090:             }
                   17091:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   17092:             $captcha = 'original';
                   17093:         }
1.1075.2.137  raeburn  17094:     } elsif ($context eq 'passwords') {
                   17095:         if ($dom_in_effect) {
                   17096:             my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
                   17097:             if ($passwdconf{'captcha'} eq 'recaptcha') {
                   17098:                 if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
                   17099:                     $pubkey = $passwdconf{'recaptchakeys'}{'public'};
                   17100:                     $privkey = $passwdconf{'recaptchakeys'}{'private'};
                   17101:                 }
                   17102:                 if ($privkey && $pubkey) {
                   17103:                     $captcha = 'recaptcha';
                   17104:                     $version = $passwdconf{'recaptchaversion'};
                   17105:                     if ($version ne '2') {
                   17106:                         $version = 1;
                   17107:                     }
                   17108:                 } else {
                   17109:                     $captcha = 'original';
                   17110:                 }
                   17111:             } elsif ($passwdconf{'captcha'} ne 'notused') {
                   17112:                 $captcha = 'original';
                   17113:             }
                   17114:         }
1.1075.2.14  raeburn  17115:     }
1.1075.2.107  raeburn  17116:     return ($captcha,$pubkey,$privkey,$version);
1.1075.2.14  raeburn  17117: }
                   17118: 
                   17119: sub create_captcha {
                   17120:     my %captcha_params = &captcha_settings();
                   17121:     my ($output,$maxtries,$tries) = ('',10,0);
                   17122:     while ($tries < $maxtries) {
                   17123:         $tries ++;
                   17124:         my $captcha = Authen::Captcha->new (
                   17125:                                            output_folder => $captcha_params{'output_dir'},
                   17126:                                            data_folder   => $captcha_params{'db_dir'},
                   17127:                                           );
                   17128:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   17129: 
                   17130:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   17131:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
                   17132:                       &mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1075.2.66  raeburn  17133:                       '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
                   17134:                       '<br />'.
                   17135:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1075.2.14  raeburn  17136:             last;
                   17137:         }
                   17138:     }
                   17139:     return $output;
                   17140: }
                   17141: 
                   17142: sub captcha_settings {
                   17143:     my %captcha_params = (
                   17144:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   17145:                            www_output_dir => "/captchaspool",
                   17146:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   17147:                            numchars       => '5',
                   17148:                          );
                   17149:     return %captcha_params;
                   17150: }
                   17151: 
                   17152: sub check_captcha {
                   17153:     my ($captcha_chk,$captcha_error);
                   17154:     my $code = $env{'form.code'};
                   17155:     my $md5sum = $env{'form.crypt'};
                   17156:     my %captcha_params = &captcha_settings();
                   17157:     my $captcha = Authen::Captcha->new(
                   17158:                       output_folder => $captcha_params{'output_dir'},
                   17159:                       data_folder   => $captcha_params{'db_dir'},
                   17160:                   );
1.1075.2.26  raeburn  17161:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14  raeburn  17162:     my %captcha_hash = (
                   17163:                         0       => 'Code not checked (file error)',
                   17164:                        -1      => 'Failed: code expired',
                   17165:                        -2      => 'Failed: invalid code (not in database)',
                   17166:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   17167:     );
                   17168:     if ($captcha_chk != 1) {
                   17169:         $captcha_error = $captcha_hash{$captcha_chk}
                   17170:     }
                   17171:     return ($captcha_chk,$captcha_error);
                   17172: }
                   17173: 
                   17174: sub create_recaptcha {
1.1075.2.107  raeburn  17175:     my ($pubkey,$version) = @_;
                   17176:     if ($version >= 2) {
                   17177:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>';
                   17178:     } else {
                   17179:         my $use_ssl;
                   17180:         if ($ENV{'SERVER_PORT'} == 443) {
                   17181:             $use_ssl = 1;
                   17182:         }
                   17183:         my $captcha = Captcha::reCAPTCHA->new;
                   17184:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   17185:                $captcha->get_html($pubkey,undef,$use_ssl).
                   17186:                &mt('If the text is hard to read, [_1] will replace them.',
                   17187:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   17188:                '<br /><br />';
                   17189:      }
1.1075.2.14  raeburn  17190: }
                   17191: 
                   17192: sub check_recaptcha {
1.1075.2.107  raeburn  17193:     my ($privkey,$version) = @_;
1.1075.2.14  raeburn  17194:     my $captcha_chk;
1.1075.2.150  raeburn  17195:     my $ip = &Apache::lonnet::get_requestor_ip(); 
1.1075.2.107  raeburn  17196:     if ($version >= 2) {
                   17197:         my $ua = LWP::UserAgent->new;
                   17198:         $ua->timeout(10);
                   17199:         my %info = (
                   17200:                      secret   => $privkey,
                   17201:                      response => $env{'form.g-recaptcha-response'},
1.1075.2.150  raeburn  17202:                      remoteip => $ip,
1.1075.2.107  raeburn  17203:                    );
                   17204:         my $response = $ua->post('https://www.google.com/recaptcha/api/siteverify',\%info);
                   17205:         if ($response->is_success)  {
                   17206:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   17207:             if (ref($data) eq 'HASH') {
                   17208:                 if ($data->{'success'}) {
                   17209:                     $captcha_chk = 1;
                   17210:                 }
                   17211:             }
                   17212:         }
                   17213:     } else {
                   17214:         my $captcha = Captcha::reCAPTCHA->new;
                   17215:         my $captcha_result =
                   17216:             $captcha->check_answer(
                   17217:                                     $privkey,
1.1075.2.150  raeburn  17218:                                     $ip,
1.1075.2.107  raeburn  17219:                                     $env{'form.recaptcha_challenge_field'},
                   17220:                                     $env{'form.recaptcha_response_field'},
                   17221:                                   );
                   17222:         if ($captcha_result->{is_valid}) {
                   17223:             $captcha_chk = 1;
                   17224:         }
1.1075.2.14  raeburn  17225:     }
                   17226:     return $captcha_chk;
                   17227: }
                   17228: 
1.1075.2.64  raeburn  17229: sub emailusername_info {
1.1075.2.103  raeburn  17230:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1075.2.64  raeburn  17231:     my %titles = &Apache::lonlocal::texthash (
                   17232:                      lastname      => 'Last Name',
                   17233:                      firstname     => 'First Name',
                   17234:                      institution   => 'School/college/university',
                   17235:                      location      => "School's city, state/province, country",
                   17236:                      web           => "School's web address",
                   17237:                      officialemail => 'E-mail address at institution (if different)',
1.1075.2.103  raeburn  17238:                      id            => 'Student/Employee ID',
1.1075.2.64  raeburn  17239:                  );
                   17240:     return (\@fields,\%titles);
                   17241: }
                   17242: 
1.1075.2.56  raeburn  17243: sub cleanup_html {
                   17244:     my ($incoming) = @_;
                   17245:     my $outgoing;
                   17246:     if ($incoming ne '') {
                   17247:         $outgoing = $incoming;
                   17248:         $outgoing =~ s/;/&#059;/g;
                   17249:         $outgoing =~ s/\#/&#035;/g;
                   17250:         $outgoing =~ s/\&/&#038;/g;
                   17251:         $outgoing =~ s/</&#060;/g;
                   17252:         $outgoing =~ s/>/&#062;/g;
                   17253:         $outgoing =~ s/\(/&#040/g;
                   17254:         $outgoing =~ s/\)/&#041;/g;
                   17255:         $outgoing =~ s/"/&#034;/g;
                   17256:         $outgoing =~ s/'/&#039;/g;
                   17257:         $outgoing =~ s/\$/&#036;/g;
                   17258:         $outgoing =~ s{/}{&#047;}g;
                   17259:         $outgoing =~ s/=/&#061;/g;
                   17260:         $outgoing =~ s/\\/&#092;/g
                   17261:     }
                   17262:     return $outgoing;
                   17263: }
                   17264: 
1.1075.2.74  raeburn  17265: # Checks for critical messages and returns a redirect url if one exists.
                   17266: # $interval indicates how often to check for messages.
                   17267: sub critical_redirect {
                   17268:     my ($interval) = @_;
                   17269:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
                   17270:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
                   17271:                                         $env{'user.name'});
                   17272:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
                   17273:         my $redirecturl;
                   17274:         if ($what[0]) {
                   17275:             if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) {
                   17276:                 $redirecturl='/adm/email?critical=display';
                   17277:                 my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   17278:                 return (1, $url);
                   17279:             }
                   17280:         }
                   17281:     }
                   17282:     return ();
                   17283: }
                   17284: 
1.1075.2.64  raeburn  17285: # Use:
                   17286: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   17287: #
                   17288: ##################################################
                   17289: #          password associated functions         #
                   17290: ##################################################
                   17291: sub des_keys {
                   17292:     # Make a new key for DES encryption.
                   17293:     # Each key has two parts which are returned separately.
                   17294:     # Please note:  Each key must be passed through the &hex function
                   17295:     # before it is output to the web browser.  The hex versions cannot
                   17296:     # be used to decrypt.
                   17297:     my @hexstr=('0','1','2','3','4','5','6','7',
                   17298:                 '8','9','a','b','c','d','e','f');
                   17299:     my $lkey='';
                   17300:     for (0..7) {
                   17301:         $lkey.=$hexstr[rand(15)];
                   17302:     }
                   17303:     my $ukey='';
                   17304:     for (0..7) {
                   17305:         $ukey.=$hexstr[rand(15)];
                   17306:     }
                   17307:     return ($lkey,$ukey);
                   17308: }
                   17309: 
                   17310: sub des_decrypt {
                   17311:     my ($key,$cyphertext) = @_;
                   17312:     my $keybin=pack("H16",$key);
                   17313:     my $cypher;
                   17314:     if ($Crypt::DES::VERSION>=2.03) {
                   17315:         $cypher=new Crypt::DES $keybin;
                   17316:     } else {
                   17317:         $cypher=new DES $keybin;
                   17318:     }
1.1075.2.106  raeburn  17319:     my $plaintext='';
                   17320:     my $cypherlength = length($cyphertext);
                   17321:     my $numchunks = int($cypherlength/32);
                   17322:     for (my $j=0; $j<$numchunks; $j++) {
                   17323:         my $start = $j*32;
                   17324:         my $cypherblock = substr($cyphertext,$start,32);
                   17325:         my $chunk =
                   17326:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   17327:         $chunk .=
                   17328:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   17329:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   17330:         $plaintext .= $chunk;
                   17331:     }
1.1075.2.64  raeburn  17332:     return $plaintext;
                   17333: }
                   17334: 
1.1075.2.135  raeburn  17335: sub is_nonframeable {
                   17336:     my ($url,$absolute,$hostname,$ip,$nocache) = @_;
                   17337:     my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
                   17338:     return if (($remprotocol eq '') || ($remhost eq ''));
                   17339: 
                   17340:     $remprotocol = lc($remprotocol);
                   17341:     $remhost = lc($remhost);
                   17342:     my $remport = 80;
                   17343:     if ($remprotocol eq 'https') {
                   17344:         $remport = 443;
                   17345:     }
                   17346:     my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
                   17347:     if ($cached) {
                   17348:         unless ($nocache) {
                   17349:             if ($result) {
                   17350:                 return 1;
                   17351:             } else {
                   17352:                 return 0;
                   17353:             }
                   17354:         }
                   17355:     }
                   17356:     my $uselink;
                   17357:     my $request = new HTTP::Request('HEAD',$url);
1.1075.2.142  raeburn  17358:     my $ua = LWP::UserAgent->new;
                   17359:     $ua->timeout(5);
                   17360:     my $response=$ua->request($request);
1.1075.2.135  raeburn  17361:     if ($response->is_success()) {
                   17362:         my $secpolicy = lc($response->header('content-security-policy'));
                   17363:         my $xframeop = lc($response->header('x-frame-options'));
                   17364:         $secpolicy =~ s/^\s+|\s+$//g;
                   17365:         $xframeop =~ s/^\s+|\s+$//g;
                   17366:         if (($secpolicy ne '') || ($xframeop ne '')) {
                   17367:             my $remotehost = $remprotocol.'://'.$remhost;
                   17368:             my ($origin,$protocol,$port);
                   17369:             if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
                   17370:                 $port = $ENV{'SERVER_PORT'};
                   17371:             } else {
                   17372:                 $port = 80;
                   17373:             }
                   17374:             if ($absolute eq '') {
                   17375:                 $protocol = 'http:';
                   17376:                 if ($port == 443) {
                   17377:                     $protocol = 'https:';
                   17378:                 }
                   17379:                 $origin = $protocol.'//'.lc($hostname);
                   17380:             } else {
                   17381:                 $origin = lc($absolute);
                   17382:                 ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
                   17383:             }
                   17384:             if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
                   17385:                 my $framepolicy = $1;
                   17386:                 $framepolicy =~ s/^\s+|\s+$//g;
                   17387:                 my @policies = split(/\s+/,$framepolicy);
                   17388:                 if (@policies) {
                   17389:                     if (grep(/^\Q'none'\E$/,@policies)) {
                   17390:                         $uselink = 1;
                   17391:                     } else {
                   17392:                         $uselink = 1;
                   17393:                         if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
                   17394:                                 (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
                   17395:                                 (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
                   17396:                             undef($uselink);
                   17397:                         }
                   17398:                         if ($uselink) {
                   17399:                             if (grep(/^\Q'self'\E$/,@policies)) {
                   17400:                                 if (($origin ne '') && ($remotehost eq $origin)) {
                   17401:                                     undef($uselink);
                   17402:                                 }
                   17403:                             }
                   17404:                         }
                   17405:                         if ($uselink) {
                   17406:                             my @possok;
                   17407:                             if ($ip ne '') {
                   17408:                                 push(@possok,$ip);
                   17409:                             }
                   17410:                             my $hoststr = '';
                   17411:                             foreach my $part (reverse(split(/\./,$hostname))) {
                   17412:                                 if ($hoststr eq '') {
                   17413:                                     $hoststr = $part;
                   17414:                                 } else {
                   17415:                                     $hoststr = "$part.$hoststr";
                   17416:                                 }
                   17417:                                 if ($hoststr eq $hostname) {
                   17418:                                     push(@possok,$hostname);
                   17419:                                 } else {
                   17420:                                     push(@possok,"*.$hoststr");
                   17421:                                 }
                   17422:                             }
                   17423:                             if (@possok) {
                   17424:                                 foreach my $poss (@possok) {
                   17425:                                     last if (!$uselink);
                   17426:                                     foreach my $policy (@policies) {
                   17427:                                         if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
                   17428:                                             undef($uselink);
                   17429:                                             last;
                   17430:                                         }
                   17431:                                     }
                   17432:                                 }
                   17433:                             }
                   17434:                         }
                   17435:                     }
                   17436:                 }
                   17437:             } elsif ($xframeop ne '') {
                   17438:                 $uselink = 1;
                   17439:                 my @policies = split(/\s*,\s*/,$xframeop);
                   17440:                 if (@policies) {
                   17441:                     unless (grep(/^deny$/,@policies)) {
                   17442:                         if ($origin ne '') {
                   17443:                             if (grep(/^sameorigin$/,@policies)) {
                   17444:                                 if ($remotehost eq $origin) {
                   17445:                                     undef($uselink);
                   17446:                                 }
                   17447:                             }
                   17448:                             if ($uselink) {
                   17449:                                 foreach my $policy (@policies) {
                   17450:                                     if ($policy =~ /^allow-from\s*(.+)$/) {
                   17451:                                         my $allowfrom = $1;
                   17452:                                         if (($allowfrom ne '') && ($allowfrom eq $origin)) {
                   17453:                                             undef($uselink);
                   17454:                                             last;
                   17455:                                         }
                   17456:                                     }
                   17457:                                 }
                   17458:                             }
                   17459:                         }
                   17460:                     }
                   17461:                 }
                   17462:             }
                   17463:         }
                   17464:     }
                   17465:     if ($nocache) {
                   17466:         if ($cached) {
                   17467:             my $devalidate;
                   17468:             if ($uselink && !$result) {
                   17469:                 $devalidate = 1;
                   17470:             } elsif (!$uselink && $result) {
                   17471:                 $devalidate = 1;
                   17472:             }
                   17473:             if ($devalidate) {
                   17474:                 &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
                   17475:             }
                   17476:         }
                   17477:     } else {
                   17478:         if ($uselink) {
                   17479:             $result = 1;
                   17480:         } else {
                   17481:             $result = 0;
                   17482:         }
                   17483:         &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
                   17484:     }
                   17485:     return $uselink;
                   17486: }
                   17487: 
1.112     bowersj2 17488: 1;
                   17489: __END__;
1.41      ng       17490: 

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