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

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.152! raeburn     4: # $Id: loncommon.pm,v 1.1075.2.151 2021/01/29 02:42:15 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));
                   8044:                                 $msg = &mt('Once the following tasks are complete: ')."\n".
                   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 {
                   8533:     my ($funcname,$width,$height,$content)=@_;
                   8534:     return (<<ENDADHOC);
1.1046    raeburn  8535: <script type="text/javascript">
1.1032    www      8536: // <![CDATA[
                   8537:         var $funcname = function()
                   8538:         {
                   8539:                 modalWindow.windowId = "myModal";
                   8540:                 modalWindow.width = $width;
                   8541:                 modalWindow.height = $height;
                   8542:                 modalWindow.content = '$content';
                   8543:                 modalWindow.open();
                   8544:         };  
                   8545: // ]]>
                   8546: </script>
                   8547: ENDADHOC
                   8548: }
                   8549: 
1.1041    www      8550: sub modal_adhoc_inner {
                   8551:     my ($funcname,$width,$height,$content)=@_;
                   8552:     my $innerwidth=$width-20;
                   8553:     $content=&js_ready(
1.1042    www      8554:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1075.2.42  raeburn  8555:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   8556:                  $content.
1.1041    www      8557:                  &end_scrollbox().
1.1075.2.42  raeburn  8558:                  &end_page()
1.1041    www      8559:              );
                   8560:     return &modal_adhoc_script($funcname,$width,$height,$content);
                   8561: }
                   8562: 
                   8563: sub modal_adhoc_window {
                   8564:     my ($funcname,$width,$height,$content,$linktext)=@_;
                   8565:     return &modal_adhoc_inner($funcname,$width,$height,$content).
                   8566:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   8567: }
                   8568: 
                   8569: sub modal_adhoc_launch {
                   8570:     my ($funcname,$width,$height,$content)=@_;
                   8571:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   8572: <script type="text/javascript">
                   8573: // <![CDATA[
                   8574: $funcname();
                   8575: // ]]>
                   8576: </script>
                   8577: ENDLAUNCH
                   8578: }
                   8579: 
                   8580: sub modal_adhoc_close {
                   8581:     return (<<ENDCLOSE);
                   8582: <script type="text/javascript">
                   8583: // <![CDATA[
                   8584: modalWindow.close();
                   8585: // ]]>
                   8586: </script>
                   8587: ENDCLOSE
                   8588: }
                   8589: 
1.1038    www      8590: sub togglebox_script {
                   8591:    return(<<ENDTOGGLE);
                   8592: <script type="text/javascript"> 
                   8593: // <![CDATA[
                   8594: function LCtoggleDisplay(id,hidetext,showtext) {
                   8595:    link = document.getElementById(id + "link").childNodes[0];
                   8596:    with (document.getElementById(id).style) {
                   8597:       if (display == "none" ) {
                   8598:           display = "inline";
                   8599:           link.nodeValue = hidetext;
                   8600:         } else {
                   8601:           display = "none";
                   8602:           link.nodeValue = showtext;
                   8603:        }
                   8604:    }
                   8605: }
                   8606: // ]]>
                   8607: </script>
                   8608: ENDTOGGLE
                   8609: }
                   8610: 
1.1039    www      8611: sub start_togglebox {
                   8612:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   8613:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   8614:     unless ($showtext) { $showtext=&mt('show'); }
                   8615:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   8616:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   8617:     return &start_data_table().
                   8618:            &start_data_table_header_row().
                   8619:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   8620:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   8621:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   8622:            &end_data_table_header_row().
                   8623:            '<tr id="'.$id.'" style="display:none""><td>';
                   8624: }
                   8625: 
                   8626: sub end_togglebox {
                   8627:     return '</td></tr>'.&end_data_table();
                   8628: }
                   8629: 
1.1041    www      8630: sub LCprogressbar_script {
1.1075.2.130  raeburn  8631:    my ($id,$number_to_do)=@_;
                   8632:    if ($number_to_do) {
                   8633:        return(<<ENDPROGRESS);
1.1041    www      8634: <script type="text/javascript">
                   8635: // <![CDATA[
1.1045    www      8636: \$('#progressbar$id').progressbar({
1.1041    www      8637:   value: 0,
                   8638:   change: function(event, ui) {
                   8639:     var newVal = \$(this).progressbar('option', 'value');
                   8640:     \$('.pblabel', this).text(LCprogressTxt);
                   8641:   }
                   8642: });
                   8643: // ]]>
                   8644: </script>
                   8645: ENDPROGRESS
1.1075.2.130  raeburn  8646:    } else {
                   8647:        return(<<ENDPROGRESS);
                   8648: <script type="text/javascript">
                   8649: // <![CDATA[
                   8650: \$('#progressbar$id').progressbar({
                   8651:   value: false,
                   8652:   create: function(event, ui) {
                   8653:     \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
                   8654:     \$('.ui-progressbar-overlay', this).css({'margin':'0'});
                   8655:   }
                   8656: });
                   8657: // ]]>
                   8658: </script>
                   8659: ENDPROGRESS
                   8660:    }
1.1041    www      8661: }
                   8662: 
                   8663: sub LCprogressbarUpdate_script {
                   8664:    return(<<ENDPROGRESSUPDATE);
                   8665: <style type="text/css">
                   8666: .ui-progressbar { position:relative; }
1.1075.2.130  raeburn  8667: .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      8668: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   8669: </style>
                   8670: <script type="text/javascript">
                   8671: // <![CDATA[
1.1045    www      8672: var LCprogressTxt='---';
                   8673: 
1.1075.2.130  raeburn  8674: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041    www      8675:    LCprogressTxt=progresstext;
1.1075.2.130  raeburn  8676:    if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
                   8677:        \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
                   8678:    } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
                   8679:        \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
                   8680:    } else {
                   8681:        \$('#progressbar'+id).progressbar('value',percent);
                   8682:    }
1.1041    www      8683: }
                   8684: // ]]>
                   8685: </script>
                   8686: ENDPROGRESSUPDATE
                   8687: }
                   8688: 
1.1042    www      8689: my $LClastpercent;
1.1045    www      8690: my $LCidcnt;
                   8691: my $LCcurrentid;
1.1042    www      8692: 
1.1041    www      8693: sub LCprogressbar {
1.1075.2.130  raeburn  8694:     my ($r,$number_to_do,$preamble)=@_;
1.1042    www      8695:     $LClastpercent=0;
1.1045    www      8696:     $LCidcnt++;
                   8697:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1075.2.130  raeburn  8698:     my ($starting,$content);
                   8699:     if ($number_to_do) {
                   8700:         $starting=&mt('Starting');
                   8701:         $content=(<<ENDPROGBAR);
                   8702: $preamble
1.1045    www      8703:   <div id="progressbar$LCcurrentid">
1.1041    www      8704:     <span class="pblabel">$starting</span>
                   8705:   </div>
                   8706: ENDPROGBAR
1.1075.2.130  raeburn  8707:     } else {
                   8708:         $starting=&mt('Loading...');
                   8709:         $LClastpercent='false';
                   8710:         $content=(<<ENDPROGBAR);
                   8711: $preamble
                   8712:   <div id="progressbar$LCcurrentid">
                   8713:       <div class="progress-label">$starting</div>
                   8714:   </div>
                   8715: ENDPROGBAR
                   8716:     }
                   8717:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041    www      8718: }
                   8719: 
                   8720: sub LCprogressbarUpdate {
1.1075.2.130  raeburn  8721:     my ($r,$val,$text,$number_to_do)=@_;
                   8722:     if ($number_to_do) {
                   8723:         unless ($val) { 
                   8724:             if ($LClastpercent) {
                   8725:                 $val=$LClastpercent;
                   8726:             } else {
                   8727:                 $val=0;
                   8728:             }
                   8729:         }
                   8730:         if ($val<0) { $val=0; }
                   8731:         if ($val>100) { $val=0; }
                   8732:         $LClastpercent=$val;
                   8733:         unless ($text) { $text=$val.'%'; }
                   8734:     } else {
                   8735:         $val = 'false';
1.1042    www      8736:     }
1.1041    www      8737:     $text=&js_ready($text);
1.1044    www      8738:     &r_print($r,<<ENDUPDATE);
1.1041    www      8739: <script type="text/javascript">
                   8740: // <![CDATA[
1.1075.2.130  raeburn  8741: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041    www      8742: // ]]>
                   8743: </script>
                   8744: ENDUPDATE
1.1035    www      8745: }
                   8746: 
1.1042    www      8747: sub LCprogressbarClose {
                   8748:     my ($r)=@_;
                   8749:     $LClastpercent=0;
1.1044    www      8750:     &r_print($r,<<ENDCLOSE);
1.1042    www      8751: <script type="text/javascript">
                   8752: // <![CDATA[
1.1045    www      8753: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      8754: // ]]>
                   8755: </script>
                   8756: ENDCLOSE
1.1044    www      8757: }
                   8758: 
                   8759: sub r_print {
                   8760:     my ($r,$to_print)=@_;
                   8761:     if ($r) {
                   8762:       $r->print($to_print);
                   8763:       $r->rflush();
                   8764:     } else {
                   8765:       print($to_print);
                   8766:     }
1.1042    www      8767: }
                   8768: 
1.320     albertel 8769: sub html_encode {
                   8770:     my ($result) = @_;
                   8771: 
1.322     albertel 8772:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 8773:     
                   8774:     return $result;
                   8775: }
1.1044    www      8776: 
1.317     albertel 8777: sub js_ready {
                   8778:     my ($result) = @_;
                   8779: 
1.323     albertel 8780:     $result =~ s/[\n\r]/ /xmsg;
                   8781:     $result =~ s/\\/\\\\/xmsg;
                   8782:     $result =~ s/'/\\'/xmsg;
1.372     albertel 8783:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 8784:     
                   8785:     return $result;
                   8786: }
                   8787: 
1.315     albertel 8788: sub validate_page {
                   8789:     if (  exists($env{'internal.start_page'})
1.316     albertel 8790: 	  &&     $env{'internal.start_page'} > 1) {
                   8791: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 8792: 				 $env{'internal.start_page'}.' '.
1.316     albertel 8793: 				 $ENV{'request.filename'});
1.315     albertel 8794:     }
                   8795:     if (  exists($env{'internal.end_page'})
1.316     albertel 8796: 	  &&     $env{'internal.end_page'} > 1) {
                   8797: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 8798: 				 $env{'internal.end_page'}.' '.
1.316     albertel 8799: 				 $env{'request.filename'});
1.315     albertel 8800:     }
                   8801:     if (     exists($env{'internal.start_page'})
                   8802: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 8803: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   8804: 				 $env{'request.filename'});
1.315     albertel 8805:     }
                   8806:     if (   ! exists($env{'internal.start_page'})
                   8807: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 8808: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   8809: 				 $env{'request.filename'});
1.315     albertel 8810:     }
1.306     albertel 8811: }
1.315     albertel 8812: 
1.996     www      8813: 
                   8814: sub start_scrollbox {
1.1075.2.56  raeburn  8815:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  8816:     unless ($outerwidth) { $outerwidth='520px'; }
                   8817:     unless ($width) { $width='500px'; }
                   8818:     unless ($height) { $height='200px'; }
1.1075    raeburn  8819:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  8820:     if ($id ne '') {
1.1075.2.42  raeburn  8821:         $table_id = ' id="table_'.$id.'"';
                   8822:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  8823:     }
1.1075    raeburn  8824:     if ($bgcolor ne '') {
                   8825:         $tdcol = "background-color: $bgcolor;";
                   8826:     }
1.1075.2.42  raeburn  8827:     my $nicescroll_js;
                   8828:     if ($env{'browser.mobile'}) {
                   8829:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   8830:     }
1.1075    raeburn  8831:     return <<"END";
1.1075.2.42  raeburn  8832: $nicescroll_js
                   8833: 
                   8834: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
1.1075.2.56  raeburn  8835: <div style="overflow:auto; width:$width; height:$height;"$div_id>
1.1075    raeburn  8836: END
1.996     www      8837: }
                   8838: 
                   8839: sub end_scrollbox {
1.1036    www      8840:     return '</div></td></tr></table>';
1.996     www      8841: }
                   8842: 
1.1075.2.42  raeburn  8843: sub nicescroll_javascript {
                   8844:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   8845:     my %options;
                   8846:     if (ref($cursor) eq 'HASH') {
                   8847:         %options = %{$cursor};
                   8848:     }
                   8849:     unless ($options{'railalign'} =~ /^left|right$/) {
                   8850:         $options{'railalign'} = 'left';
                   8851:     }
                   8852:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   8853:         my $function  = &get_users_function();
                   8854:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
                   8855:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   8856:             $options{'cursorcolor'} = '#00F';
                   8857:         }
                   8858:     }
                   8859:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   8860:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
                   8861:             $options{'cursoropacity'}='1.0';
                   8862:         }
                   8863:     } else {
                   8864:         $options{'cursoropacity'}='1.0';
                   8865:     }
                   8866:     if ($options{'cursorfixedheight'} eq 'none') {
                   8867:         delete($options{'cursorfixedheight'});
                   8868:     } else {
                   8869:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   8870:     }
                   8871:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   8872:         delete($options{'railoffset'});
                   8873:     }
                   8874:     my @niceoptions;
                   8875:     while (my($key,$value) = each(%options)) {
                   8876:         if ($value =~ /^\{.+\}$/) {
                   8877:             push(@niceoptions,$key.':'.$value);
                   8878:         } else {
                   8879:             push(@niceoptions,$key.':"'.$value.'"');
                   8880:         }
                   8881:     }
                   8882:     my $nicescroll_js = '
                   8883: $(document).ready(
                   8884:       function() {
                   8885:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   8886:       }
                   8887: );
                   8888: ';
                   8889:     if ($framecheck) {
                   8890:         $nicescroll_js .= '
                   8891: function expand_div(caller) {
                   8892:     if (top === self) {
                   8893:         document.getElementById("'.$id.'").style.width = "auto";
                   8894:         document.getElementById("'.$id.'").style.height = "auto";
                   8895:     } else {
                   8896:         try {
                   8897:             if (parent.frames) {
                   8898:                 if (parent.frames.length > 1) {
                   8899:                     var framesrc = parent.frames[1].location.href;
                   8900:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   8901:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   8902:                         document.getElementById("'.$id.'").style.width = "auto";
                   8903:                         document.getElementById("'.$id.'").style.height = "auto";
                   8904:                     }
                   8905:                 }
                   8906:             }
                   8907:         } catch (e) {
                   8908:             return;
                   8909:         }
                   8910:     }
                   8911:     return;
                   8912: }
                   8913: ';
                   8914:     }
                   8915:     if ($needjsready) {
                   8916:         $nicescroll_js = '
                   8917: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   8918:     } else {
                   8919:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   8920:     }
                   8921:     return $nicescroll_js;
                   8922: }
                   8923: 
1.318     albertel 8924: sub simple_error_page {
1.1075.2.49  raeburn  8925:     my ($r,$title,$msg,$args) = @_;
                   8926:     if (ref($args) eq 'HASH') {
                   8927:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
                   8928:     } else {
                   8929:         $msg = &mt($msg);
                   8930:     }
                   8931: 
1.318     albertel 8932:     my $page =
                   8933: 	&Apache::loncommon::start_page($title).
1.1075.2.49  raeburn  8934: 	'<p class="LC_error">'.$msg.'</p>'.
1.318     albertel 8935: 	&Apache::loncommon::end_page();
                   8936:     if (ref($r)) {
                   8937: 	$r->print($page);
1.327     albertel 8938: 	return;
1.318     albertel 8939:     }
                   8940:     return $page;
                   8941: }
1.347     albertel 8942: 
                   8943: {
1.610     albertel 8944:     my @row_count;
1.961     onken    8945: 
                   8946:     sub start_data_table_count {
                   8947:         unshift(@row_count, 0);
                   8948:         return;
                   8949:     }
                   8950: 
                   8951:     sub end_data_table_count {
                   8952:         shift(@row_count);
                   8953:         return;
                   8954:     }
                   8955: 
1.347     albertel 8956:     sub start_data_table {
1.1018    raeburn  8957: 	my ($add_class,$id) = @_;
1.422     albertel 8958: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  8959:         my $table_id;
                   8960:         if (defined($id)) {
                   8961:             $table_id = ' id="'.$id.'"';
                   8962:         }
1.961     onken    8963: 	&start_data_table_count();
1.1018    raeburn  8964: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 8965:     }
                   8966: 
                   8967:     sub end_data_table {
1.961     onken    8968: 	&end_data_table_count();
1.389     albertel 8969: 	return '</table>'."\n";;
1.347     albertel 8970:     }
                   8971: 
                   8972:     sub start_data_table_row {
1.974     wenzelju 8973: 	my ($add_class, $id) = @_;
1.610     albertel 8974: 	$row_count[0]++;
                   8975: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   8976: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 8977:         $id = (' id="'.$id.'"') unless ($id eq '');
                   8978:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 8979:     }
1.471     banghart 8980:     
                   8981:     sub continue_data_table_row {
1.974     wenzelju 8982: 	my ($add_class, $id) = @_;
1.610     albertel 8983: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 8984: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   8985:         $id = (' id="'.$id.'"') unless ($id eq '');
                   8986:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 8987:     }
1.347     albertel 8988: 
                   8989:     sub end_data_table_row {
1.389     albertel 8990: 	return '</tr>'."\n";;
1.347     albertel 8991:     }
1.367     www      8992: 
1.421     albertel 8993:     sub start_data_table_empty_row {
1.707     bisitz   8994: #	$row_count[0]++;
1.421     albertel 8995: 	return  '<tr class="LC_empty_row" >'."\n";;
                   8996:     }
                   8997: 
                   8998:     sub end_data_table_empty_row {
                   8999: 	return '</tr>'."\n";;
                   9000:     }
                   9001: 
1.367     www      9002:     sub start_data_table_header_row {
1.389     albertel 9003: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      9004:     }
                   9005: 
                   9006:     sub end_data_table_header_row {
1.389     albertel 9007: 	return '</tr>'."\n";;
1.367     www      9008:     }
1.890     droeschl 9009: 
                   9010:     sub data_table_caption {
                   9011:         my $caption = shift;
                   9012:         return "<caption class=\"LC_caption\">$caption</caption>";
                   9013:     }
1.347     albertel 9014: }
                   9015: 
1.548     albertel 9016: =pod
                   9017: 
                   9018: =item * &inhibit_menu_check($arg)
                   9019: 
                   9020: Checks for a inhibitmenu state and generates output to preserve it
                   9021: 
                   9022: Inputs:         $arg - can be any of
                   9023:                      - undef - in which case the return value is a string 
                   9024:                                to add  into arguments list of a uri
                   9025:                      - 'input' - in which case the return value is a HTML
                   9026:                                  <form> <input> field of type hidden to
                   9027:                                  preserve the value
                   9028:                      - a url - in which case the return value is the url with
                   9029:                                the neccesary cgi args added to preserve the
                   9030:                                inhibitmenu state
                   9031:                      - a ref to a url - no return value, but the string is
                   9032:                                         updated to include the neccessary cgi
                   9033:                                         args to preserve the inhibitmenu state
                   9034: 
                   9035: =cut
                   9036: 
                   9037: sub inhibit_menu_check {
                   9038:     my ($arg) = @_;
                   9039:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   9040:     if ($arg eq 'input') {
                   9041: 	if ($env{'form.inhibitmenu'}) {
                   9042: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   9043: 	} else {
                   9044: 	    return
                   9045: 	}
                   9046:     }
                   9047:     if ($env{'form.inhibitmenu'}) {
                   9048: 	if (ref($arg)) {
                   9049: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9050: 	} elsif ($arg eq '') {
                   9051: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   9052: 	} else {
                   9053: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9054: 	}
                   9055:     }
                   9056:     if (!ref($arg)) {
                   9057: 	return $arg;
                   9058:     }
                   9059: }
                   9060: 
1.251     albertel 9061: ###############################################
1.182     matthew  9062: 
                   9063: =pod
                   9064: 
1.549     albertel 9065: =back
                   9066: 
                   9067: =head1 User Information Routines
                   9068: 
                   9069: =over 4
                   9070: 
1.405     albertel 9071: =item * &get_users_function()
1.182     matthew  9072: 
                   9073: Used by &bodytag to determine the current users primary role.
                   9074: Returns either 'student','coordinator','admin', or 'author'.
                   9075: 
                   9076: =cut
                   9077: 
                   9078: ###############################################
                   9079: sub get_users_function {
1.815     tempelho 9080:     my $function = 'norole';
1.818     tempelho 9081:     if ($env{'request.role'}=~/^(st)/) {
                   9082:         $function='student';
                   9083:     }
1.907     raeburn  9084:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  9085:         $function='coordinator';
                   9086:     }
1.258     albertel 9087:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  9088:         $function='admin';
                   9089:     }
1.826     bisitz   9090:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  9091:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  9092:         $function='author';
                   9093:     }
                   9094:     return $function;
1.54      www      9095: }
1.99      www      9096: 
                   9097: ###############################################
                   9098: 
1.233     raeburn  9099: =pod
                   9100: 
1.821     raeburn  9101: =item * &show_course()
                   9102: 
                   9103: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   9104: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   9105: 
                   9106: Inputs:
                   9107: None
                   9108: 
                   9109: Outputs:
                   9110: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   9111: 
                   9112: =cut
                   9113: 
                   9114: ###############################################
                   9115: sub show_course {
                   9116:     my $course = !$env{'user.adv'};
                   9117:     if (!$env{'user.adv'}) {
                   9118:         foreach my $env (keys(%env)) {
                   9119:             next if ($env !~ m/^user\.priv\./);
                   9120:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   9121:                 $course = 0;
                   9122:                 last;
                   9123:             }
                   9124:         }
                   9125:     }
                   9126:     return $course;
                   9127: }
                   9128: 
                   9129: ###############################################
                   9130: 
                   9131: =pod
                   9132: 
1.542     raeburn  9133: =item * &check_user_status()
1.274     raeburn  9134: 
                   9135: Determines current status of supplied role for a
                   9136: specific user. Roles can be active, previous or future.
                   9137: 
                   9138: Inputs: 
                   9139: user's domain, user's username, course's domain,
1.375     raeburn  9140: course's number, optional section ID.
1.274     raeburn  9141: 
                   9142: Outputs:
                   9143: role status: active, previous or future. 
                   9144: 
                   9145: =cut
                   9146: 
                   9147: sub check_user_status {
1.412     raeburn  9148:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  9149:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1075.2.85  raeburn  9150:     my @uroles = keys(%userinfo);
1.274     raeburn  9151:     my $srchstr;
                   9152:     my $active_chk = 'none';
1.412     raeburn  9153:     my $now = time;
1.274     raeburn  9154:     if (@uroles > 0) {
1.908     raeburn  9155:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  9156:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   9157:         } else {
1.412     raeburn  9158:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   9159:         }
                   9160:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  9161:             my $role_end = 0;
                   9162:             my $role_start = 0;
                   9163:             $active_chk = 'active';
1.412     raeburn  9164:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   9165:                 $role_end = $1;
                   9166:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   9167:                     $role_start = $1;
1.274     raeburn  9168:                 }
                   9169:             }
                   9170:             if ($role_start > 0) {
1.412     raeburn  9171:                 if ($now < $role_start) {
1.274     raeburn  9172:                     $active_chk = 'future';
                   9173:                 }
                   9174:             }
                   9175:             if ($role_end > 0) {
1.412     raeburn  9176:                 if ($now > $role_end) {
1.274     raeburn  9177:                     $active_chk = 'previous';
                   9178:                 }
                   9179:             }
                   9180:         }
                   9181:     }
                   9182:     return $active_chk;
                   9183: }
                   9184: 
                   9185: ###############################################
                   9186: 
                   9187: =pod
                   9188: 
1.405     albertel 9189: =item * &get_sections()
1.233     raeburn  9190: 
                   9191: Determines all the sections for a course including
                   9192: sections with students and sections containing other roles.
1.419     raeburn  9193: Incoming parameters: 
                   9194: 
                   9195: 1. domain
                   9196: 2. course number 
                   9197: 3. reference to array containing roles for which sections should 
                   9198: be gathered (optional).
                   9199: 4. reference to array containing status types for which sections 
                   9200: should be gathered (optional).
                   9201: 
                   9202: If the third argument is undefined, sections are gathered for any role. 
                   9203: If the fourth argument is undefined, sections are gathered for any status.
                   9204: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  9205:  
1.374     raeburn  9206: Returns section hash (keys are section IDs, values are
                   9207: number of users in each section), subject to the
1.419     raeburn  9208: optional roles filter, optional status filter 
1.233     raeburn  9209: 
                   9210: =cut
                   9211: 
                   9212: ###############################################
                   9213: sub get_sections {
1.419     raeburn  9214:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 9215:     if (!defined($cdom) || !defined($cnum)) {
                   9216:         my $cid =  $env{'request.course.id'};
                   9217: 
                   9218: 	return if (!defined($cid));
                   9219: 
                   9220:         $cdom = $env{'course.'.$cid.'.domain'};
                   9221:         $cnum = $env{'course.'.$cid.'.num'};
                   9222:     }
                   9223: 
                   9224:     my %sectioncount;
1.419     raeburn  9225:     my $now = time;
1.240     albertel 9226: 
1.1075.2.33  raeburn  9227:     my $check_students = 1;
                   9228:     my $only_students = 0;
                   9229:     if (ref($possible_roles) eq 'ARRAY') {
                   9230:         if (grep(/^st$/,@{$possible_roles})) {
                   9231:             if (@{$possible_roles} == 1) {
                   9232:                 $only_students = 1;
                   9233:             }
                   9234:         } else {
                   9235:             $check_students = 0;
                   9236:         }
                   9237:     }
                   9238: 
                   9239:     if ($check_students) {
1.276     albertel 9240: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 9241: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   9242: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  9243:         my $start_index = &Apache::loncoursedata::CL_START();
                   9244:         my $end_index = &Apache::loncoursedata::CL_END();
                   9245:         my $status;
1.366     albertel 9246: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  9247: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   9248: 				                     $data->[$status_index],
                   9249:                                                      $data->[$start_index],
                   9250:                                                      $data->[$end_index]);
                   9251:             if ($stu_status eq 'Active') {
                   9252:                 $status = 'active';
                   9253:             } elsif ($end < $now) {
                   9254:                 $status = 'previous';
                   9255:             } elsif ($start > $now) {
                   9256:                 $status = 'future';
                   9257:             } 
                   9258: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   9259:                 if ((!defined($possible_status)) || (($status ne '') && 
                   9260:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   9261: 		    $sectioncount{$section}++;
                   9262:                 }
1.240     albertel 9263: 	    }
                   9264: 	}
                   9265:     }
1.1075.2.33  raeburn  9266:     if ($only_students) {
                   9267:         return %sectioncount;
                   9268:     }
1.240     albertel 9269:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9270:     foreach my $user (sort(keys(%courseroles))) {
                   9271: 	if ($user !~ /^(\w{2})/) { next; }
                   9272: 	my ($role) = ($user =~ /^(\w{2})/);
                   9273: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  9274: 	my ($section,$status);
1.240     albertel 9275: 	if ($role eq 'cr' &&
                   9276: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   9277: 	    $section=$1;
                   9278: 	}
                   9279: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   9280: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  9281:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   9282:         if ($end == -1 && $start == -1) {
                   9283:             next; #deleted role
                   9284:         }
                   9285:         if (!defined($possible_status)) { 
                   9286:             $sectioncount{$section}++;
                   9287:         } else {
                   9288:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   9289:                 $status = 'active';
                   9290:             } elsif ($end < $now) {
                   9291:                 $status = 'future';
                   9292:             } elsif ($start > $now) {
                   9293:                 $status = 'previous';
                   9294:             }
                   9295:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   9296:                 $sectioncount{$section}++;
                   9297:             }
                   9298:         }
1.233     raeburn  9299:     }
1.366     albertel 9300:     return %sectioncount;
1.233     raeburn  9301: }
                   9302: 
1.274     raeburn  9303: ###############################################
1.294     raeburn  9304: 
                   9305: =pod
1.405     albertel 9306: 
                   9307: =item * &get_course_users()
                   9308: 
1.275     raeburn  9309: Retrieves usernames:domains for users in the specified course
                   9310: with specific role(s), and access status. 
                   9311: 
                   9312: Incoming parameters:
1.277     albertel 9313: 1. course domain
                   9314: 2. course number
                   9315: 3. access status: users must have - either active, 
1.275     raeburn  9316: previous, future, or all.
1.277     albertel 9317: 4. reference to array of permissible roles
1.288     raeburn  9318: 5. reference to array of section restrictions (optional)
                   9319: 6. reference to results object (hash of hashes).
                   9320: 7. reference to optional userdata hash
1.609     raeburn  9321: 8. reference to optional statushash
1.630     raeburn  9322: 9. flag if privileged users (except those set to unhide in
                   9323:    course settings) should be excluded    
1.609     raeburn  9324: Keys of top level results hash are roles.
1.275     raeburn  9325: Keys of inner hashes are username:domain, with 
                   9326: values set to access type.
1.288     raeburn  9327: Optional userdata hash returns an array with arguments in the 
                   9328: same order as loncoursedata::get_classlist() for student data.
                   9329: 
1.609     raeburn  9330: Optional statushash returns
                   9331: 
1.288     raeburn  9332: Entries for end, start, section and status are blank because
                   9333: of the possibility of multiple values for non-student roles.
                   9334: 
1.275     raeburn  9335: =cut
1.405     albertel 9336: 
1.275     raeburn  9337: ###############################################
1.405     albertel 9338: 
1.275     raeburn  9339: sub get_course_users {
1.630     raeburn  9340:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  9341:     my %idx = ();
1.419     raeburn  9342:     my %seclists;
1.288     raeburn  9343: 
                   9344:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   9345:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   9346:     $idx{end} = &Apache::loncoursedata::CL_END();
                   9347:     $idx{start} = &Apache::loncoursedata::CL_START();
                   9348:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   9349:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   9350:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   9351:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   9352: 
1.290     albertel 9353:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 9354:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  9355:         my $now = time;
1.277     albertel 9356:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  9357:             my $match = 0;
1.412     raeburn  9358:             my $secmatch = 0;
1.419     raeburn  9359:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  9360:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  9361:             if ($section eq '') {
                   9362:                 $section = 'none';
                   9363:             }
1.291     albertel 9364:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9365:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9366:                     $secmatch = 1;
                   9367:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 9368:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9369:                         $secmatch = 1;
                   9370:                     }
                   9371:                 } else {  
1.419     raeburn  9372: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  9373: 		        $secmatch = 1;
                   9374:                     }
1.290     albertel 9375: 		}
1.412     raeburn  9376:                 if (!$secmatch) {
                   9377:                     next;
                   9378:                 }
1.419     raeburn  9379:             }
1.275     raeburn  9380:             if (defined($$types{'active'})) {
1.288     raeburn  9381:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  9382:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  9383:                     $match = 1;
1.275     raeburn  9384:                 }
                   9385:             }
                   9386:             if (defined($$types{'previous'})) {
1.609     raeburn  9387:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  9388:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  9389:                     $match = 1;
1.275     raeburn  9390:                 }
                   9391:             }
                   9392:             if (defined($$types{'future'})) {
1.609     raeburn  9393:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  9394:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  9395:                     $match = 1;
1.275     raeburn  9396:                 }
                   9397:             }
1.609     raeburn  9398:             if ($match) {
                   9399:                 push(@{$seclists{$student}},$section);
                   9400:                 if (ref($userdata) eq 'HASH') {
                   9401:                     $$userdata{$student} = $$classlist{$student};
                   9402:                 }
                   9403:                 if (ref($statushash) eq 'HASH') {
                   9404:                     $statushash->{$student}{'st'}{$section} = $status;
                   9405:                 }
1.288     raeburn  9406:             }
1.275     raeburn  9407:         }
                   9408:     }
1.412     raeburn  9409:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  9410:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9411:         my $now = time;
1.609     raeburn  9412:         my %displaystatus = ( previous => 'Expired',
                   9413:                               active   => 'Active',
                   9414:                               future   => 'Future',
                   9415:                             );
1.1075.2.36  raeburn  9416:         my (%nothide,@possdoms);
1.630     raeburn  9417:         if ($hidepriv) {
                   9418:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   9419:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   9420:                 if ($user !~ /:/) {
                   9421:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   9422:                 } else {
                   9423:                     $nothide{$user} = 1;
                   9424:                 }
                   9425:             }
1.1075.2.36  raeburn  9426:             my @possdoms = ($cdom);
                   9427:             if ($coursehash{'checkforpriv'}) {
                   9428:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   9429:             }
1.630     raeburn  9430:         }
1.439     raeburn  9431:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  9432:             my $match = 0;
1.412     raeburn  9433:             my $secmatch = 0;
1.439     raeburn  9434:             my $status;
1.412     raeburn  9435:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  9436:             $user =~ s/:$//;
1.439     raeburn  9437:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   9438:             if ($end == -1 || $start == -1) {
                   9439:                 next;
                   9440:             }
                   9441:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   9442:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  9443:                 my ($uname,$udom) = split(/:/,$user);
                   9444:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9445:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9446:                         $secmatch = 1;
                   9447:                     } elsif ($usec eq '') {
1.420     albertel 9448:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9449:                             $secmatch = 1;
                   9450:                         }
                   9451:                     } else {
                   9452:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   9453:                             $secmatch = 1;
                   9454:                         }
                   9455:                     }
                   9456:                     if (!$secmatch) {
                   9457:                         next;
                   9458:                     }
1.288     raeburn  9459:                 }
1.419     raeburn  9460:                 if ($usec eq '') {
                   9461:                     $usec = 'none';
                   9462:                 }
1.275     raeburn  9463:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  9464:                     if ($hidepriv) {
1.1075.2.36  raeburn  9465:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  9466:                             (!$nothide{$uname.':'.$udom})) {
                   9467:                             next;
                   9468:                         }
                   9469:                     }
1.503     raeburn  9470:                     if ($end > 0 && $end < $now) {
1.439     raeburn  9471:                         $status = 'previous';
                   9472:                     } elsif ($start > $now) {
                   9473:                         $status = 'future';
                   9474:                     } else {
                   9475:                         $status = 'active';
                   9476:                     }
1.277     albertel 9477:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  9478:                         if ($status eq $type) {
1.420     albertel 9479:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  9480:                                 push(@{$$users{$role}{$user}},$type);
                   9481:                             }
1.288     raeburn  9482:                             $match = 1;
                   9483:                         }
                   9484:                     }
1.419     raeburn  9485:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   9486:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   9487: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   9488:                         }
1.420     albertel 9489:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  9490:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   9491:                         }
1.609     raeburn  9492:                         if (ref($statushash) eq 'HASH') {
                   9493:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   9494:                         }
1.275     raeburn  9495:                     }
                   9496:                 }
                   9497:             }
                   9498:         }
1.290     albertel 9499:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  9500:             if ((defined($cdom)) && (defined($cnum))) {
                   9501:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   9502:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   9503:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  9504:                     next if ($owner eq '');
                   9505:                     my ($ownername,$ownerdom);
                   9506:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   9507:                         $ownername = $1;
                   9508:                         $ownerdom = $2;
                   9509:                     } else {
                   9510:                         $ownername = $owner;
                   9511:                         $ownerdom = $cdom;
                   9512:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  9513:                     }
                   9514:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 9515:                     if (defined($userdata) && 
1.609     raeburn  9516: 			!exists($$userdata{$owner})) {
                   9517: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   9518:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   9519:                             push(@{$seclists{$owner}},'none');
                   9520:                         }
                   9521:                         if (ref($statushash) eq 'HASH') {
                   9522:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  9523:                         }
1.290     albertel 9524: 		    }
1.279     raeburn  9525:                 }
                   9526:             }
                   9527:         }
1.419     raeburn  9528:         foreach my $user (keys(%seclists)) {
                   9529:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   9530:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   9531:         }
1.275     raeburn  9532:     }
                   9533:     return;
                   9534: }
                   9535: 
1.288     raeburn  9536: sub get_user_info {
                   9537:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 9538:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   9539: 	&plainname($uname,$udom,'lastname');
1.291     albertel 9540:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  9541:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  9542:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   9543:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  9544:     return;
                   9545: }
1.275     raeburn  9546: 
1.472     raeburn  9547: ###############################################
                   9548: 
                   9549: =pod
                   9550: 
                   9551: =item * &get_user_quota()
                   9552: 
1.1075.2.41  raeburn  9553: Retrieves quota assigned for storage of user files.
                   9554: Default is to report quota for portfolio files.
1.472     raeburn  9555: 
                   9556: Incoming parameters:
                   9557: 1. user's username
                   9558: 2. user's domain
1.1075.2.41  raeburn  9559: 3. quota name - portfolio, author, or course
                   9560:    (if no quota name provided, defaults to portfolio).
1.1075.2.59  raeburn  9561: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1075.2.42  raeburn  9562:    course
1.472     raeburn  9563: 
                   9564: Returns:
1.1075.2.58  raeburn  9565: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  9566: 2. (Optional) Type of setting: custom or default
                   9567:    (individually assigned or default for user's 
                   9568:    institutional status).
                   9569: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   9570:    or student - types as defined in localenroll::inst_usertypes 
                   9571:    for user's domain, which determines default quota for user.
                   9572: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  9573: 
                   9574: If a value has been stored in the user's environment, 
1.536     raeburn  9575: it will return that, otherwise it returns the maximal default
1.1075.2.41  raeburn  9576: defined for the user's institutional status(es) in the domain.
1.472     raeburn  9577: 
                   9578: =cut
                   9579: 
                   9580: ###############################################
                   9581: 
                   9582: 
                   9583: sub get_user_quota {
1.1075.2.42  raeburn  9584:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  9585:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  9586:     if (!defined($udom)) {
                   9587:         $udom = $env{'user.domain'};
                   9588:     }
                   9589:     if (!defined($uname)) {
                   9590:         $uname = $env{'user.name'};
                   9591:     }
                   9592:     if (($udom eq '' || $uname eq '') ||
                   9593:         ($udom eq 'public') && ($uname eq 'public')) {
                   9594:         $quota = 0;
1.536     raeburn  9595:         $quotatype = 'default';
                   9596:         $defquota = 0; 
1.472     raeburn  9597:     } else {
1.536     raeburn  9598:         my $inststatus;
1.1075.2.41  raeburn  9599:         if ($quotaname eq 'course') {
                   9600:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   9601:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   9602:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   9603:             } else {
                   9604:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   9605:                 $quota = $cenv{'internal.uploadquota'};
                   9606:             }
1.536     raeburn  9607:         } else {
1.1075.2.41  raeburn  9608:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   9609:                 if ($quotaname eq 'author') {
                   9610:                     $quota = $env{'environment.authorquota'};
                   9611:                 } else {
                   9612:                     $quota = $env{'environment.portfolioquota'};
                   9613:                 }
                   9614:                 $inststatus = $env{'environment.inststatus'};
                   9615:             } else {
                   9616:                 my %userenv = 
                   9617:                     &Apache::lonnet::get('environment',['portfolioquota',
                   9618:                                          'authorquota','inststatus'],$udom,$uname);
                   9619:                 my ($tmp) = keys(%userenv);
                   9620:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   9621:                     if ($quotaname eq 'author') {
                   9622:                         $quota = $userenv{'authorquota'};
                   9623:                     } else {
                   9624:                         $quota = $userenv{'portfolioquota'};
                   9625:                     }
                   9626:                     $inststatus = $userenv{'inststatus'};
                   9627:                 } else {
                   9628:                     undef(%userenv);
                   9629:                 }
                   9630:             }
                   9631:         }
                   9632:         if ($quota eq '' || wantarray) {
                   9633:             if ($quotaname eq 'course') {
                   9634:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1075.2.59  raeburn  9635:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
                   9636:                     ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1075.2.42  raeburn  9637:                     $defquota = $domdefs{$crstype.'quota'};
                   9638:                 }
                   9639:                 if ($defquota eq '') {
                   9640:                     $defquota = 500;
                   9641:                 }
1.1075.2.41  raeburn  9642:             } else {
                   9643:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   9644:             }
                   9645:             if ($quota eq '') {
                   9646:                 $quota = $defquota;
                   9647:                 $quotatype = 'default';
                   9648:             } else {
                   9649:                 $quotatype = 'custom';
                   9650:             }
1.472     raeburn  9651:         }
                   9652:     }
1.536     raeburn  9653:     if (wantarray) {
                   9654:         return ($quota,$quotatype,$settingstatus,$defquota);
                   9655:     } else {
                   9656:         return $quota;
                   9657:     }
1.472     raeburn  9658: }
                   9659: 
                   9660: ###############################################
                   9661: 
                   9662: =pod
                   9663: 
                   9664: =item * &default_quota()
                   9665: 
1.536     raeburn  9666: Retrieves default quota assigned for storage of user portfolio files,
                   9667: given an (optional) user's institutional status.
1.472     raeburn  9668: 
                   9669: Incoming parameters:
1.1075.2.42  raeburn  9670: 
1.472     raeburn  9671: 1. domain
1.536     raeburn  9672: 2. (Optional) institutional status(es).  This is a : separated list of 
                   9673:    status types (e.g., faculty, staff, student etc.)
                   9674:    which apply to the user for whom the default is being retrieved.
                   9675:    If the institutional status string in undefined, the domain
1.1075.2.41  raeburn  9676:    default quota will be returned.
                   9677: 3.  quota name - portfolio, author, or course
                   9678:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  9679: 
                   9680: Returns:
1.1075.2.42  raeburn  9681: 
1.1075.2.58  raeburn  9682: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  9683: 2. (Optional) institutional type which determined the value of the
                   9684:    default quota.
1.472     raeburn  9685: 
                   9686: If a value has been stored in the domain's configuration db,
                   9687: it will return that, otherwise it returns 20 (for backwards 
                   9688: compatibility with domains which have not set up a configuration
1.1075.2.58  raeburn  9689: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  9690: 
1.536     raeburn  9691: If the user's status includes multiple types (e.g., staff and student),
                   9692: the largest default quota which applies to the user determines the
                   9693: default quota returned.
                   9694: 
1.472     raeburn  9695: =cut
                   9696: 
                   9697: ###############################################
                   9698: 
                   9699: 
                   9700: sub default_quota {
1.1075.2.41  raeburn  9701:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  9702:     my ($defquota,$settingstatus);
                   9703:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  9704:                                             ['quotas'],$udom);
1.1075.2.41  raeburn  9705:     my $key = 'defaultquota';
                   9706:     if ($quotaname eq 'author') {
                   9707:         $key = 'authorquota';
                   9708:     }
1.622     raeburn  9709:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  9710:         if ($inststatus ne '') {
1.765     raeburn  9711:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  9712:             foreach my $item (@statuses) {
1.1075.2.41  raeburn  9713:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9714:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  9715:                         if ($defquota eq '') {
1.1075.2.41  raeburn  9716:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9717:                             $settingstatus = $item;
1.1075.2.41  raeburn  9718:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   9719:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9720:                             $settingstatus = $item;
                   9721:                         }
                   9722:                     }
1.1075.2.41  raeburn  9723:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  9724:                     if ($quotahash{'quotas'}{$item} ne '') {
                   9725:                         if ($defquota eq '') {
                   9726:                             $defquota = $quotahash{'quotas'}{$item};
                   9727:                             $settingstatus = $item;
                   9728:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   9729:                             $defquota = $quotahash{'quotas'}{$item};
                   9730:                             $settingstatus = $item;
                   9731:                         }
1.536     raeburn  9732:                     }
                   9733:                 }
                   9734:             }
                   9735:         }
                   9736:         if ($defquota eq '') {
1.1075.2.41  raeburn  9737:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9738:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   9739:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  9740:                 $defquota = $quotahash{'quotas'}{'default'};
                   9741:             }
1.536     raeburn  9742:             $settingstatus = 'default';
1.1075.2.42  raeburn  9743:             if ($defquota eq '') {
                   9744:                 if ($quotaname eq 'author') {
                   9745:                     $defquota = 500;
                   9746:                 }
                   9747:             }
1.536     raeburn  9748:         }
                   9749:     } else {
                   9750:         $settingstatus = 'default';
1.1075.2.41  raeburn  9751:         if ($quotaname eq 'author') {
                   9752:             $defquota = 500;
                   9753:         } else {
                   9754:             $defquota = 20;
                   9755:         }
1.536     raeburn  9756:     }
                   9757:     if (wantarray) {
                   9758:         return ($defquota,$settingstatus);
1.472     raeburn  9759:     } else {
1.536     raeburn  9760:         return $defquota;
1.472     raeburn  9761:     }
                   9762: }
                   9763: 
1.1075.2.41  raeburn  9764: ###############################################
                   9765: 
                   9766: =pod
                   9767: 
1.1075.2.42  raeburn  9768: =item * &excess_filesize_warning()
1.1075.2.41  raeburn  9769: 
                   9770: Returns warning message if upload of file to authoring space, or copying
1.1075.2.42  raeburn  9771: of existing file within authoring space will cause quota for the authoring
                   9772: space to be exceeded.
                   9773: 
                   9774: Same, if upload of a file directly to a course/community via Course Editor
                   9775: will cause quota for uploaded content for the course to be exceeded.
1.1075.2.41  raeburn  9776: 
1.1075.2.61  raeburn  9777: Inputs: 7 
1.1075.2.42  raeburn  9778: 1. username or coursenum
1.1075.2.41  raeburn  9779: 2. domain
1.1075.2.42  raeburn  9780: 3. context ('author' or 'course')
1.1075.2.41  raeburn  9781: 4. filename of file for which action is being requested
                   9782: 5. filesize (kB) of file
                   9783: 6. action being taken: copy or upload.
1.1075.2.59  raeburn  9784: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1075.2.41  raeburn  9785: 
                   9786: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
                   9787:          otherwise return null.
                   9788: 
1.1075.2.42  raeburn  9789: =back
                   9790: 
1.1075.2.41  raeburn  9791: =cut
                   9792: 
1.1075.2.42  raeburn  9793: sub excess_filesize_warning {
1.1075.2.59  raeburn  9794:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1075.2.42  raeburn  9795:     my $current_disk_usage = 0;
1.1075.2.59  raeburn  9796:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1075.2.42  raeburn  9797:     if ($context eq 'author') {
                   9798:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   9799:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   9800:     } else {
                   9801:         foreach my $subdir ('docs','supplemental') {
                   9802:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   9803:         }
                   9804:     }
1.1075.2.41  raeburn  9805:     $disk_quota = int($disk_quota * 1000);
                   9806:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1075.2.69  raeburn  9807:         return '<p class="LC_warning">'.
1.1075.2.41  raeburn  9808:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1075.2.69  raeburn  9809:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   9810:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1075.2.41  raeburn  9811:                             $disk_quota,$current_disk_usage).
                   9812:                '</p>';
                   9813:     }
                   9814:     return;
                   9815: }
                   9816: 
                   9817: ###############################################
                   9818: 
                   9819: 
1.384     raeburn  9820: sub get_secgrprole_info {
                   9821:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   9822:     my %sections_count = &get_sections($cdom,$cnum);
                   9823:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   9824:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   9825:     my @groups = sort(keys(%curr_groups));
                   9826:     my $allroles = [];
                   9827:     my $rolehash;
                   9828:     my $accesshash = {
                   9829:                      active => 'Currently has access',
                   9830:                      future => 'Will have future access',
                   9831:                      previous => 'Previously had access',
                   9832:                   };
                   9833:     if ($needroles) {
                   9834:         $rolehash = {'all' => 'all'};
1.385     albertel 9835:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9836: 	if (&Apache::lonnet::error(%user_roles)) {
                   9837: 	    undef(%user_roles);
                   9838: 	}
                   9839:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  9840:             my ($role)=split(/\:/,$item,2);
                   9841:             if ($role eq 'cr') { next; }
                   9842:             if ($role =~ /^cr/) {
                   9843:                 $$rolehash{$role} = (split('/',$role))[3];
                   9844:             } else {
                   9845:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   9846:             }
                   9847:         }
                   9848:         foreach my $key (sort(keys(%{$rolehash}))) {
                   9849:             push(@{$allroles},$key);
                   9850:         }
                   9851:         push (@{$allroles},'st');
                   9852:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   9853:     }
                   9854:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   9855: }
                   9856: 
1.555     raeburn  9857: sub user_picker {
1.1075.2.127  raeburn  9858:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  9859:     my $currdom = $dom;
1.1075.2.114  raeburn  9860:     my @alldoms = &Apache::lonnet::all_domains();
                   9861:     if (@alldoms == 1) {
                   9862:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   9863:                                                ['directorysrch'],$alldoms[0]);
                   9864:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   9865:         my $showdom = $domdesc;
                   9866:         if ($showdom eq '') {
                   9867:             $showdom = $dom;
                   9868:         }
                   9869:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   9870:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   9871:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   9872:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   9873:             }
                   9874:         }
                   9875:     }
1.555     raeburn  9876:     my %curr_selected = (
                   9877:                         srchin => 'dom',
1.580     raeburn  9878:                         srchby => 'lastname',
1.555     raeburn  9879:                       );
                   9880:     my $srchterm;
1.625     raeburn  9881:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  9882:         if ($srch->{'srchby'} ne '') {
                   9883:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   9884:         }
                   9885:         if ($srch->{'srchin'} ne '') {
                   9886:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   9887:         }
                   9888:         if ($srch->{'srchtype'} ne '') {
                   9889:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   9890:         }
                   9891:         if ($srch->{'srchdomain'} ne '') {
                   9892:             $currdom = $srch->{'srchdomain'};
                   9893:         }
                   9894:         $srchterm = $srch->{'srchterm'};
                   9895:     }
1.1075.2.98  raeburn  9896:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  9897:                     'usr'       => 'Search criteria',
1.563     raeburn  9898:                     'doma'      => 'Domain/institution to search',
1.558     albertel 9899:                     'uname'     => 'username',
                   9900:                     'lastname'  => 'last name',
1.555     raeburn  9901:                     'lastfirst' => 'last name, first name',
1.558     albertel 9902:                     'crs'       => 'in this course',
1.576     raeburn  9903:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 9904:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  9905:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 9906:                     'exact'     => 'is',
                   9907:                     'contains'  => 'contains',
1.569     raeburn  9908:                     'begins'    => 'begins with',
1.1075.2.98  raeburn  9909:                                        );
                   9910:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  9911:                     'youm'      => "You must include some text to search for.",
                   9912:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   9913:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   9914:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   9915:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   9916:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   9917:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   9918:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  9919:                                        );
1.1075.2.98  raeburn  9920:     &html_escape(\%html_lt);
                   9921:     &js_escape(\%js_lt);
1.1075.2.115  raeburn  9922:     my $domform;
1.1075.2.126  raeburn  9923:     my $allow_blank = 1;
1.1075.2.115  raeburn  9924:     if ($fixeddom) {
1.1075.2.126  raeburn  9925:         $allow_blank = 0;
                   9926:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1075.2.115  raeburn  9927:     } else {
1.1075.2.126  raeburn  9928:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1);
1.1075.2.115  raeburn  9929:     }
1.563     raeburn  9930:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  9931: 
                   9932:     my @srchins = ('crs','dom','alc','instd');
                   9933: 
                   9934:     foreach my $option (@srchins) {
                   9935:         # FIXME 'alc' option unavailable until 
                   9936:         #       loncreateuser::print_user_query_page()
                   9937:         #       has been completed.
                   9938:         next if ($option eq 'alc');
1.880     raeburn  9939:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  9940:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1075.2.127  raeburn  9941:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  9942:         if ($curr_selected{'srchin'} eq $option) {
                   9943:             $srchinsel .= ' 
1.1075.2.98  raeburn  9944:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  9945:         } else {
                   9946:             $srchinsel .= '
1.1075.2.98  raeburn  9947:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  9948:         }
1.555     raeburn  9949:     }
1.563     raeburn  9950:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  9951: 
                   9952:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  9953:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  9954:         if ($curr_selected{'srchby'} eq $option) {
                   9955:             $srchbysel .= '
1.1075.2.98  raeburn  9956:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  9957:         } else {
                   9958:             $srchbysel .= '
1.1075.2.98  raeburn  9959:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  9960:          }
                   9961:     }
                   9962:     $srchbysel .= "\n  </select>\n";
                   9963: 
                   9964:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  9965:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  9966:         if ($curr_selected{'srchtype'} eq $option) {
                   9967:             $srchtypesel .= '
1.1075.2.98  raeburn  9968:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  9969:         } else {
                   9970:             $srchtypesel .= '
1.1075.2.98  raeburn  9971:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  9972:         }
                   9973:     }
                   9974:     $srchtypesel .= "\n  </select>\n";
                   9975: 
1.558     albertel 9976:     my ($newuserscript,$new_user_create);
1.994     raeburn  9977:     my $context_dom = $env{'request.role.domain'};
                   9978:     if ($context eq 'requestcrs') {
                   9979:         if ($env{'form.coursedom'} ne '') { 
                   9980:             $context_dom = $env{'form.coursedom'};
                   9981:         }
                   9982:     }
1.556     raeburn  9983:     if ($forcenewuser) {
1.576     raeburn  9984:         if (ref($srch) eq 'HASH') {
1.994     raeburn  9985:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  9986:                 if ($cancreate) {
                   9987:                     $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>';
                   9988:                 } else {
1.799     bisitz   9989:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  9990:                     my %usertypetext = (
                   9991:                         official   => 'institutional',
                   9992:                         unofficial => 'non-institutional',
                   9993:                     );
1.799     bisitz   9994:                     $new_user_create = '<p class="LC_warning">'
                   9995:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   9996:                                       .' '
                   9997:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   9998:                                           ,'<a href="'.$helplink.'">','</a>')
                   9999:                                       .'</p><br />';
1.627     raeburn  10000:                 }
1.576     raeburn  10001:             }
                   10002:         }
                   10003: 
1.556     raeburn  10004:         $newuserscript = <<"ENDSCRIPT";
                   10005: 
1.570     raeburn  10006: function setSearch(createnew,callingForm) {
1.556     raeburn  10007:     if (createnew == 1) {
1.570     raeburn  10008:         for (var i=0; i<callingForm.srchby.length; i++) {
                   10009:             if (callingForm.srchby.options[i].value == 'uname') {
                   10010:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  10011:             }
                   10012:         }
1.570     raeburn  10013:         for (var i=0; i<callingForm.srchin.length; i++) {
                   10014:             if ( callingForm.srchin.options[i].value == 'dom') {
                   10015: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  10016:             }
                   10017:         }
1.570     raeburn  10018:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   10019:             if (callingForm.srchtype.options[i].value == 'exact') {
                   10020:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  10021:             }
                   10022:         }
1.570     raeburn  10023:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  10024:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  10025:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  10026:             }
                   10027:         }
                   10028:     }
                   10029: }
                   10030: ENDSCRIPT
1.558     albertel 10031: 
1.556     raeburn  10032:     }
                   10033: 
1.555     raeburn  10034:     my $output = <<"END_BLOCK";
1.556     raeburn  10035: <script type="text/javascript">
1.824     bisitz   10036: // <![CDATA[
1.570     raeburn  10037: function validateEntry(callingForm) {
1.558     albertel 10038: 
1.556     raeburn  10039:     var checkok = 1;
1.558     albertel 10040:     var srchin;
1.570     raeburn  10041:     for (var i=0; i<callingForm.srchin.length; i++) {
                   10042: 	if ( callingForm.srchin[i].checked ) {
                   10043: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 10044: 	}
                   10045:     }
                   10046: 
1.570     raeburn  10047:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   10048:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   10049:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   10050:     var srchterm =  callingForm.srchterm.value;
                   10051:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  10052:     var msg = "";
                   10053: 
                   10054:     if (srchterm == "") {
                   10055:         checkok = 0;
1.1075.2.98  raeburn  10056:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  10057:     }
                   10058: 
1.569     raeburn  10059:     if (srchtype== 'begins') {
                   10060:         if (srchterm.length < 2) {
                   10061:             checkok = 0;
1.1075.2.98  raeburn  10062:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  10063:         }
                   10064:     }
                   10065: 
1.556     raeburn  10066:     if (srchtype== 'contains') {
                   10067:         if (srchterm.length < 3) {
                   10068:             checkok = 0;
1.1075.2.98  raeburn  10069:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  10070:         }
                   10071:     }
                   10072:     if (srchin == 'instd') {
                   10073:         if (srchdomain == '') {
                   10074:             checkok = 0;
1.1075.2.98  raeburn  10075:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  10076:         }
                   10077:     }
                   10078:     if (srchin == 'dom') {
                   10079:         if (srchdomain == '') {
                   10080:             checkok = 0;
1.1075.2.98  raeburn  10081:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  10082:         }
                   10083:     }
                   10084:     if (srchby == 'lastfirst') {
                   10085:         if (srchterm.indexOf(",") == -1) {
                   10086:             checkok = 0;
1.1075.2.98  raeburn  10087:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  10088:         }
                   10089:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   10090:             checkok = 0;
1.1075.2.98  raeburn  10091:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  10092:         }
                   10093:     }
                   10094:     if (checkok == 0) {
1.1075.2.98  raeburn  10095:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  10096:         return;
                   10097:     }
                   10098:     if (checkok == 1) {
1.570     raeburn  10099:         callingForm.submit();
1.556     raeburn  10100:     }
                   10101: }
                   10102: 
                   10103: $newuserscript
                   10104: 
1.824     bisitz   10105: // ]]>
1.556     raeburn  10106: </script>
1.558     albertel 10107: 
                   10108: $new_user_create
                   10109: 
1.555     raeburn  10110: END_BLOCK
1.558     albertel 10111: 
1.876     raeburn  10112:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1075.2.98  raeburn  10113:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  10114:                $domform.
                   10115:                &Apache::lonhtmlcommon::row_closure().
1.1075.2.98  raeburn  10116:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  10117:                $srchbysel.
                   10118:                $srchtypesel. 
                   10119:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   10120:                $srchinsel.
                   10121:                &Apache::lonhtmlcommon::row_closure(1). 
                   10122:                &Apache::lonhtmlcommon::end_pick_box().
                   10123:                '<br />';
1.1075.2.114  raeburn  10124:     return ($output,1);
1.555     raeburn  10125: }
                   10126: 
1.612     raeburn  10127: sub user_rule_check {
1.615     raeburn  10128:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1075.2.99  raeburn  10129:     my ($response,%inst_response);
1.612     raeburn  10130:     if (ref($usershash) eq 'HASH') {
1.1075.2.99  raeburn  10131:         if (keys(%{$usershash}) > 1) {
                   10132:             my (%by_username,%by_id,%userdoms);
                   10133:             my $checkid;
1.612     raeburn  10134:             if (ref($checks) eq 'HASH') {
1.1075.2.99  raeburn  10135:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   10136:                     $checkid = 1;
                   10137:                 }
                   10138:             }
                   10139:             foreach my $user (keys(%{$usershash})) {
                   10140:                 my ($uname,$udom) = split(/:/,$user);
                   10141:                 if ($checkid) {
                   10142:                     if (ref($usershash->{$user}) eq 'HASH') {
                   10143:                         if ($usershash->{$user}->{'id'} ne '') {
                   10144:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
                   10145:                             $userdoms{$udom} = 1;
                   10146:                             if (ref($inst_results) eq 'HASH') {
                   10147:                                 $inst_results->{$uname.':'.$udom} = {};
                   10148:                             }
                   10149:                         }
                   10150:                     }
                   10151:                 } else {
                   10152:                     $by_username{$udom}{$uname} = 1;
                   10153:                     $userdoms{$udom} = 1;
                   10154:                     if (ref($inst_results) eq 'HASH') {
                   10155:                         $inst_results->{$uname.':'.$udom} = {};
                   10156:                     }
                   10157:                 }
                   10158:             }
                   10159:             foreach my $udom (keys(%userdoms)) {
                   10160:                 if (!$got_rules->{$udom}) {
                   10161:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10162:                                                              ['usercreation'],$udom);
                   10163:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10164:                         foreach my $item ('username','id') {
                   10165:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10166:                                 $$curr_rules{$udom}{$item} =
                   10167:                                     $domconfig{'usercreation'}{$item.'_rule'};
                   10168:                             }
                   10169:                         }
                   10170:                     }
                   10171:                     $got_rules->{$udom} = 1;
                   10172:                 }
                   10173:             }
                   10174:             if ($checkid) {
                   10175:                 foreach my $udom (keys(%by_id)) {
                   10176:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   10177:                     if ($outcome eq 'ok') {
                   10178:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   10179:                             my $uname = $by_id{$udom}{$id};
                   10180:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10181:                         }
                   10182:                         if (ref($results) eq 'HASH') {
                   10183:                             foreach my $uname (keys(%{$results})) {
                   10184:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   10185:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   10186:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10187:                                 }
                   10188:                             }
                   10189:                         }
                   10190:                     }
1.612     raeburn  10191:                 }
1.615     raeburn  10192:             } else {
1.1075.2.99  raeburn  10193:                 foreach my $udom (keys(%by_username)) {
                   10194:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   10195:                     if ($outcome eq 'ok') {
                   10196:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   10197:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10198:                         }
                   10199:                         if (ref($results) eq 'HASH') {
                   10200:                             foreach my $uname (keys(%{$results})) {
                   10201:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10202:                             }
                   10203:                         }
                   10204:                     }
                   10205:                 }
1.612     raeburn  10206:             }
1.1075.2.99  raeburn  10207:         } elsif (keys(%{$usershash}) == 1) {
                   10208:             my $user = (keys(%{$usershash}))[0];
                   10209:             my ($uname,$udom) = split(/:/,$user);
                   10210:             if (($udom ne '') && ($uname ne '')) {
                   10211:                 if (ref($usershash->{$user}) eq 'HASH') {
                   10212:                     if (ref($checks) eq 'HASH') {
                   10213:                         if (defined($checks->{'username'})) {
                   10214:                             ($inst_response{$user},%{$inst_results->{$user}}) =
                   10215:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   10216:                         } elsif (defined($checks->{'id'})) {
                   10217:                             if ($usershash->{$user}->{'id'} ne '') {
                   10218:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10219:                                     &Apache::lonnet::get_instuser($udom,undef,
                   10220:                                                                   $usershash->{$user}->{'id'});
                   10221:                             } else {
                   10222:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10223:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   10224:                             }
                   10225:                         }
                   10226:                     } else {
                   10227:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   10228:                             &Apache::lonnet::get_instuser($udom,$uname);
                   10229:                        return;
                   10230:                     }
                   10231:                     if (!$got_rules->{$udom}) {
                   10232:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10233:                                                                  ['usercreation'],$udom);
                   10234:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10235:                             foreach my $item ('username','id') {
                   10236:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10237:                                    $$curr_rules{$udom}{$item} =
                   10238:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   10239:                                 }
                   10240:                             }
1.585     raeburn  10241:                         }
1.1075.2.99  raeburn  10242:                         $got_rules->{$udom} = 1;
1.585     raeburn  10243:                     }
                   10244:                 }
1.1075.2.99  raeburn  10245:             } else {
                   10246:                 return;
                   10247:             }
                   10248:         } else {
                   10249:             return;
                   10250:         }
                   10251:         foreach my $user (keys(%{$usershash})) {
                   10252:             my ($uname,$udom) = split(/:/,$user);
                   10253:             next if (($udom eq '') || ($uname eq ''));
                   10254:             my $id;
                   10255:             if (ref($inst_results) eq 'HASH') {
                   10256:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   10257:                     $id = $inst_results->{$user}->{'id'};
                   10258:                 }
                   10259:             }
                   10260:             if ($id eq '') {
                   10261:                 if (ref($usershash->{$user})) {
                   10262:                     $id = $usershash->{$user}->{'id'};
                   10263:                 }
1.585     raeburn  10264:             }
1.612     raeburn  10265:             foreach my $item (keys(%{$checks})) {
                   10266:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   10267:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   10268:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1075.2.99  raeburn  10269:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   10270:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  10271:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   10272:                                 if ($rule_check{$rule}) {
                   10273:                                     $$rulematch{$user}{$item} = $rule;
1.1075.2.99  raeburn  10274:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  10275:                                         if (ref($inst_results) eq 'HASH') {
                   10276:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   10277:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   10278:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1075.2.99  raeburn  10279:                                                 } elsif ($item eq 'id') {
                   10280:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   10281:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   10282:                                                     }
1.615     raeburn  10283:                                                 }
1.612     raeburn  10284:                                             }
                   10285:                                         }
1.615     raeburn  10286:                                     }
                   10287:                                     last;
1.585     raeburn  10288:                                 }
                   10289:                             }
                   10290:                         }
                   10291:                     }
                   10292:                 }
                   10293:             }
                   10294:         }
                   10295:     }
1.612     raeburn  10296:     return;
                   10297: }
                   10298: 
                   10299: sub user_rule_formats {
                   10300:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   10301:     my %text = ( 
                   10302:                  'username' => 'Usernames',
                   10303:                  'id'       => 'IDs',
                   10304:                );
                   10305:     my $output;
                   10306:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   10307:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   10308:         if (@{$ruleorder} > 0) {
1.1075.2.20  raeburn  10309:             $output = '<br />'.
                   10310:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   10311:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   10312:                       ' <ul>';
1.612     raeburn  10313:             foreach my $rule (@{$ruleorder}) {
                   10314:                 if (ref($curr_rules) eq 'ARRAY') {
                   10315:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   10316:                         if (ref($rules->{$rule}) eq 'HASH') {
                   10317:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   10318:                                         $rules->{$rule}{'desc'}.'</li>';
                   10319:                         }
                   10320:                     }
                   10321:                 }
                   10322:             }
                   10323:             $output .= '</ul>';
                   10324:         }
                   10325:     }
                   10326:     return $output;
                   10327: }
                   10328: 
                   10329: sub instrule_disallow_msg {
1.615     raeburn  10330:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  10331:     my $response;
                   10332:     my %text = (
                   10333:                   item   => 'username',
                   10334:                   items  => 'usernames',
                   10335:                   match  => 'matches',
                   10336:                   do     => 'does',
                   10337:                   action => 'a username',
                   10338:                   one    => 'one',
                   10339:                );
                   10340:     if ($count > 1) {
                   10341:         $text{'item'} = 'usernames';
                   10342:         $text{'match'} ='match';
                   10343:         $text{'do'} = 'do';
                   10344:         $text{'action'} = 'usernames',
                   10345:         $text{'one'} = 'ones';
                   10346:     }
                   10347:     if ($checkitem eq 'id') {
                   10348:         $text{'items'} = 'IDs';
                   10349:         $text{'item'} = 'ID';
                   10350:         $text{'action'} = 'an ID';
1.615     raeburn  10351:         if ($count > 1) {
                   10352:             $text{'item'} = 'IDs';
                   10353:             $text{'action'} = 'IDs';
                   10354:         }
1.612     raeburn  10355:     }
1.674     bisitz   10356:     $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  10357:     if ($mode eq 'upload') {
                   10358:         if ($checkitem eq 'username') {
                   10359:             $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'}.");
                   10360:         } elsif ($checkitem eq 'id') {
1.674     bisitz   10361:             $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  10362:         }
1.669     raeburn  10363:     } elsif ($mode eq 'selfcreate') {
                   10364:         if ($checkitem eq 'id') {
                   10365:             $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.");
                   10366:         }
1.615     raeburn  10367:     } else {
                   10368:         if ($checkitem eq 'username') {
                   10369:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   10370:         } elsif ($checkitem eq 'id') {
                   10371:             $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.");
                   10372:         }
1.612     raeburn  10373:     }
                   10374:     return $response;
1.585     raeburn  10375: }
                   10376: 
1.624     raeburn  10377: sub personal_data_fieldtitles {
                   10378:     my %fieldtitles = &Apache::lonlocal::texthash (
                   10379:                         id => 'Student/Employee ID',
                   10380:                         permanentemail => 'E-mail address',
                   10381:                         lastname => 'Last Name',
                   10382:                         firstname => 'First Name',
                   10383:                         middlename => 'Middle Name',
                   10384:                         generation => 'Generation',
                   10385:                         gen => 'Generation',
1.765     raeburn  10386:                         inststatus => 'Affiliation',
1.624     raeburn  10387:                    );
                   10388:     return %fieldtitles;
                   10389: }
                   10390: 
1.642     raeburn  10391: sub sorted_inst_types {
                   10392:     my ($dom) = @_;
1.1075.2.70  raeburn  10393:     my ($usertypes,$order);
                   10394:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   10395:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   10396:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   10397:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   10398:     } else {
                   10399:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   10400:     }
1.642     raeburn  10401:     my $othertitle = &mt('All users');
                   10402:     if ($env{'request.course.id'}) {
1.668     raeburn  10403:         $othertitle  = &mt('Any users');
1.642     raeburn  10404:     }
                   10405:     my @types;
                   10406:     if (ref($order) eq 'ARRAY') {
                   10407:         @types = @{$order};
                   10408:     }
                   10409:     if (@types == 0) {
                   10410:         if (ref($usertypes) eq 'HASH') {
                   10411:             @types = sort(keys(%{$usertypes}));
                   10412:         }
                   10413:     }
                   10414:     if (keys(%{$usertypes}) > 0) {
                   10415:         $othertitle = &mt('Other users');
                   10416:     }
                   10417:     return ($othertitle,$usertypes,\@types);
                   10418: }
                   10419: 
1.645     raeburn  10420: sub get_institutional_codes {
                   10421:     my ($settings,$allcourses,$LC_code) = @_;
                   10422: # Get complete list of course sections to update
                   10423:     my @currsections = ();
                   10424:     my @currxlists = ();
                   10425:     my $coursecode = $$settings{'internal.coursecode'};
                   10426: 
                   10427:     if ($$settings{'internal.sectionnums'} ne '') {
                   10428:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   10429:     }
                   10430: 
                   10431:     if ($$settings{'internal.crosslistings'} ne '') {
                   10432:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   10433:     }
                   10434: 
                   10435:     if (@currxlists > 0) {
                   10436:         foreach (@currxlists) {
                   10437:             if (m/^([^:]+):(\w*)$/) {
                   10438:                 unless (grep/^$1$/,@{$allcourses}) {
1.1075.2.119  raeburn  10439:                     push(@{$allcourses},$1);
1.645     raeburn  10440:                     $$LC_code{$1} = $2;
                   10441:                 }
                   10442:             }
                   10443:         }
                   10444:     }
                   10445:  
                   10446:     if (@currsections > 0) {
                   10447:         foreach (@currsections) {
                   10448:             if (m/^(\w+):(\w*)$/) {
                   10449:                 my $sec = $coursecode.$1;
                   10450:                 my $lc_sec = $2;
                   10451:                 unless (grep/^$sec$/,@{$allcourses}) {
1.1075.2.119  raeburn  10452:                     push(@{$allcourses},$sec);
1.645     raeburn  10453:                     $$LC_code{$sec} = $lc_sec;
                   10454:                 }
                   10455:             }
                   10456:         }
                   10457:     }
                   10458:     return;
                   10459: }
                   10460: 
1.971     raeburn  10461: sub get_standard_codeitems {
                   10462:     return ('Year','Semester','Department','Number','Section');
                   10463: }
                   10464: 
1.112     bowersj2 10465: =pod
                   10466: 
1.780     raeburn  10467: =head1 Slot Helpers
                   10468: 
                   10469: =over 4
                   10470: 
                   10471: =item * sorted_slots()
                   10472: 
1.1040    raeburn  10473: Sorts an array of slot names in order of an optional sort key,
                   10474: default sort is by slot start time (earliest first). 
1.780     raeburn  10475: 
                   10476: Inputs:
                   10477: 
                   10478: =over 4
                   10479: 
                   10480: slotsarr  - Reference to array of unsorted slot names.
                   10481: 
                   10482: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   10483: 
1.1040    raeburn  10484: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   10485: 
1.549     albertel 10486: =back
                   10487: 
1.780     raeburn  10488: Returns:
                   10489: 
                   10490: =over 4
                   10491: 
1.1040    raeburn  10492: sorted   - An array of slot names sorted by a specified sort key 
                   10493:            (default sort key is start time of the slot).
1.780     raeburn  10494: 
                   10495: =back
                   10496: 
                   10497: =cut
                   10498: 
                   10499: 
                   10500: sub sorted_slots {
1.1040    raeburn  10501:     my ($slotsarr,$slots,$sortkey) = @_;
                   10502:     if ($sortkey eq '') {
                   10503:         $sortkey = 'starttime';
                   10504:     }
1.780     raeburn  10505:     my @sorted;
                   10506:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   10507:         @sorted =
                   10508:             sort {
                   10509:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  10510:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  10511:                      }
                   10512:                      if (ref($slots->{$a})) { return -1;}
                   10513:                      if (ref($slots->{$b})) { return 1;}
                   10514:                      return 0;
                   10515:                  } @{$slotsarr};
                   10516:     }
                   10517:     return @sorted;
                   10518: }
                   10519: 
1.1040    raeburn  10520: =pod
                   10521: 
                   10522: =item * get_future_slots()
                   10523: 
                   10524: Inputs:
                   10525: 
                   10526: =over 4
                   10527: 
                   10528: cnum - course number
                   10529: 
                   10530: cdom - course domain
                   10531: 
                   10532: now - current UNIX time
                   10533: 
                   10534: symb - optional symb
                   10535: 
                   10536: =back
                   10537: 
                   10538: Returns:
                   10539: 
                   10540: =over 4
                   10541: 
                   10542: sorted_reservable - ref to array of student_schedulable slots currently 
                   10543:                     reservable, ordered by end date of reservation period.
                   10544: 
                   10545: reservable_now - ref to hash of student_schedulable slots currently
                   10546:                  reservable.
                   10547: 
                   10548:     Keys in inner hash are:
                   10549:     (a) symb: either blank or symb to which slot use is restricted.
1.1075.2.104  raeburn  10550:     (b) endreserve: end date of reservation period.
                   10551:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10552:         selected.
1.1040    raeburn  10553: 
                   10554: sorted_future - ref to array of student_schedulable slots reservable in
                   10555:                 the future, ordered by start date of reservation period.
                   10556: 
                   10557: future_reservable - ref to hash of student_schedulable slots reservable
                   10558:                     in the future.
                   10559: 
                   10560:     Keys in inner hash are:
                   10561:     (a) symb: either blank or symb to which slot use is restricted.
                   10562:     (b) startreserve:  start date of reservation period.
1.1075.2.104  raeburn  10563:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10564:         selected.
1.1040    raeburn  10565: 
                   10566: =back
                   10567: 
                   10568: =cut
                   10569: 
                   10570: sub get_future_slots {
                   10571:     my ($cnum,$cdom,$now,$symb) = @_;
                   10572:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   10573:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   10574:     foreach my $slot (keys(%slots)) {
                   10575:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   10576:         if ($symb) {
                   10577:             next if (($slots{$slot}->{'symb'} ne '') && 
                   10578:                      ($slots{$slot}->{'symb'} ne $symb));
                   10579:         }
                   10580:         if (($slots{$slot}->{'starttime'} > $now) &&
                   10581:             ($slots{$slot}->{'endtime'} > $now)) {
                   10582:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   10583:                 my $userallowed = 0;
                   10584:                 if ($slots{$slot}->{'allowedsections'}) {
                   10585:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   10586:                     if (!defined($env{'request.role.sec'})
                   10587:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   10588:                         $userallowed=1;
                   10589:                     } else {
                   10590:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   10591:                             $userallowed=1;
                   10592:                         }
                   10593:                     }
                   10594:                     unless ($userallowed) {
                   10595:                         if (defined($env{'request.course.groups'})) {
                   10596:                             my @groups = split(/:/,$env{'request.course.groups'});
                   10597:                             foreach my $group (@groups) {
                   10598:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   10599:                                     $userallowed=1;
                   10600:                                     last;
                   10601:                                 }
                   10602:                             }
                   10603:                         }
                   10604:                     }
                   10605:                 }
                   10606:                 if ($slots{$slot}->{'allowedusers'}) {
                   10607:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   10608:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   10609:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   10610:                         $userallowed = 1;
                   10611:                     }
                   10612:                 }
                   10613:                 next unless($userallowed);
                   10614:             }
                   10615:             my $startreserve = $slots{$slot}->{'startreserve'};
                   10616:             my $endreserve = $slots{$slot}->{'endreserve'};
                   10617:             my $symb = $slots{$slot}->{'symb'};
1.1075.2.104  raeburn  10618:             my $uniqueperiod;
                   10619:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   10620:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   10621:             }
1.1040    raeburn  10622:             if (($startreserve < $now) &&
                   10623:                 (!$endreserve || $endreserve > $now)) {
                   10624:                 my $lastres = $endreserve;
                   10625:                 if (!$lastres) {
                   10626:                     $lastres = $slots{$slot}->{'starttime'};
                   10627:                 }
                   10628:                 $reservable_now{$slot} = {
                   10629:                                            symb       => $symb,
1.1075.2.104  raeburn  10630:                                            endreserve => $lastres,
                   10631:                                            uniqueperiod => $uniqueperiod,   
1.1040    raeburn  10632:                                          };
                   10633:             } elsif (($startreserve > $now) &&
                   10634:                      (!$endreserve || $endreserve > $startreserve)) {
                   10635:                 $future_reservable{$slot} = {
                   10636:                                               symb         => $symb,
1.1075.2.104  raeburn  10637:                                               startreserve => $startreserve,
                   10638:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  10639:                                             };
                   10640:             }
                   10641:         }
                   10642:     }
                   10643:     my @unsorted_reservable = keys(%reservable_now);
                   10644:     if (@unsorted_reservable > 0) {
                   10645:         @sorted_reservable = 
                   10646:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   10647:     }
                   10648:     my @unsorted_future = keys(%future_reservable);
                   10649:     if (@unsorted_future > 0) {
                   10650:         @sorted_future =
                   10651:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   10652:     }
                   10653:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   10654: }
1.780     raeburn  10655: 
                   10656: =pod
                   10657: 
1.1057    foxr     10658: =back
                   10659: 
1.549     albertel 10660: =head1 HTTP Helpers
                   10661: 
                   10662: =over 4
                   10663: 
1.648     raeburn  10664: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 10665: 
1.258     albertel 10666: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 10667: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 10668: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 10669: 
                   10670: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   10671: $possible_names is an ref to an array of form element names.  As an example:
                   10672: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 10673: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 10674: 
                   10675: =cut
1.1       albertel 10676: 
1.6       albertel 10677: sub get_unprocessed_cgi {
1.25      albertel 10678:   my ($query,$possible_names)= @_;
1.26      matthew  10679:   # $Apache::lonxml::debug=1;
1.356     albertel 10680:   foreach my $pair (split(/&/,$query)) {
                   10681:     my ($name, $value) = split(/=/,$pair);
1.369     www      10682:     $name = &unescape($name);
1.25      albertel 10683:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   10684:       $value =~ tr/+/ /;
                   10685:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 10686:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 10687:     }
1.16      harris41 10688:   }
1.6       albertel 10689: }
                   10690: 
1.112     bowersj2 10691: =pod
                   10692: 
1.648     raeburn  10693: =item * &cacheheader() 
1.112     bowersj2 10694: 
                   10695: returns cache-controlling header code
                   10696: 
                   10697: =cut
                   10698: 
1.7       albertel 10699: sub cacheheader {
1.258     albertel 10700:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 10701:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   10702:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 10703:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   10704:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 10705:     return $output;
1.7       albertel 10706: }
                   10707: 
1.112     bowersj2 10708: =pod
                   10709: 
1.648     raeburn  10710: =item * &no_cache($r) 
1.112     bowersj2 10711: 
                   10712: specifies header code to not have cache
                   10713: 
                   10714: =cut
                   10715: 
1.9       albertel 10716: sub no_cache {
1.216     albertel 10717:     my ($r) = @_;
                   10718:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 10719: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 10720:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   10721:     $r->no_cache(1);
                   10722:     $r->header_out("Expires" => $date);
                   10723:     $r->header_out("Pragma" => "no-cache");
1.123     www      10724: }
                   10725: 
                   10726: sub content_type {
1.181     albertel 10727:     my ($r,$type,$charset) = @_;
1.299     foxr     10728:     if ($r) {
                   10729: 	#  Note that printout.pl calls this with undef for $r.
                   10730: 	&no_cache($r);
                   10731:     }
1.258     albertel 10732:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 10733:     unless ($charset) {
                   10734: 	$charset=&Apache::lonlocal::current_encoding;
                   10735:     }
                   10736:     if ($charset) { $type.='; charset='.$charset; }
                   10737:     if ($r) {
                   10738: 	$r->content_type($type);
                   10739:     } else {
                   10740: 	print("Content-type: $type\n\n");
                   10741:     }
1.9       albertel 10742: }
1.25      albertel 10743: 
1.112     bowersj2 10744: =pod
                   10745: 
1.648     raeburn  10746: =item * &add_to_env($name,$value) 
1.112     bowersj2 10747: 
1.258     albertel 10748: adds $name to the %env hash with value
1.112     bowersj2 10749: $value, if $name already exists, the entry is converted to an array
                   10750: reference and $value is added to the array.
                   10751: 
                   10752: =cut
                   10753: 
1.25      albertel 10754: sub add_to_env {
                   10755:   my ($name,$value)=@_;
1.258     albertel 10756:   if (defined($env{$name})) {
                   10757:     if (ref($env{$name})) {
1.25      albertel 10758:       #already have multiple values
1.258     albertel 10759:       push(@{ $env{$name} },$value);
1.25      albertel 10760:     } else {
                   10761:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 10762:       my $first=$env{$name};
                   10763:       undef($env{$name});
                   10764:       push(@{ $env{$name} },$first,$value);
1.25      albertel 10765:     }
                   10766:   } else {
1.258     albertel 10767:     $env{$name}=$value;
1.25      albertel 10768:   }
1.31      albertel 10769: }
1.149     albertel 10770: 
                   10771: =pod
                   10772: 
1.648     raeburn  10773: =item * &get_env_multiple($name) 
1.149     albertel 10774: 
1.258     albertel 10775: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 10776: values may be defined and end up as an array ref.
                   10777: 
                   10778: returns an array of values
                   10779: 
                   10780: =cut
                   10781: 
                   10782: sub get_env_multiple {
                   10783:     my ($name) = @_;
                   10784:     my @values;
1.258     albertel 10785:     if (defined($env{$name})) {
1.149     albertel 10786:         # exists is it an array
1.258     albertel 10787:         if (ref($env{$name})) {
                   10788:             @values=@{ $env{$name} };
1.149     albertel 10789:         } else {
1.258     albertel 10790:             $values[0]=$env{$name};
1.149     albertel 10791:         }
                   10792:     }
                   10793:     return(@values);
                   10794: }
                   10795: 
1.660     raeburn  10796: sub ask_for_embedded_content {
                   10797:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  10798:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11  raeburn  10799:         %currsubfile,%unused,$rem);
1.1071    raeburn  10800:     my $counter = 0;
                   10801:     my $numnew = 0;
1.987     raeburn  10802:     my $numremref = 0;
                   10803:     my $numinvalid = 0;
                   10804:     my $numpathchg = 0;
                   10805:     my $numexisting = 0;
1.1071    raeburn  10806:     my $numunused = 0;
                   10807:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1075.2.53  raeburn  10808:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  10809:     my $heading = &mt('Upload embedded files');
                   10810:     my $buttontext = &mt('Upload');
                   10811: 
1.1075.2.11  raeburn  10812:     if ($env{'request.course.id'}) {
1.1075.2.35  raeburn  10813:         if ($actionurl eq '/adm/dependencies') {
                   10814:             $navmap = Apache::lonnavmaps::navmap->new();
                   10815:         }
                   10816:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10817:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11  raeburn  10818:     }
1.1075.2.35  raeburn  10819:     if (($actionurl eq '/adm/portfolio') ||
                   10820:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  10821:         my $current_path='/';
                   10822:         if ($env{'form.currentpath'}) {
                   10823:             $current_path = $env{'form.currentpath'};
                   10824:         }
                   10825:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35  raeburn  10826:             $udom = $cdom;
                   10827:             $uname = $cnum;
1.984     raeburn  10828:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   10829:         } else {
                   10830:             $udom = $env{'user.domain'};
                   10831:             $uname = $env{'user.name'};
                   10832:             $url = '/userfiles/portfolio';
                   10833:         }
1.987     raeburn  10834:         $toplevel = $url.'/';
1.984     raeburn  10835:         $url .= $current_path;
                   10836:         $getpropath = 1;
1.987     raeburn  10837:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   10838:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      10839:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  10840:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  10841:         $toplevel = $url;
1.984     raeburn  10842:         if ($rest ne '') {
1.987     raeburn  10843:             $url .= $rest;
                   10844:         }
                   10845:     } elsif ($actionurl eq '/adm/coursedocs') {
                   10846:         if (ref($args) eq 'HASH') {
1.1071    raeburn  10847:             $url = $args->{'docs_url'};
                   10848:             $toplevel = $url;
1.1075.2.11  raeburn  10849:             if ($args->{'context'} eq 'paste') {
                   10850:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   10851:                 ($path) =
                   10852:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   10853:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   10854:                 $fileloc =~ s{^/}{};
                   10855:             }
1.1071    raeburn  10856:         }
                   10857:     } elsif ($actionurl eq '/adm/dependencies') {
                   10858:         if ($env{'request.course.id'} ne '') {
                   10859:             if (ref($args) eq 'HASH') {
                   10860:                 $url = $args->{'docs_url'};
                   10861:                 $title = $args->{'docs_title'};
1.1075.2.35  raeburn  10862:                 $toplevel = $url;
                   10863:                 unless ($toplevel =~ m{^/}) {
                   10864:                     $toplevel = "/$url";
                   10865:                 }
1.1075.2.11  raeburn  10866:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35  raeburn  10867:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   10868:                     $path = $1;
                   10869:                 } else {
                   10870:                     ($path) =
                   10871:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   10872:                 }
1.1075.2.79  raeburn  10873:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   10874:                     $fileloc = $toplevel;
                   10875:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   10876:                     my ($udom,$uname,$fname) =
                   10877:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   10878:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   10879:                 } else {
                   10880:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   10881:                 }
1.1071    raeburn  10882:                 $fileloc =~ s{^/}{};
                   10883:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   10884:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   10885:             }
1.987     raeburn  10886:         }
1.1075.2.35  raeburn  10887:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   10888:         $udom = $cdom;
                   10889:         $uname = $cnum;
                   10890:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   10891:         $toplevel = $url;
                   10892:         $path = $url;
                   10893:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   10894:         $fileloc =~ s{^/}{};
                   10895:     }
                   10896:     foreach my $file (keys(%{$allfiles})) {
                   10897:         my $embed_file;
                   10898:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   10899:             $embed_file = $1;
                   10900:         } else {
                   10901:             $embed_file = $file;
                   10902:         }
1.1075.2.55  raeburn  10903:         my ($absolutepath,$cleaned_file);
                   10904:         if ($embed_file =~ m{^\w+://}) {
                   10905:             $cleaned_file = $embed_file;
1.1075.2.47  raeburn  10906:             $newfiles{$cleaned_file} = 1;
                   10907:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  10908:         } else {
1.1075.2.55  raeburn  10909:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  10910:             if ($embed_file =~ m{^/}) {
                   10911:                 $absolutepath = $embed_file;
                   10912:             }
1.1075.2.47  raeburn  10913:             if ($cleaned_file =~ m{/}) {
                   10914:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  10915:                 $path = &check_for_traversal($path,$url,$toplevel);
                   10916:                 my $item = $fname;
                   10917:                 if ($path ne '') {
                   10918:                     $item = $path.'/'.$fname;
                   10919:                     $subdependencies{$path}{$fname} = 1;
                   10920:                 } else {
                   10921:                     $dependencies{$item} = 1;
                   10922:                 }
                   10923:                 if ($absolutepath) {
                   10924:                     $mapping{$item} = $absolutepath;
                   10925:                 } else {
                   10926:                     $mapping{$item} = $embed_file;
                   10927:                 }
                   10928:             } else {
                   10929:                 $dependencies{$embed_file} = 1;
                   10930:                 if ($absolutepath) {
1.1075.2.47  raeburn  10931:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  10932:                 } else {
1.1075.2.47  raeburn  10933:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  10934:                 }
                   10935:             }
1.984     raeburn  10936:         }
                   10937:     }
1.1071    raeburn  10938:     my $dirptr = 16384;
1.984     raeburn  10939:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  10940:         $currsubfile{$path} = {};
1.1075.2.35  raeburn  10941:         if (($actionurl eq '/adm/portfolio') ||
                   10942:             ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  10943:             my ($sublistref,$listerror) =
                   10944:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   10945:             if (ref($sublistref) eq 'ARRAY') {
                   10946:                 foreach my $line (@{$sublistref}) {
                   10947:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  10948:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  10949:                 }
1.984     raeburn  10950:             }
1.987     raeburn  10951:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  10952:             if (opendir(my $dir,$url.'/'.$path)) {
                   10953:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  10954:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   10955:             }
1.1075.2.11  raeburn  10956:         } elsif (($actionurl eq '/adm/dependencies') ||
                   10957:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  10958:                   ($args->{'context'} eq 'paste')) ||
                   10959:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  10960:             if ($env{'request.course.id'} ne '') {
1.1075.2.35  raeburn  10961:                 my $dir;
                   10962:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   10963:                     $dir = $fileloc;
                   10964:                 } else {
                   10965:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   10966:                 }
1.1071    raeburn  10967:                 if ($dir ne '') {
                   10968:                     my ($sublistref,$listerror) =
                   10969:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   10970:                     if (ref($sublistref) eq 'ARRAY') {
                   10971:                         foreach my $line (@{$sublistref}) {
                   10972:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   10973:                                 undef,$mtime)=split(/\&/,$line,12);
                   10974:                             unless (($testdir&$dirptr) ||
                   10975:                                     ($file_name =~ /^\.\.?$/)) {
                   10976:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   10977:                             }
                   10978:                         }
                   10979:                     }
                   10980:                 }
1.984     raeburn  10981:             }
                   10982:         }
                   10983:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  10984:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  10985:                 my $item = $path.'/'.$file;
                   10986:                 unless ($mapping{$item} eq $item) {
                   10987:                     $pathchanges{$item} = 1;
                   10988:                 }
                   10989:                 $existing{$item} = 1;
                   10990:                 $numexisting ++;
                   10991:             } else {
                   10992:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  10993:             }
                   10994:         }
1.1071    raeburn  10995:         if ($actionurl eq '/adm/dependencies') {
                   10996:             foreach my $path (keys(%currsubfile)) {
                   10997:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   10998:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   10999:                          unless ($subdependencies{$path}{$file}) {
1.1075.2.11  raeburn  11000:                              next if (($rem ne '') &&
                   11001:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   11002:                                        (ref($navmap) &&
                   11003:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   11004:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11005:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  11006:                              $unused{$path.'/'.$file} = 1; 
                   11007:                          }
                   11008:                     }
                   11009:                 }
                   11010:             }
                   11011:         }
1.984     raeburn  11012:     }
1.987     raeburn  11013:     my %currfile;
1.1075.2.35  raeburn  11014:     if (($actionurl eq '/adm/portfolio') ||
                   11015:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  11016:         my ($dirlistref,$listerror) =
                   11017:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   11018:         if (ref($dirlistref) eq 'ARRAY') {
                   11019:             foreach my $line (@{$dirlistref}) {
                   11020:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   11021:                 $currfile{$file_name} = 1;
                   11022:             }
1.984     raeburn  11023:         }
1.987     raeburn  11024:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11025:         if (opendir(my $dir,$url)) {
1.987     raeburn  11026:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  11027:             map {$currfile{$_} = 1;} @dir_list;
                   11028:         }
1.1075.2.11  raeburn  11029:     } elsif (($actionurl eq '/adm/dependencies') ||
                   11030:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11031:               ($args->{'context'} eq 'paste')) ||
                   11032:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11033:         if ($env{'request.course.id'} ne '') {
                   11034:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11035:             if ($dir ne '') {
                   11036:                 my ($dirlistref,$listerror) =
                   11037:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   11038:                 if (ref($dirlistref) eq 'ARRAY') {
                   11039:                     foreach my $line (@{$dirlistref}) {
                   11040:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   11041:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   11042:                         unless (($testdir&$dirptr) ||
                   11043:                                 ($file_name =~ /^\.\.?$/)) {
                   11044:                             $currfile{$file_name} = [$size,$mtime];
                   11045:                         }
                   11046:                     }
                   11047:                 }
                   11048:             }
                   11049:         }
1.984     raeburn  11050:     }
                   11051:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  11052:         if (exists($currfile{$file})) {
1.987     raeburn  11053:             unless ($mapping{$file} eq $file) {
                   11054:                 $pathchanges{$file} = 1;
                   11055:             }
                   11056:             $existing{$file} = 1;
                   11057:             $numexisting ++;
                   11058:         } else {
1.984     raeburn  11059:             $newfiles{$file} = 1;
                   11060:         }
                   11061:     }
1.1071    raeburn  11062:     foreach my $file (keys(%currfile)) {
                   11063:         unless (($file eq $filename) ||
                   11064:                 ($file eq $filename.'.bak') ||
                   11065:                 ($dependencies{$file})) {
1.1075.2.11  raeburn  11066:             if ($actionurl eq '/adm/dependencies') {
1.1075.2.35  raeburn  11067:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   11068:                     next if (($rem ne '') &&
                   11069:                              (($env{"httpref.$rem".$file} ne '') ||
                   11070:                               (ref($navmap) &&
                   11071:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   11072:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11073:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   11074:                 }
1.1075.2.11  raeburn  11075:             }
1.1071    raeburn  11076:             $unused{$file} = 1;
                   11077:         }
                   11078:     }
1.1075.2.11  raeburn  11079:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   11080:         ($args->{'context'} eq 'paste')) {
                   11081:         $counter = scalar(keys(%existing));
                   11082:         $numpathchg = scalar(keys(%pathchanges));
                   11083:         return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35  raeburn  11084:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
                   11085:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   11086:         $counter = scalar(keys(%existing));
                   11087:         $numpathchg = scalar(keys(%pathchanges));
                   11088:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11  raeburn  11089:     }
1.984     raeburn  11090:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  11091:         if ($actionurl eq '/adm/dependencies') {
                   11092:             next if ($embed_file =~ m{^\w+://});
                   11093:         }
1.660     raeburn  11094:         $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11095:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  11096:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  11097:         unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35  raeburn  11098:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   11099:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  11100:         }
1.1075.2.35  raeburn  11101:         $upload_output .= '</td>';
1.1071    raeburn  11102:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1075.2.35  raeburn  11103:             $upload_output.='<td align="right">'.
                   11104:                             '<span class="LC_info LC_fontsize_medium">'.
                   11105:                             &mt("URL points to web address").'</span>';
1.987     raeburn  11106:             $numremref++;
1.660     raeburn  11107:         } elsif ($args->{'error_on_invalid_names'}
                   11108:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35  raeburn  11109:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   11110:                             &mt('Invalid characters').'</span>';
1.987     raeburn  11111:             $numinvalid++;
1.660     raeburn  11112:         } else {
1.1075.2.35  raeburn  11113:             $upload_output .= '<td>'.
                   11114:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  11115:                                                      $embed_file,\%mapping,
1.1071    raeburn  11116:                                                      $allfiles,$codebase,'upload');
                   11117:             $counter ++;
                   11118:             $numnew ++;
1.987     raeburn  11119:         }
                   11120:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   11121:     }
                   11122:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  11123:         if ($actionurl eq '/adm/dependencies') {
                   11124:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   11125:             $modify_output .= &start_data_table_row().
                   11126:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   11127:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   11128:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   11129:                               '<td>'.$size.'</td>'.
                   11130:                               '<td>'.$mtime.'</td>'.
                   11131:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   11132:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   11133:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   11134:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   11135:                               &embedded_file_element('upload_embedded',$counter,
                   11136:                                                      $embed_file,\%mapping,
                   11137:                                                      $allfiles,$codebase,'modify').
                   11138:                               '</div></td>'.
                   11139:                               &end_data_table_row()."\n";
                   11140:             $counter ++;
                   11141:         } else {
                   11142:             $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11143:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   11144:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   11145:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  11146:                               &Apache::loncommon::end_data_table_row()."\n";
                   11147:         }
                   11148:     }
                   11149:     my $delidx = $counter;
                   11150:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   11151:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   11152:         $delete_output .= &start_data_table_row().
                   11153:                           '<td><img src="'.&icon($oldfile).'" />'.
                   11154:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   11155:                           '<td>'.$size.'</td>'.
                   11156:                           '<td>'.$mtime.'</td>'.
                   11157:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   11158:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   11159:                           &embedded_file_element('upload_embedded',$delidx,
                   11160:                                                  $oldfile,\%mapping,$allfiles,
                   11161:                                                  $codebase,'delete').'</td>'.
                   11162:                           &end_data_table_row()."\n"; 
                   11163:         $numunused ++;
                   11164:         $delidx ++;
1.987     raeburn  11165:     }
                   11166:     if ($upload_output) {
                   11167:         $upload_output = &start_data_table().
                   11168:                          $upload_output.
                   11169:                          &end_data_table()."\n";
                   11170:     }
1.1071    raeburn  11171:     if ($modify_output) {
                   11172:         $modify_output = &start_data_table().
                   11173:                          &start_data_table_header_row().
                   11174:                          '<th>'.&mt('File').'</th>'.
                   11175:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11176:                          '<th>'.&mt('Modified').'</th>'.
                   11177:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   11178:                          &end_data_table_header_row().
                   11179:                          $modify_output.
                   11180:                          &end_data_table()."\n";
                   11181:     }
                   11182:     if ($delete_output) {
                   11183:         $delete_output = &start_data_table().
                   11184:                          &start_data_table_header_row().
                   11185:                          '<th>'.&mt('File').'</th>'.
                   11186:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11187:                          '<th>'.&mt('Modified').'</th>'.
                   11188:                          '<th>'.&mt('Delete?').'</th>'.
                   11189:                          &end_data_table_header_row().
                   11190:                          $delete_output.
                   11191:                          &end_data_table()."\n";
                   11192:     }
1.987     raeburn  11193:     my $applies = 0;
                   11194:     if ($numremref) {
                   11195:         $applies ++;
                   11196:     }
                   11197:     if ($numinvalid) {
                   11198:         $applies ++;
                   11199:     }
                   11200:     if ($numexisting) {
                   11201:         $applies ++;
                   11202:     }
1.1071    raeburn  11203:     if ($counter || $numunused) {
1.987     raeburn  11204:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   11205:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  11206:                   $state.'<h3>'.$heading.'</h3>'; 
                   11207:         if ($actionurl eq '/adm/dependencies') {
                   11208:             if ($numnew) {
                   11209:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   11210:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   11211:                            $upload_output.'<br />'."\n";
                   11212:             }
                   11213:             if ($numexisting) {
                   11214:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   11215:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   11216:                            $modify_output.'<br />'."\n";
                   11217:                            $buttontext = &mt('Save changes');
                   11218:             }
                   11219:             if ($numunused) {
                   11220:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   11221:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   11222:                            $delete_output.'<br />'."\n";
                   11223:                            $buttontext = &mt('Save changes');
                   11224:             }
                   11225:         } else {
                   11226:             $output .= $upload_output.'<br />'."\n";
                   11227:         }
                   11228:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   11229:                    $counter.'" />'."\n";
                   11230:         if ($actionurl eq '/adm/dependencies') { 
                   11231:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   11232:                        $numnew.'" />'."\n";
                   11233:         } elsif ($actionurl eq '') {
1.987     raeburn  11234:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   11235:         }
                   11236:     } elsif ($applies) {
                   11237:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   11238:         if ($applies > 1) {
                   11239:             $output .=  
1.1075.2.35  raeburn  11240:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  11241:             if ($numremref) {
                   11242:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   11243:             }
                   11244:             if ($numinvalid) {
                   11245:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   11246:             }
                   11247:             if ($numexisting) {
                   11248:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   11249:             }
                   11250:             $output .= '</ul><br />';
                   11251:         } elsif ($numremref) {
                   11252:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   11253:         } elsif ($numinvalid) {
                   11254:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   11255:         } elsif ($numexisting) {
                   11256:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   11257:         }
                   11258:         $output .= $upload_output.'<br />';
                   11259:     }
                   11260:     my ($pathchange_output,$chgcount);
1.1071    raeburn  11261:     $chgcount = $counter;
1.987     raeburn  11262:     if (keys(%pathchanges) > 0) {
                   11263:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  11264:             if ($counter) {
1.987     raeburn  11265:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   11266:                                                   $embed_file,\%mapping,
1.1071    raeburn  11267:                                                   $allfiles,$codebase,'change');
1.987     raeburn  11268:             } else {
                   11269:                 $pathchange_output .= 
                   11270:                     &start_data_table_row().
                   11271:                     '<td><input type ="checkbox" name="namechange" value="'.
                   11272:                     $chgcount.'" checked="checked" /></td>'.
                   11273:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   11274:                     '<td>'.$embed_file.
                   11275:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  11276:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  11277:                     '</td>'.&end_data_table_row();
1.660     raeburn  11278:             }
1.987     raeburn  11279:             $numpathchg ++;
                   11280:             $chgcount ++;
1.660     raeburn  11281:         }
                   11282:     }
1.1075.2.35  raeburn  11283:     if (($counter) || ($numunused)) {
1.987     raeburn  11284:         if ($numpathchg) {
                   11285:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   11286:                        $numpathchg.'" />'."\n";
                   11287:         }
                   11288:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   11289:             ($actionurl eq '/adm/imsimport')) {
                   11290:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   11291:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   11292:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  11293:         } elsif ($actionurl eq '/adm/dependencies') {
                   11294:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  11295:         }
1.1075.2.35  raeburn  11296:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  11297:     } elsif ($numpathchg) {
                   11298:         my %pathchange = ();
                   11299:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   11300:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11301:             $output .= '<p>'.&mt('or').'</p>'; 
1.1075.2.35  raeburn  11302:         }
1.987     raeburn  11303:     }
1.1071    raeburn  11304:     return ($output,$counter,$numpathchg);
1.987     raeburn  11305: }
                   11306: 
1.1075.2.47  raeburn  11307: =pod
                   11308: 
                   11309: =item * clean_path($name)
                   11310: 
                   11311: Performs clean-up of directories, subdirectories and filename in an
                   11312: embedded object, referenced in an HTML file which is being uploaded
                   11313: to a course or portfolio, where
                   11314: "Upload embedded images/multimedia files if HTML file" checkbox was
                   11315: checked.
                   11316: 
                   11317: Clean-up is similar to replacements in lonnet::clean_filename()
                   11318: except each / between sub-directory and next level is preserved.
                   11319: 
                   11320: =cut
                   11321: 
                   11322: sub clean_path {
                   11323:     my ($embed_file) = @_;
                   11324:     $embed_file =~s{^/+}{};
                   11325:     my @contents;
                   11326:     if ($embed_file =~ m{/}) {
                   11327:         @contents = split(/\//,$embed_file);
                   11328:     } else {
                   11329:         @contents = ($embed_file);
                   11330:     }
                   11331:     my $lastidx = scalar(@contents)-1;
                   11332:     for (my $i=0; $i<=$lastidx; $i++) {
                   11333:         $contents[$i]=~s{\\}{/}g;
                   11334:         $contents[$i]=~s/\s+/\_/g;
                   11335:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   11336:         if ($i == $lastidx) {
                   11337:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   11338:         }
                   11339:     }
                   11340:     if ($lastidx > 0) {
                   11341:         return join('/',@contents);
                   11342:     } else {
                   11343:         return $contents[0];
                   11344:     }
                   11345: }
                   11346: 
1.987     raeburn  11347: sub embedded_file_element {
1.1071    raeburn  11348:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  11349:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   11350:                    (ref($codebase) eq 'HASH'));
                   11351:     my $output;
1.1071    raeburn  11352:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  11353:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   11354:     }
                   11355:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   11356:                &escape($embed_file).'" />';
                   11357:     unless (($context eq 'upload_embedded') && 
                   11358:             ($mapping->{$embed_file} eq $embed_file)) {
                   11359:         $output .='
                   11360:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   11361:     }
                   11362:     my $attrib;
                   11363:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   11364:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   11365:     }
                   11366:     $output .=
                   11367:         "\n\t\t".
                   11368:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   11369:         $attrib.'" />';
                   11370:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   11371:         $output .=
                   11372:             "\n\t\t".
                   11373:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   11374:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  11375:     }
1.987     raeburn  11376:     return $output;
1.660     raeburn  11377: }
                   11378: 
1.1071    raeburn  11379: sub get_dependency_details {
                   11380:     my ($currfile,$currsubfile,$embed_file) = @_;
                   11381:     my ($size,$mtime,$showsize,$showmtime);
                   11382:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   11383:         if ($embed_file =~ m{/}) {
                   11384:             my ($path,$fname) = split(/\//,$embed_file);
                   11385:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   11386:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   11387:             }
                   11388:         } else {
                   11389:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   11390:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   11391:             }
                   11392:         }
                   11393:         $showsize = $size/1024.0;
                   11394:         $showsize = sprintf("%.1f",$showsize);
                   11395:         if ($mtime > 0) {
                   11396:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   11397:         }
                   11398:     }
                   11399:     return ($showsize,$showmtime);
                   11400: }
                   11401: 
                   11402: sub ask_embedded_js {
                   11403:     return <<"END";
                   11404: <script type="text/javascript"">
                   11405: // <![CDATA[
                   11406: function toggleBrowse(counter) {
                   11407:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   11408:     var fileid = document.getElementById('embedded_item_'+counter);
                   11409:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   11410:     if (chkboxid.checked == true) {
                   11411:         uploaddivid.style.display='block';
                   11412:     } else {
                   11413:         uploaddivid.style.display='none';
                   11414:         fileid.value = '';
                   11415:     }
                   11416: }
                   11417: // ]]>
                   11418: </script>
                   11419: 
                   11420: END
                   11421: }
                   11422: 
1.661     raeburn  11423: sub upload_embedded {
                   11424:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  11425:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   11426:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  11427:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   11428:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   11429:         my $orig_uploaded_filename =
                   11430:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  11431:         foreach my $type ('orig','ref','attrib','codebase') {
                   11432:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   11433:                 $env{'form.embedded_'.$type.'_'.$i} =
                   11434:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   11435:             }
                   11436:         }
1.661     raeburn  11437:         my ($path,$fname) =
                   11438:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   11439:         # no path, whole string is fname
                   11440:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   11441:         $fname = &Apache::lonnet::clean_filename($fname);
                   11442:         # See if there is anything left
                   11443:         next if ($fname eq '');
                   11444: 
                   11445:         # Check if file already exists as a file or directory.
                   11446:         my ($state,$msg);
                   11447:         if ($context eq 'portfolio') {
                   11448:             my $port_path = $dirpath;
                   11449:             if ($group ne '') {
                   11450:                 $port_path = "groups/$group/$port_path";
                   11451:             }
1.987     raeburn  11452:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   11453:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  11454:                                               $dir_root,$port_path,$disk_quota,
                   11455:                                               $current_disk_usage,$uname,$udom);
                   11456:             if ($state eq 'will_exceed_quota'
1.984     raeburn  11457:                 || $state eq 'file_locked') {
1.661     raeburn  11458:                 $output .= $msg;
                   11459:                 next;
                   11460:             }
                   11461:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   11462:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   11463:             if ($state eq 'exists') {
                   11464:                 $output .= $msg;
                   11465:                 next;
                   11466:             }
                   11467:         }
                   11468:         # Check if extension is valid
                   11469:         if (($fname =~ /\.(\w+)$/) &&
                   11470:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1075.2.53  raeburn  11471:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   11472:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  11473:             next;
                   11474:         } elsif (($fname =~ /\.(\w+)$/) &&
                   11475:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  11476:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  11477:             next;
                   11478:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34  raeburn  11479:             $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  11480:             next;
                   11481:         }
                   11482:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35  raeburn  11483:         my $subdir = $path;
                   11484:         $subdir =~ s{/+$}{};
1.661     raeburn  11485:         if ($context eq 'portfolio') {
1.984     raeburn  11486:             my $result;
                   11487:             if ($state eq 'existingfile') {
                   11488:                 $result=
                   11489:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35  raeburn  11490:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  11491:             } else {
1.984     raeburn  11492:                 $result=
                   11493:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  11494:                                                     $dirpath.
1.1075.2.35  raeburn  11495:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  11496:                 if ($result !~ m|^/uploaded/|) {
                   11497:                     $output .= '<span class="LC_error">'
                   11498:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11499:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11500:                                .'</span><br />';
                   11501:                     next;
                   11502:                 } else {
1.987     raeburn  11503:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11504:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  11505:                 }
1.661     raeburn  11506:             }
1.1075.2.35  raeburn  11507:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
                   11508:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   11509:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  11510:             my $result =
1.1075.2.35  raeburn  11511:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  11512:             if ($result !~ m|^/uploaded/|) {
                   11513:                 $output .= '<span class="LC_error">'
                   11514:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11515:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11516:                            .'</span><br />';
                   11517:                     next;
                   11518:             } else {
                   11519:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11520:                            $path.$fname.'</span>').'<br />';
1.1075.2.35  raeburn  11521:                 if ($context eq 'syllabus') {
                   11522:                     &Apache::lonnet::make_public_indefinitely($result);
                   11523:                 }
1.987     raeburn  11524:             }
1.661     raeburn  11525:         } else {
                   11526: # Save the file
                   11527:             my $target = $env{'form.embedded_item_'.$i};
                   11528:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   11529:             my $dest = $fullpath.$fname;
                   11530:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  11531:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  11532:             my $count;
                   11533:             my $filepath = $dir_root;
1.1027    raeburn  11534:             foreach my $subdir (@parts) {
                   11535:                 $filepath .= "/$subdir";
                   11536:                 if (!-e $filepath) {
1.661     raeburn  11537:                     mkdir($filepath,0770);
                   11538:                 }
                   11539:             }
                   11540:             my $fh;
                   11541:             if (!open($fh,'>'.$dest)) {
                   11542:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   11543:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  11544:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   11545:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11546:                            '</span><br />';
                   11547:             } else {
                   11548:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   11549:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   11550:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  11551:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   11552:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11553:                               '</span><br />';
                   11554:                 } else {
1.987     raeburn  11555:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11556:                                $url.'</span>').'<br />';
                   11557:                     unless ($context eq 'testbank') {
                   11558:                         $footer .= &mt('View embedded file: [_1]',
                   11559:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   11560:                     }
                   11561:                 }
                   11562:                 close($fh);
                   11563:             }
                   11564:         }
                   11565:         if ($env{'form.embedded_ref_'.$i}) {
                   11566:             $pathchange{$i} = 1;
                   11567:         }
                   11568:     }
                   11569:     if ($output) {
                   11570:         $output = '<p>'.$output.'</p>';
                   11571:     }
                   11572:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   11573:     $returnflag = 'ok';
1.1071    raeburn  11574:     my $numpathchgs = scalar(keys(%pathchange));
                   11575:     if ($numpathchgs > 0) {
1.987     raeburn  11576:         if ($context eq 'portfolio') {
                   11577:             $output .= '<p>'.&mt('or').'</p>';
                   11578:         } elsif ($context eq 'testbank') {
1.1071    raeburn  11579:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   11580:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  11581:             $returnflag = 'modify_orightml';
                   11582:         }
                   11583:     }
1.1071    raeburn  11584:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  11585: }
                   11586: 
                   11587: sub modify_html_form {
                   11588:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   11589:     my $end = 0;
                   11590:     my $modifyform;
                   11591:     if ($context eq 'upload_embedded') {
                   11592:         return unless (ref($pathchange) eq 'HASH');
                   11593:         if ($env{'form.number_embedded_items'}) {
                   11594:             $end += $env{'form.number_embedded_items'};
                   11595:         }
                   11596:         if ($env{'form.number_pathchange_items'}) {
                   11597:             $end += $env{'form.number_pathchange_items'};
                   11598:         }
                   11599:         if ($end) {
                   11600:             for (my $i=0; $i<$end; $i++) {
                   11601:                 if ($i < $env{'form.number_embedded_items'}) {
                   11602:                     next unless($pathchange->{$i});
                   11603:                 }
                   11604:                 $modifyform .=
                   11605:                     &start_data_table_row().
                   11606:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   11607:                     'checked="checked" /></td>'.
                   11608:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   11609:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   11610:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   11611:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   11612:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   11613:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   11614:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   11615:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   11616:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   11617:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   11618:                     &end_data_table_row();
1.1071    raeburn  11619:             }
1.987     raeburn  11620:         }
                   11621:     } else {
                   11622:         $modifyform = $pathchgtable;
                   11623:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   11624:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   11625:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11626:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   11627:         }
                   11628:     }
                   11629:     if ($modifyform) {
1.1071    raeburn  11630:         if ($actionurl eq '/adm/dependencies') {
                   11631:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   11632:         }
1.987     raeburn  11633:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   11634:                '<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".
                   11635:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   11636:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   11637:                '</ol></p>'."\n".'<p>'.
                   11638:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   11639:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   11640:                &start_data_table()."\n".
                   11641:                &start_data_table_header_row().
                   11642:                '<th>'.&mt('Change?').'</th>'.
                   11643:                '<th>'.&mt('Current reference').'</th>'.
                   11644:                '<th>'.&mt('Required reference').'</th>'.
                   11645:                &end_data_table_header_row()."\n".
                   11646:                $modifyform.
                   11647:                &end_data_table().'<br />'."\n".$hiddenstate.
                   11648:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   11649:                '</form>'."\n";
                   11650:     }
                   11651:     return;
                   11652: }
                   11653: 
                   11654: sub modify_html_refs {
1.1075.2.35  raeburn  11655:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  11656:     my $container;
                   11657:     if ($context eq 'portfolio') {
                   11658:         $container = $env{'form.container'};
                   11659:     } elsif ($context eq 'coursedoc') {
                   11660:         $container = $env{'form.primaryurl'};
1.1071    raeburn  11661:     } elsif ($context eq 'manage_dependencies') {
                   11662:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   11663:         $container = "/$container";
1.1075.2.35  raeburn  11664:     } elsif ($context eq 'syllabus') {
                   11665:         $container = $url;
1.987     raeburn  11666:     } else {
1.1027    raeburn  11667:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  11668:     }
                   11669:     my (%allfiles,%codebase,$output,$content);
                   11670:     my @changes = &get_env_multiple('form.namechange');
1.1075.2.35  raeburn  11671:     unless ((@changes > 0)  || ($context eq 'syllabus')) {
1.1071    raeburn  11672:         if (wantarray) {
                   11673:             return ('',0,0); 
                   11674:         } else {
                   11675:             return;
                   11676:         }
                   11677:     }
                   11678:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11679:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  11680:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   11681:             if (wantarray) {
                   11682:                 return ('',0,0);
                   11683:             } else {
                   11684:                 return;
                   11685:             }
                   11686:         } 
1.987     raeburn  11687:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  11688:         if ($content eq '-1') {
                   11689:             if (wantarray) {
                   11690:                 return ('',0,0);
                   11691:             } else {
                   11692:                 return;
                   11693:             }
                   11694:         }
1.987     raeburn  11695:     } else {
1.1071    raeburn  11696:         unless ($container =~ /^\Q$dir_root\E/) {
                   11697:             if (wantarray) {
                   11698:                 return ('',0,0);
                   11699:             } else {
                   11700:                 return;
                   11701:             }
                   11702:         } 
1.1075.2.128  raeburn  11703:         if (open(my $fh,'<',$container)) {
1.987     raeburn  11704:             $content = join('', <$fh>);
                   11705:             close($fh);
                   11706:         } else {
1.1071    raeburn  11707:             if (wantarray) {
                   11708:                 return ('',0,0);
                   11709:             } else {
                   11710:                 return;
                   11711:             }
1.987     raeburn  11712:         }
                   11713:     }
                   11714:     my ($count,$codebasecount) = (0,0);
                   11715:     my $mm = new File::MMagic;
                   11716:     my $mime_type = $mm->checktype_contents($content);
                   11717:     if ($mime_type eq 'text/html') {
                   11718:         my $parse_result = 
                   11719:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   11720:                                                     \%codebase,\$content);
                   11721:         if ($parse_result eq 'ok') {
                   11722:             foreach my $i (@changes) {
                   11723:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   11724:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   11725:                 if ($allfiles{$ref}) {
                   11726:                     my $newname =  $orig;
                   11727:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  11728:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  11729:                     if ($attrib_regexp =~ /:/) {
                   11730:                         $attrib_regexp =~ s/\:/|/g;
                   11731:                     }
                   11732:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11733:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11734:                         $count += $numchg;
1.1075.2.35  raeburn  11735:                         $allfiles{$newname} = $allfiles{$ref};
1.1075.2.48  raeburn  11736:                         delete($allfiles{$ref});
1.987     raeburn  11737:                     }
                   11738:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  11739:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  11740:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   11741:                         $codebasecount ++;
                   11742:                     }
                   11743:                 }
                   11744:             }
1.1075.2.35  raeburn  11745:             my $skiprewrites;
1.987     raeburn  11746:             if ($count || $codebasecount) {
                   11747:                 my $saveresult;
1.1071    raeburn  11748:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11749:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  11750:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11751:                     if ($url eq $container) {
                   11752:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   11753:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11754:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  11755:                                             $fname.'</span>').'</p>';
1.987     raeburn  11756:                     } else {
                   11757:                          $output = '<p class="LC_error">'.
                   11758:                                    &mt('Error: update failed for: [_1].',
                   11759:                                    '<span class="LC_filename">'.
                   11760:                                    $container.'</span>').'</p>';
                   11761:                     }
1.1075.2.35  raeburn  11762:                     if ($context eq 'syllabus') {
                   11763:                         unless ($saveresult eq 'ok') {
                   11764:                             $skiprewrites = 1;
                   11765:                         }
                   11766:                     }
1.987     raeburn  11767:                 } else {
1.1075.2.128  raeburn  11768:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  11769:                         print $fh $content;
                   11770:                         close($fh);
                   11771:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11772:                                   $count,'<span class="LC_filename">'.
                   11773:                                   $container.'</span>').'</p>';
1.661     raeburn  11774:                     } else {
1.987     raeburn  11775:                          $output = '<p class="LC_error">'.
                   11776:                                    &mt('Error: could not update [_1].',
                   11777:                                    '<span class="LC_filename">'.
                   11778:                                    $container.'</span>').'</p>';
1.661     raeburn  11779:                     }
                   11780:                 }
                   11781:             }
1.1075.2.35  raeburn  11782:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   11783:                 my ($actionurl,$state);
                   11784:                 $actionurl = "/public/$udom/$uname/syllabus";
                   11785:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   11786:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   11787:                                               \%codebase,
                   11788:                                               {'context' => 'rewrites',
                   11789:                                                'ignore_remote_references' => 1,});
                   11790:                 if (ref($mapping) eq 'HASH') {
                   11791:                     my $rewrites = 0;
                   11792:                     foreach my $key (keys(%{$mapping})) {
                   11793:                         next if ($key =~ m{^https?://});
                   11794:                         my $ref = $mapping->{$key};
                   11795:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   11796:                         my $attrib;
                   11797:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   11798:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   11799:                         }
                   11800:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11801:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11802:                             $rewrites += $numchg;
                   11803:                         }
                   11804:                     }
                   11805:                     if ($rewrites) {
                   11806:                         my $saveresult;
                   11807:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11808:                         if ($url eq $container) {
                   11809:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   11810:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   11811:                                             $count,'<span class="LC_filename">'.
                   11812:                                             $fname.'</span>').'</p>';
                   11813:                         } else {
                   11814:                             $output .= '<p class="LC_error">'.
                   11815:                                        &mt('Error: could not update links in [_1].',
                   11816:                                        '<span class="LC_filename">'.
                   11817:                                        $container.'</span>').'</p>';
                   11818: 
                   11819:                         }
                   11820:                     }
                   11821:                 }
                   11822:             }
1.987     raeburn  11823:         } else {
                   11824:             &logthis('Failed to parse '.$container.
                   11825:                      ' to modify references: '.$parse_result);
1.661     raeburn  11826:         }
                   11827:     }
1.1071    raeburn  11828:     if (wantarray) {
                   11829:         return ($output,$count,$codebasecount);
                   11830:     } else {
                   11831:         return $output;
                   11832:     }
1.661     raeburn  11833: }
                   11834: 
                   11835: sub check_for_existing {
                   11836:     my ($path,$fname,$element) = @_;
                   11837:     my ($state,$msg);
                   11838:     if (-d $path.'/'.$fname) {
                   11839:         $state = 'exists';
                   11840:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   11841:     } elsif (-e $path.'/'.$fname) {
                   11842:         $state = 'exists';
                   11843:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   11844:     }
                   11845:     if ($state eq 'exists') {
                   11846:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   11847:     }
                   11848:     return ($state,$msg);
                   11849: }
                   11850: 
                   11851: sub check_for_upload {
                   11852:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   11853:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  11854:     my $filesize = length($env{'form.'.$element});
                   11855:     if (!$filesize) {
                   11856:         my $msg = '<span class="LC_error">'.
                   11857:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   11858:                       '<span class="LC_filename">'.$fname.'</span>',
                   11859:                       $filesize).'<br />'.
1.1007    raeburn  11860:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  11861:                   '</span>';
                   11862:         return ('zero_bytes',$msg);
                   11863:     }
                   11864:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  11865:     my $getpropath = 1;
1.1021    raeburn  11866:     my ($dirlistref,$listerror) =
                   11867:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  11868:     my $found_file = 0;
                   11869:     my $locked_file = 0;
1.991     raeburn  11870:     my @lockers;
                   11871:     my $navmap;
                   11872:     if ($env{'request.course.id'}) {
                   11873:         $navmap = Apache::lonnavmaps::navmap->new();
                   11874:     }
1.1021    raeburn  11875:     if (ref($dirlistref) eq 'ARRAY') {
                   11876:         foreach my $line (@{$dirlistref}) {
                   11877:             my ($file_name,$rest)=split(/\&/,$line,2);
                   11878:             if ($file_name eq $fname){
                   11879:                 $file_name = $path.$file_name;
                   11880:                 if ($group ne '') {
                   11881:                     $file_name = $group.$file_name;
                   11882:                 }
                   11883:                 $found_file = 1;
                   11884:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   11885:                     foreach my $lock (@lockers) {
                   11886:                         if (ref($lock) eq 'ARRAY') {
                   11887:                             my ($symb,$crsid) = @{$lock};
                   11888:                             if ($crsid eq $env{'request.course.id'}) {
                   11889:                                 if (ref($navmap)) {
                   11890:                                     my $res = $navmap->getBySymb($symb);
                   11891:                                     foreach my $part (@{$res->parts()}) { 
                   11892:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   11893:                                         unless (($slot_status == $res->RESERVED) ||
                   11894:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   11895:                                             $locked_file = 1;
                   11896:                                         }
1.991     raeburn  11897:                                     }
1.1021    raeburn  11898:                                 } else {
                   11899:                                     $locked_file = 1;
1.991     raeburn  11900:                                 }
                   11901:                             } else {
                   11902:                                 $locked_file = 1;
                   11903:                             }
                   11904:                         }
1.1021    raeburn  11905:                    }
                   11906:                 } else {
                   11907:                     my @info = split(/\&/,$rest);
                   11908:                     my $currsize = $info[6]/1000;
                   11909:                     if ($currsize < $filesize) {
                   11910:                         my $extra = $filesize - $currsize;
                   11911:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1075.2.69  raeburn  11912:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  11913:                                       &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  11914:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   11915:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   11916:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  11917:                             return ('will_exceed_quota',$msg);
                   11918:                         }
1.984     raeburn  11919:                     }
                   11920:                 }
1.661     raeburn  11921:             }
                   11922:         }
                   11923:     }
                   11924:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1075.2.69  raeburn  11925:         my $msg = '<p class="LC_warning">'.
                   11926:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
                   11927:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  11928:         return ('will_exceed_quota',$msg);
                   11929:     } elsif ($found_file) {
                   11930:         if ($locked_file) {
1.1075.2.69  raeburn  11931:             my $msg = '<p class="LC_warning">';
1.661     raeburn  11932:             $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  11933:             $msg .= '</p>';
1.661     raeburn  11934:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   11935:             return ('file_locked',$msg);
                   11936:         } else {
1.1075.2.69  raeburn  11937:             my $msg = '<p class="LC_error">';
1.984     raeburn  11938:             $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  11939:             $msg .= '</p>';
1.984     raeburn  11940:             return ('existingfile',$msg);
1.661     raeburn  11941:         }
                   11942:     }
                   11943: }
                   11944: 
1.987     raeburn  11945: sub check_for_traversal {
                   11946:     my ($path,$url,$toplevel) = @_;
                   11947:     my @parts=split(/\//,$path);
                   11948:     my $cleanpath;
                   11949:     my $fullpath = $url;
                   11950:     for (my $i=0;$i<@parts;$i++) {
                   11951:         next if ($parts[$i] eq '.');
                   11952:         if ($parts[$i] eq '..') {
                   11953:             $fullpath =~ s{([^/]+/)$}{};
                   11954:         } else {
                   11955:             $fullpath .= $parts[$i].'/';
                   11956:         }
                   11957:     }
                   11958:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   11959:         $cleanpath = $1;
                   11960:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   11961:         my $curr_toprel = $1;
                   11962:         my @parts = split(/\//,$curr_toprel);
                   11963:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   11964:         my @urlparts = split(/\//,$url_toprel);
                   11965:         my $doubledots;
                   11966:         my $startdiff = -1;
                   11967:         for (my $i=0; $i<@urlparts; $i++) {
                   11968:             if ($startdiff == -1) {
                   11969:                 unless ($urlparts[$i] eq $parts[$i]) {
                   11970:                     $startdiff = $i;
                   11971:                     $doubledots .= '../';
                   11972:                 }
                   11973:             } else {
                   11974:                 $doubledots .= '../';
                   11975:             }
                   11976:         }
                   11977:         if ($startdiff > -1) {
                   11978:             $cleanpath = $doubledots;
                   11979:             for (my $i=$startdiff; $i<@parts; $i++) {
                   11980:                 $cleanpath .= $parts[$i].'/';
                   11981:             }
                   11982:         }
                   11983:     }
                   11984:     $cleanpath =~ s{(/)$}{};
                   11985:     return $cleanpath;
                   11986: }
1.31      albertel 11987: 
1.1053    raeburn  11988: sub is_archive_file {
                   11989:     my ($mimetype) = @_;
                   11990:     if (($mimetype eq 'application/octet-stream') ||
                   11991:         ($mimetype eq 'application/x-stuffit') ||
                   11992:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   11993:         return 1;
                   11994:     }
                   11995:     return;
                   11996: }
                   11997: 
                   11998: sub decompress_form {
1.1065    raeburn  11999:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  12000:     my %lt = &Apache::lonlocal::texthash (
                   12001:         this => 'This file is an archive file.',
1.1067    raeburn  12002:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  12003:         itsc => 'Its contents are as follows:',
1.1053    raeburn  12004:         youm => 'You may wish to extract its contents.',
                   12005:         extr => 'Extract contents',
1.1067    raeburn  12006:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   12007:         proa => 'Process automatically?',
1.1053    raeburn  12008:         yes  => 'Yes',
                   12009:         no   => 'No',
1.1067    raeburn  12010:         fold => 'Title for folder containing movie',
                   12011:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  12012:     );
1.1065    raeburn  12013:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  12014:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  12015:     my $info = &list_archive_contents($fileloc,\@paths);
                   12016:     if (@paths) {
                   12017:         foreach my $path (@paths) {
                   12018:             $path =~ s{^/}{};
1.1067    raeburn  12019:             if ($path =~ m{^([^/]+)/$}) {
                   12020:                 $topdir = $1;
                   12021:             }
1.1065    raeburn  12022:             if ($path =~ m{^([^/]+)/}) {
                   12023:                 $toplevel{$1} = $path;
                   12024:             } else {
                   12025:                 $toplevel{$path} = $path;
                   12026:             }
                   12027:         }
                   12028:     }
1.1067    raeburn  12029:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1075.2.59  raeburn  12030:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  12031:                         "$topdir/media/",
                   12032:                         "$topdir/media/$topdir.mp4",
                   12033:                         "$topdir/media/FirstFrame.png",
                   12034:                         "$topdir/media/player.swf",
                   12035:                         "$topdir/media/swfobject.js",
                   12036:                         "$topdir/media/expressInstall.swf");
1.1075.2.81  raeburn  12037:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1075.2.59  raeburn  12038:                          "$topdir/$topdir.mp4",
                   12039:                          "$topdir/$topdir\_config.xml",
                   12040:                          "$topdir/$topdir\_controller.swf",
                   12041:                          "$topdir/$topdir\_embed.css",
                   12042:                          "$topdir/$topdir\_First_Frame.png",
                   12043:                          "$topdir/$topdir\_player.html",
                   12044:                          "$topdir/$topdir\_Thumbnails.png",
                   12045:                          "$topdir/playerProductInstall.swf",
                   12046:                          "$topdir/scripts/",
                   12047:                          "$topdir/scripts/config_xml.js",
                   12048:                          "$topdir/scripts/handlebars.js",
                   12049:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   12050:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   12051:                          "$topdir/scripts/modernizr.js",
                   12052:                          "$topdir/scripts/player-min.js",
                   12053:                          "$topdir/scripts/swfobject.js",
                   12054:                          "$topdir/skins/",
                   12055:                          "$topdir/skins/configuration_express.xml",
                   12056:                          "$topdir/skins/express_show/",
                   12057:                          "$topdir/skins/express_show/player-min.css",
                   12058:                          "$topdir/skins/express_show/spritesheet.png");
1.1075.2.81  raeburn  12059:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   12060:                          "$topdir/$topdir.mp4",
                   12061:                          "$topdir/$topdir\_config.xml",
                   12062:                          "$topdir/$topdir\_controller.swf",
                   12063:                          "$topdir/$topdir\_embed.css",
                   12064:                          "$topdir/$topdir\_First_Frame.png",
                   12065:                          "$topdir/$topdir\_player.html",
                   12066:                          "$topdir/$topdir\_Thumbnails.png",
                   12067:                          "$topdir/playerProductInstall.swf",
                   12068:                          "$topdir/scripts/",
                   12069:                          "$topdir/scripts/config_xml.js",
                   12070:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   12071:                          "$topdir/skins/",
                   12072:                          "$topdir/skins/configuration_express.xml",
                   12073:                          "$topdir/skins/express_show/",
                   12074:                          "$topdir/skins/express_show/spritesheet.min.css",
                   12075:                          "$topdir/skins/express_show/spritesheet.png",
                   12076:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1075.2.59  raeburn  12077:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  12078:         if (@diffs == 0) {
1.1075.2.59  raeburn  12079:             $is_camtasia = 6;
                   12080:         } else {
1.1075.2.81  raeburn  12081:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1075.2.59  raeburn  12082:             if (@diffs == 0) {
                   12083:                 $is_camtasia = 8;
1.1075.2.81  raeburn  12084:             } else {
                   12085:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   12086:                 if (@diffs == 0) {
                   12087:                     $is_camtasia = 8;
                   12088:                 }
1.1075.2.59  raeburn  12089:             }
1.1067    raeburn  12090:         }
                   12091:     }
                   12092:     my $output;
                   12093:     if ($is_camtasia) {
                   12094:         $output = <<"ENDCAM";
                   12095: <script type="text/javascript" language="Javascript">
                   12096: // <![CDATA[
                   12097: 
                   12098: function camtasiaToggle() {
                   12099:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   12100:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1075.2.59  raeburn  12101:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  12102:                 document.getElementById('camtasia_titles').style.display='block';
                   12103:             } else {
                   12104:                 document.getElementById('camtasia_titles').style.display='none';
                   12105:             }
                   12106:         }
                   12107:     }
                   12108:     return;
                   12109: }
                   12110: 
                   12111: // ]]>
                   12112: </script>
                   12113: <p>$lt{'camt'}</p>
                   12114: ENDCAM
1.1065    raeburn  12115:     } else {
1.1067    raeburn  12116:         $output = '<p>'.$lt{'this'};
                   12117:         if ($info eq '') {
                   12118:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   12119:         } else {
                   12120:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   12121:                        '<div><pre>'.$info.'</pre></div>';
                   12122:         }
1.1065    raeburn  12123:     }
1.1067    raeburn  12124:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  12125:     my $duplicates;
                   12126:     my $num = 0;
                   12127:     if (ref($dirlist) eq 'ARRAY') {
                   12128:         foreach my $item (@{$dirlist}) {
                   12129:             if (ref($item) eq 'ARRAY') {
                   12130:                 if (exists($toplevel{$item->[0]})) {
                   12131:                     $duplicates .= 
                   12132:                         &start_data_table_row().
                   12133:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12134:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   12135:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12136:                         'value="1" />'.&mt('Yes').'</label>'.
                   12137:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   12138:                         '<td>'.$item->[0].'</td>';
                   12139:                     if ($item->[2]) {
                   12140:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   12141:                     } else {
                   12142:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   12143:                     }
                   12144:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   12145:                                    '<td>'.
                   12146:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   12147:                                    '</td>'.
                   12148:                                    &end_data_table_row();
                   12149:                     $num ++;
                   12150:                 }
                   12151:             }
                   12152:         }
                   12153:     }
                   12154:     my $itemcount;
                   12155:     if (@paths > 0) {
                   12156:         $itemcount = scalar(@paths);
                   12157:     } else {
                   12158:         $itemcount = 1;
                   12159:     }
1.1067    raeburn  12160:     if ($is_camtasia) {
                   12161:         $output .= $lt{'auto'}.'<br />'.
                   12162:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1075.2.59  raeburn  12163:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  12164:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   12165:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   12166:                    $lt{'no'}.'</label></span><br />'.
                   12167:                    '<div id="camtasia_titles" style="display:block">'.
                   12168:                    &Apache::lonhtmlcommon::start_pick_box().
                   12169:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   12170:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   12171:                    &Apache::lonhtmlcommon::row_closure().
                   12172:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   12173:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   12174:                    &Apache::lonhtmlcommon::row_closure(1).
                   12175:                    &Apache::lonhtmlcommon::end_pick_box().
                   12176:                    '</div>';
                   12177:     }
1.1065    raeburn  12178:     $output .= 
                   12179:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  12180:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   12181:         "\n";
1.1065    raeburn  12182:     if ($duplicates ne '') {
                   12183:         $output .= '<p><span class="LC_warning">'.
                   12184:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   12185:                    &start_data_table().
                   12186:                    &start_data_table_header_row().
                   12187:                    '<th>'.&mt('Overwrite?').'</th>'.
                   12188:                    '<th>'.&mt('Name').'</th>'.
                   12189:                    '<th>'.&mt('Type').'</th>'.
                   12190:                    '<th>'.&mt('Size').'</th>'.
                   12191:                    '<th>'.&mt('Last modified').'</th>'.
                   12192:                    &end_data_table_header_row().
                   12193:                    $duplicates.
                   12194:                    &end_data_table().
                   12195:                    '</p>';
                   12196:     }
1.1067    raeburn  12197:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  12198:     if (ref($hiddenelements) eq 'HASH') {
                   12199:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   12200:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   12201:         }
                   12202:     }
                   12203:     $output .= <<"END";
1.1067    raeburn  12204: <br />
1.1053    raeburn  12205: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   12206: </form>
                   12207: $noextract
                   12208: END
                   12209:     return $output;
                   12210: }
                   12211: 
1.1065    raeburn  12212: sub decompression_utility {
                   12213:     my ($program) = @_;
                   12214:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   12215:     my $location;
                   12216:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   12217:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   12218:                          '/usr/sbin/') {
                   12219:             if (-x $dir.$program) {
                   12220:                 $location = $dir.$program;
                   12221:                 last;
                   12222:             }
                   12223:         }
                   12224:     }
                   12225:     return $location;
                   12226: }
                   12227: 
                   12228: sub list_archive_contents {
                   12229:     my ($file,$pathsref) = @_;
                   12230:     my (@cmd,$output);
                   12231:     my $needsregexp;
                   12232:     if ($file =~ /\.zip$/) {
                   12233:         @cmd = (&decompression_utility('unzip'),"-l");
                   12234:         $needsregexp = 1;
                   12235:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   12236:              ($file =~ /\.tgz$/)) {
                   12237:         @cmd = (&decompression_utility('tar'),"-ztf");
                   12238:     } elsif ($file =~ /\.tar\.bz2$/) {
                   12239:         @cmd = (&decompression_utility('tar'),"-jtf");
                   12240:     } elsif ($file =~ m|\.tar$|) {
                   12241:         @cmd = (&decompression_utility('tar'),"-tf");
                   12242:     }
                   12243:     if (@cmd) {
                   12244:         undef($!);
                   12245:         undef($@);
                   12246:         if (open(my $fh,"-|", @cmd, $file)) {
                   12247:             while (my $line = <$fh>) {
                   12248:                 $output .= $line;
                   12249:                 chomp($line);
                   12250:                 my $item;
                   12251:                 if ($needsregexp) {
                   12252:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   12253:                 } else {
                   12254:                     $item = $line;
                   12255:                 }
                   12256:                 if ($item ne '') {
                   12257:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   12258:                         push(@{$pathsref},$item);
                   12259:                     } 
                   12260:                 }
                   12261:             }
                   12262:             close($fh);
                   12263:         }
                   12264:     }
                   12265:     return $output;
                   12266: }
                   12267: 
1.1053    raeburn  12268: sub decompress_uploaded_file {
                   12269:     my ($file,$dir) = @_;
                   12270:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   12271:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   12272:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   12273:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   12274:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   12275:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   12276:     my $decompressed = $env{'cgi.decompressed'};
                   12277:     &Apache::lonnet::delenv('cgi.file');
                   12278:     &Apache::lonnet::delenv('cgi.dir');
                   12279:     &Apache::lonnet::delenv('cgi.decompressed');
                   12280:     return ($decompressed,$result);
                   12281: }
                   12282: 
1.1055    raeburn  12283: sub process_decompression {
                   12284:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1075.2.128  raeburn  12285:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   12286:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12287:                &mt('Unexpected file path.').'</p>'."\n";
                   12288:     }
                   12289:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   12290:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12291:                &mt('Unexpected course context.').'</p>'."\n";
                   12292:     }
                   12293:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
                   12294:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12295:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   12296:     }
1.1055    raeburn  12297:     my ($dir,$error,$warning,$output);
1.1075.2.69  raeburn  12298:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1075.2.34  raeburn  12299:         $error = &mt('Filename not a supported archive file type.').
                   12300:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  12301:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   12302:     } else {
                   12303:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12304:         if ($docuhome eq 'no_host') {
                   12305:             $error = &mt('Could not determine home server for course.');
                   12306:         } else {
                   12307:             my @ids=&Apache::lonnet::current_machine_ids();
                   12308:             my $currdir = "$dir_root/$destination";
                   12309:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12310:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   12311:                        "$dir_root/$destination";
                   12312:             } else {
                   12313:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   12314:                        "$dir_root/$docudom/$docuname/$destination";
                   12315:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   12316:                     $error = &mt('Archive file not found.');
                   12317:                 }
                   12318:             }
1.1065    raeburn  12319:             my (@to_overwrite,@to_skip);
                   12320:             if ($env{'form.archive_overwrite_total'} > 0) {
                   12321:                 my $total = $env{'form.archive_overwrite_total'};
                   12322:                 for (my $i=0; $i<$total; $i++) {
                   12323:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   12324:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   12325:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   12326:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   12327:                     }
                   12328:                 }
                   12329:             }
                   12330:             my $numskip = scalar(@to_skip);
1.1075.2.128  raeburn  12331:             my $numoverwrite = scalar(@to_overwrite);
                   12332:             if (($numskip) && (!$numoverwrite)) {
1.1065    raeburn  12333:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   12334:             } elsif ($dir eq '') {
1.1055    raeburn  12335:                 $error = &mt('Directory containing archive file unavailable.');
                   12336:             } elsif (!$error) {
1.1065    raeburn  12337:                 my ($decompressed,$display);
1.1075.2.128  raeburn  12338:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  12339:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   12340:                     mkdir("$dir/$tempdir",0755);
1.1075.2.128  raeburn  12341:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   12342:                         ($decompressed,$display) =
                   12343:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   12344:                         foreach my $item (@to_skip) {
                   12345:                             if (($item ne '') && ($item !~ /\.\./)) {
                   12346:                                 if (-f "$dir/$tempdir/$item") {
                   12347:                                     unlink("$dir/$tempdir/$item");
                   12348:                                 } elsif (-d "$dir/$tempdir/$item") {
                   12349:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
                   12350:                                 }
                   12351:                             }
                   12352:                         }
                   12353:                         foreach my $item (@to_overwrite) {
                   12354:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   12355:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   12356:                                     if (-f "$dir/$item") {
                   12357:                                         unlink("$dir/$item");
                   12358:                                     } elsif (-d "$dir/$item") {
                   12359:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
                   12360:                                     }
                   12361:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   12362:                                 }
1.1065    raeburn  12363:                             }
                   12364:                         }
1.1075.2.128  raeburn  12365:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
                   12366:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
                   12367:                         }
1.1065    raeburn  12368:                     }
                   12369:                 } else {
                   12370:                     ($decompressed,$display) = 
                   12371:                         &decompress_uploaded_file($file,$dir);
                   12372:                 }
1.1055    raeburn  12373:                 if ($decompressed eq 'ok') {
1.1065    raeburn  12374:                     $output = '<p class="LC_info">'.
                   12375:                               &mt('Files extracted successfully from archive.').
                   12376:                               '</p>'."\n";
1.1055    raeburn  12377:                     my ($warning,$result,@contents);
                   12378:                     my ($newdirlistref,$newlisterror) =
                   12379:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   12380:                                                  $docuname,1);
                   12381:                     my (%is_dir,%changes,@newitems);
                   12382:                     my $dirptr = 16384;
1.1065    raeburn  12383:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  12384:                         foreach my $dir_line (@{$newdirlistref}) {
                   12385:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1075.2.128  raeburn  12386:                             unless (($item =~ /^\.+$/) || ($item eq $file)) { 
1.1055    raeburn  12387:                                 push(@newitems,$item);
                   12388:                                 if ($dirptr&$testdir) {
                   12389:                                     $is_dir{$item} = 1;
                   12390:                                 }
                   12391:                                 $changes{$item} = 1;
                   12392:                             }
                   12393:                         }
                   12394:                     }
                   12395:                     if (keys(%changes) > 0) {
                   12396:                         foreach my $item (sort(@newitems)) {
                   12397:                             if ($changes{$item}) {
                   12398:                                 push(@contents,$item);
                   12399:                             }
                   12400:                         }
                   12401:                     }
                   12402:                     if (@contents > 0) {
1.1067    raeburn  12403:                         my $wantform;
                   12404:                         unless ($env{'form.autoextract_camtasia'}) {
                   12405:                             $wantform = 1;
                   12406:                         }
1.1056    raeburn  12407:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  12408:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   12409:                                                                 $currdir,\%is_dir,
                   12410:                                                                 \%children,\%parent,
1.1056    raeburn  12411:                                                                 \@contents,\%dirorder,
                   12412:                                                                 \%titles,$wantform);
1.1055    raeburn  12413:                         if ($datatable ne '') {
                   12414:                             $output .= &archive_options_form('decompressed',$datatable,
                   12415:                                                              $count,$hiddenelem);
1.1065    raeburn  12416:                             my $startcount = 6;
1.1055    raeburn  12417:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  12418:                                                            \%titles,\%children);
1.1055    raeburn  12419:                         }
1.1067    raeburn  12420:                         if ($env{'form.autoextract_camtasia'}) {
1.1075.2.59  raeburn  12421:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  12422:                             my %displayed;
                   12423:                             my $total = 1;
                   12424:                             $env{'form.archive_directory'} = [];
                   12425:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   12426:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   12427:                                 $path =~ s{/$}{};
                   12428:                                 my $item;
                   12429:                                 if ($path ne '') {
                   12430:                                     $item = "$path/$titles{$i}";
                   12431:                                 } else {
                   12432:                                     $item = $titles{$i};
                   12433:                                 }
                   12434:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   12435:                                 if ($item eq $contents[0]) {
                   12436:                                     push(@{$env{'form.archive_directory'}},$i);
                   12437:                                     $env{'form.archive_'.$i} = 'display';
                   12438:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   12439:                                     $displayed{'folder'} = $i;
1.1075.2.59  raeburn  12440:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   12441:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067    raeburn  12442:                                     $env{'form.archive_'.$i} = 'display';
                   12443:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   12444:                                     $displayed{'web'} = $i;
                   12445:                                 } else {
1.1075.2.59  raeburn  12446:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   12447:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   12448:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  12449:                                         push(@{$env{'form.archive_directory'}},$i);
                   12450:                                     }
                   12451:                                     $env{'form.archive_'.$i} = 'dependency';
                   12452:                                 }
                   12453:                                 $total ++;
                   12454:                             }
                   12455:                             for (my $i=1; $i<$total; $i++) {
                   12456:                                 next if ($i == $displayed{'web'});
                   12457:                                 next if ($i == $displayed{'folder'});
                   12458:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   12459:                             }
                   12460:                             $env{'form.phase'} = 'decompress_cleanup';
                   12461:                             $env{'form.archivedelete'} = 1;
                   12462:                             $env{'form.archive_count'} = $total-1;
                   12463:                             $output .=
                   12464:                                 &process_extracted_files('coursedocs',$docudom,
                   12465:                                                          $docuname,$destination,
                   12466:                                                          $dir_root,$hiddenelem);
                   12467:                         }
1.1055    raeburn  12468:                     } else {
                   12469:                         $warning = &mt('No new items extracted from archive file.');
                   12470:                     }
                   12471:                 } else {
                   12472:                     $output = $display;
                   12473:                     $error = &mt('An error occurred during extraction from the archive file.');
                   12474:                 }
                   12475:             }
                   12476:         }
                   12477:     }
                   12478:     if ($error) {
                   12479:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12480:                    $error.'</p>'."\n";
                   12481:     }
                   12482:     if ($warning) {
                   12483:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   12484:     }
                   12485:     return $output;
                   12486: }
                   12487: 
                   12488: sub get_extracted {
1.1056    raeburn  12489:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   12490:         $titles,$wantform) = @_;
1.1055    raeburn  12491:     my $count = 0;
                   12492:     my $depth = 0;
                   12493:     my $datatable;
1.1056    raeburn  12494:     my @hierarchy;
1.1055    raeburn  12495:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  12496:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   12497:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  12498:     foreach my $item (@{$contents}) {
                   12499:         $count ++;
1.1056    raeburn  12500:         @{$dirorder->{$count}} = @hierarchy;
                   12501:         $titles->{$count} = $item;
1.1055    raeburn  12502:         &archive_hierarchy($depth,$count,$parent,$children);
                   12503:         if ($wantform) {
                   12504:             $datatable .= &archive_row($is_dir->{$item},$item,
                   12505:                                        $currdir,$depth,$count);
                   12506:         }
                   12507:         if ($is_dir->{$item}) {
                   12508:             $depth ++;
1.1056    raeburn  12509:             push(@hierarchy,$count);
                   12510:             $parent->{$depth} = $count;
1.1055    raeburn  12511:             $datatable .=
                   12512:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  12513:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   12514:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  12515:             $depth --;
1.1056    raeburn  12516:             pop(@hierarchy);
1.1055    raeburn  12517:         }
                   12518:     }
                   12519:     return ($count,$datatable);
                   12520: }
                   12521: 
                   12522: sub recurse_extracted_archive {
1.1056    raeburn  12523:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   12524:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  12525:     my $result='';
1.1056    raeburn  12526:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   12527:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   12528:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  12529:         return $result;
                   12530:     }
                   12531:     my $dirptr = 16384;
                   12532:     my ($newdirlistref,$newlisterror) =
                   12533:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   12534:     if (ref($newdirlistref) eq 'ARRAY') {
                   12535:         foreach my $dir_line (@{$newdirlistref}) {
                   12536:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   12537:             unless ($item =~ /^\.+$/) {
                   12538:                 $$count ++;
1.1056    raeburn  12539:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   12540:                 $titles->{$$count} = $item;
1.1055    raeburn  12541:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  12542: 
1.1055    raeburn  12543:                 my $is_dir;
                   12544:                 if ($dirptr&$testdir) {
                   12545:                     $is_dir = 1;
                   12546:                 }
                   12547:                 if ($wantform) {
                   12548:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   12549:                 }
                   12550:                 if ($is_dir) {
                   12551:                     $$depth ++;
1.1056    raeburn  12552:                     push(@{$hierarchy},$$count);
                   12553:                     $parent->{$$depth} = $$count;
1.1055    raeburn  12554:                     $result .=
                   12555:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   12556:                                                    $docuname,$depth,$count,
1.1056    raeburn  12557:                                                    $hierarchy,$dirorder,$children,
                   12558:                                                    $parent,$titles,$wantform);
1.1055    raeburn  12559:                     $$depth --;
1.1056    raeburn  12560:                     pop(@{$hierarchy});
1.1055    raeburn  12561:                 }
                   12562:             }
                   12563:         }
                   12564:     }
                   12565:     return $result;
                   12566: }
                   12567: 
                   12568: sub archive_hierarchy {
                   12569:     my ($depth,$count,$parent,$children) =@_;
                   12570:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   12571:         if (exists($parent->{$depth})) {
                   12572:              $children->{$parent->{$depth}} .= $count.':';
                   12573:         }
                   12574:     }
                   12575:     return;
                   12576: }
                   12577: 
                   12578: sub archive_row {
                   12579:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   12580:     my ($name) = ($item =~ m{([^/]+)$});
                   12581:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  12582:                                        'display'    => 'Add as file',
1.1055    raeburn  12583:                                        'dependency' => 'Include as dependency',
                   12584:                                        'discard'    => 'Discard',
                   12585:                                       );
                   12586:     if ($is_dir) {
1.1059    raeburn  12587:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  12588:     }
1.1056    raeburn  12589:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   12590:     my $offset = 0;
1.1055    raeburn  12591:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  12592:         $offset ++;
1.1065    raeburn  12593:         if ($action ne 'display') {
                   12594:             $offset ++;
                   12595:         }  
1.1055    raeburn  12596:         $output .= '<td><span class="LC_nobreak">'.
                   12597:                    '<label><input type="radio" name="archive_'.$count.
                   12598:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   12599:         my $text = $choices{$action};
                   12600:         if ($is_dir) {
                   12601:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   12602:             if ($action eq 'display') {
1.1059    raeburn  12603:                 $text = &mt('Add as folder');
1.1055    raeburn  12604:             }
1.1056    raeburn  12605:         } else {
                   12606:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   12607: 
                   12608:         }
                   12609:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   12610:         if ($action eq 'dependency') {
                   12611:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   12612:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   12613:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   12614:                        '<option value=""></option>'."\n".
                   12615:                        '</select>'."\n".
                   12616:                        '</div>';
1.1059    raeburn  12617:         } elsif ($action eq 'display') {
                   12618:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   12619:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   12620:                        '</div>';
1.1055    raeburn  12621:         }
1.1056    raeburn  12622:         $output .= '</td>';
1.1055    raeburn  12623:     }
                   12624:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   12625:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   12626:     for (my $i=0; $i<$depth; $i++) {
                   12627:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   12628:     }
                   12629:     if ($is_dir) {
                   12630:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   12631:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   12632:     } else {
                   12633:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   12634:     }
                   12635:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   12636:                &end_data_table_row();
                   12637:     return $output;
                   12638: }
                   12639: 
                   12640: sub archive_options_form {
1.1065    raeburn  12641:     my ($form,$display,$count,$hiddenelem) = @_;
                   12642:     my %lt = &Apache::lonlocal::texthash(
                   12643:                perm => 'Permanently remove archive file?',
                   12644:                hows => 'How should each extracted item be incorporated in the course?',
                   12645:                cont => 'Content actions for all',
                   12646:                addf => 'Add as folder/file',
                   12647:                incd => 'Include as dependency for a displayed file',
                   12648:                disc => 'Discard',
                   12649:                no   => 'No',
                   12650:                yes  => 'Yes',
                   12651:                save => 'Save',
                   12652:     );
                   12653:     my $output = <<"END";
                   12654: <form name="$form" method="post" action="">
                   12655: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   12656: <label>
                   12657:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   12658: </label>
                   12659: &nbsp;
                   12660: <label>
                   12661:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   12662: </span>
                   12663: </p>
                   12664: <input type="hidden" name="phase" value="decompress_cleanup" />
                   12665: <br />$lt{'hows'}
                   12666: <div class="LC_columnSection">
                   12667:   <fieldset>
                   12668:     <legend>$lt{'cont'}</legend>
                   12669:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   12670:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   12671:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   12672:   </fieldset>
                   12673: </div>
                   12674: END
                   12675:     return $output.
1.1055    raeburn  12676:            &start_data_table()."\n".
1.1065    raeburn  12677:            $display."\n".
1.1055    raeburn  12678:            &end_data_table()."\n".
                   12679:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   12680:            $hiddenelem.
1.1065    raeburn  12681:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  12682:            '</form>';
                   12683: }
                   12684: 
                   12685: sub archive_javascript {
1.1056    raeburn  12686:     my ($startcount,$numitems,$titles,$children) = @_;
                   12687:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  12688:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  12689:     my $scripttag = <<START;
                   12690: <script type="text/javascript">
                   12691: // <![CDATA[
                   12692: 
                   12693: function checkAll(form,prefix) {
                   12694:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   12695:     for (var i=0; i < form.elements.length; i++) {
                   12696:         var id = form.elements[i].id;
                   12697:         if ((id != '') && (id != undefined)) {
                   12698:             if (idstr.test(id)) {
                   12699:                 if (form.elements[i].type == 'radio') {
                   12700:                     form.elements[i].checked = true;
1.1056    raeburn  12701:                     var nostart = i-$startcount;
1.1059    raeburn  12702:                     var offset = nostart%7;
                   12703:                     var count = (nostart-offset)/7;    
1.1056    raeburn  12704:                     dependencyCheck(form,count,offset);
1.1055    raeburn  12705:                 }
                   12706:             }
                   12707:         }
                   12708:     }
                   12709: }
                   12710: 
                   12711: function propagateCheck(form,count) {
                   12712:     if (count > 0) {
1.1059    raeburn  12713:         var startelement = $startcount + ((count-1) * 7);
                   12714:         for (var j=1; j<6; j++) {
                   12715:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  12716:                 var item = startelement + j; 
                   12717:                 if (form.elements[item].type == 'radio') {
                   12718:                     if (form.elements[item].checked) {
                   12719:                         containerCheck(form,count,j);
                   12720:                         break;
                   12721:                     }
1.1055    raeburn  12722:                 }
                   12723:             }
                   12724:         }
                   12725:     }
                   12726: }
                   12727: 
                   12728: numitems = $numitems
1.1056    raeburn  12729: var titles = new Array(numitems);
                   12730: var parents = new Array(numitems);
1.1055    raeburn  12731: for (var i=0; i<numitems; i++) {
1.1056    raeburn  12732:     parents[i] = new Array;
1.1055    raeburn  12733: }
1.1059    raeburn  12734: var maintitle = '$maintitle';
1.1055    raeburn  12735: 
                   12736: START
                   12737: 
1.1056    raeburn  12738:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   12739:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  12740:         for (my $i=0; $i<@contents; $i ++) {
                   12741:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   12742:         }
                   12743:     }
                   12744: 
1.1056    raeburn  12745:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   12746:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   12747:     }
                   12748: 
1.1055    raeburn  12749:     $scripttag .= <<END;
                   12750: 
                   12751: function containerCheck(form,count,offset) {
                   12752:     if (count > 0) {
1.1056    raeburn  12753:         dependencyCheck(form,count,offset);
1.1059    raeburn  12754:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  12755:         form.elements[item].checked = true;
                   12756:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12757:             if (parents[count].length > 0) {
                   12758:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  12759:                     containerCheck(form,parents[count][j],offset);
                   12760:                 }
                   12761:             }
                   12762:         }
                   12763:     }
                   12764: }
                   12765: 
                   12766: function dependencyCheck(form,count,offset) {
                   12767:     if (count > 0) {
1.1059    raeburn  12768:         var chosen = (offset+$startcount)+7*(count-1);
                   12769:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  12770:         var currtype = form.elements[depitem].type;
                   12771:         if (form.elements[chosen].value == 'dependency') {
                   12772:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   12773:             form.elements[depitem].options.length = 0;
                   12774:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11  raeburn  12775:             for (var i=1; i<=numitems; i++) {
                   12776:                 if (i == count) {
                   12777:                     continue;
                   12778:                 }
1.1059    raeburn  12779:                 var startelement = $startcount + (i-1) * 7;
                   12780:                 for (var j=1; j<6; j++) {
                   12781:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  12782:                         var item = startelement + j;
                   12783:                         if (form.elements[item].type == 'radio') {
                   12784:                             if (form.elements[item].checked) {
                   12785:                                 if (form.elements[item].value == 'display') {
                   12786:                                     var n = form.elements[depitem].options.length;
                   12787:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   12788:                                 }
                   12789:                             }
                   12790:                         }
                   12791:                     }
                   12792:                 }
                   12793:             }
                   12794:         } else {
                   12795:             document.getElementById('arc_depon_'+count).style.display='none';
                   12796:             form.elements[depitem].options.length = 0;
                   12797:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   12798:         }
1.1059    raeburn  12799:         titleCheck(form,count,offset);
1.1056    raeburn  12800:     }
                   12801: }
                   12802: 
                   12803: function propagateSelect(form,count,offset) {
                   12804:     if (count > 0) {
1.1065    raeburn  12805:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  12806:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   12807:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12808:             if (parents[count].length > 0) {
                   12809:                 for (var j=0; j<parents[count].length; j++) {
                   12810:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  12811:                 }
                   12812:             }
                   12813:         }
                   12814:     }
                   12815: }
1.1056    raeburn  12816: 
                   12817: function containerSelect(form,count,offset,picked) {
                   12818:     if (count > 0) {
1.1065    raeburn  12819:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  12820:         if (form.elements[item].type == 'radio') {
                   12821:             if (form.elements[item].value == 'dependency') {
                   12822:                 if (form.elements[item+1].type == 'select-one') {
                   12823:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   12824:                         if (form.elements[item+1].options[i].value == picked) {
                   12825:                             form.elements[item+1].selectedIndex = i;
                   12826:                             break;
                   12827:                         }
                   12828:                     }
                   12829:                 }
                   12830:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12831:                     if (parents[count].length > 0) {
                   12832:                         for (var j=0; j<parents[count].length; j++) {
                   12833:                             containerSelect(form,parents[count][j],offset,picked);
                   12834:                         }
                   12835:                     }
                   12836:                 }
                   12837:             }
                   12838:         }
                   12839:     }
                   12840: }
                   12841: 
1.1059    raeburn  12842: function titleCheck(form,count,offset) {
                   12843:     if (count > 0) {
                   12844:         var chosen = (offset+$startcount)+7*(count-1);
                   12845:         var depitem = $startcount + ((count-1) * 7) + 2;
                   12846:         var currtype = form.elements[depitem].type;
                   12847:         if (form.elements[chosen].value == 'display') {
                   12848:             document.getElementById('arc_title_'+count).style.display='block';
                   12849:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   12850:                 document.getElementById('archive_title_'+count).value=maintitle;
                   12851:             }
                   12852:         } else {
                   12853:             document.getElementById('arc_title_'+count).style.display='none';
                   12854:             if (currtype == 'text') { 
                   12855:                 document.getElementById('archive_title_'+count).value='';
                   12856:             }
                   12857:         }
                   12858:     }
                   12859:     return;
                   12860: }
                   12861: 
1.1055    raeburn  12862: // ]]>
                   12863: </script>
                   12864: END
                   12865:     return $scripttag;
                   12866: }
                   12867: 
                   12868: sub process_extracted_files {
1.1067    raeburn  12869:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  12870:     my $numitems = $env{'form.archive_count'};
1.1075.2.128  raeburn  12871:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  12872:     my @ids=&Apache::lonnet::current_machine_ids();
                   12873:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  12874:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  12875:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12876:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12877:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   12878:         $pathtocheck = "$dir_root/$destination";
                   12879:         $dir = $dir_root;
                   12880:         $ishome = 1;
                   12881:     } else {
                   12882:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   12883:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1075.2.128  raeburn  12884:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  12885:     }
                   12886:     my $currdir = "$dir_root/$destination";
                   12887:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   12888:     if ($env{'form.folderpath'}) {
                   12889:         my @items = split('&',$env{'form.folderpath'});
                   12890:         $folders{'0'} = $items[-2];
1.1075.2.17  raeburn  12891:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   12892:             $containers{'0'}='page';
                   12893:         } else {
                   12894:             $containers{'0'}='sequence';
                   12895:         }
1.1055    raeburn  12896:     }
                   12897:     my @archdirs = &get_env_multiple('form.archive_directory');
                   12898:     if ($numitems) {
                   12899:         for (my $i=1; $i<=$numitems; $i++) {
                   12900:             my $path = $env{'form.archive_content_'.$i};
                   12901:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   12902:                 my $item = $1;
                   12903:                 $toplevelitems{$item} = $i;
                   12904:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   12905:                     $is_dir{$item} = 1;
                   12906:                 }
                   12907:             }
                   12908:         }
                   12909:     }
1.1067    raeburn  12910:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  12911:     if (keys(%toplevelitems) > 0) {
                   12912:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  12913:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   12914:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  12915:     }
1.1066    raeburn  12916:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  12917:     if ($numitems) {
                   12918:         for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11  raeburn  12919:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  12920:             my $path = $env{'form.archive_content_'.$i};
                   12921:             if ($path =~ /^\Q$pathtocheck\E/) {
                   12922:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   12923:                     if ($prefix ne '' && $path ne '') {
                   12924:                         if (-e $prefix.$path) {
1.1066    raeburn  12925:                             if ((@archdirs > 0) && 
                   12926:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   12927:                                 $todeletedir{$prefix.$path} = 1;
                   12928:                             } else {
                   12929:                                 $todelete{$prefix.$path} = 1;
                   12930:                             }
1.1055    raeburn  12931:                         }
                   12932:                     }
                   12933:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  12934:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  12935:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  12936:                     $docstitle = $env{'form.archive_title_'.$i};
                   12937:                     if ($docstitle eq '') {
                   12938:                         $docstitle = $title;
                   12939:                     }
1.1055    raeburn  12940:                     $outer = 0;
1.1056    raeburn  12941:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   12942:                         if (@{$dirorder{$i}} > 0) {
                   12943:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  12944:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   12945:                                     $outer = $item;
                   12946:                                     last;
                   12947:                                 }
                   12948:                             }
                   12949:                         }
                   12950:                     }
                   12951:                     my ($errtext,$fatal) = 
                   12952:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   12953:                                                '/'.$folders{$outer}.'.'.
                   12954:                                                $containers{$outer});
                   12955:                     next if ($fatal);
                   12956:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   12957:                         if ($context eq 'coursedocs') {
1.1056    raeburn  12958:                             $mapinner{$i} = time;
1.1055    raeburn  12959:                             $folders{$i} = 'default_'.$mapinner{$i};
                   12960:                             $containers{$i} = 'sequence';
                   12961:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   12962:                                       $folders{$i}.'.'.$containers{$i};
                   12963:                             my $newidx = &LONCAPA::map::getresidx();
                   12964:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  12965:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  12966:                             push(@LONCAPA::map::order,$newidx);
                   12967:                             my ($outtext,$errtext) =
                   12968:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   12969:                                                         $docuname.'/'.$folders{$outer}.
1.1075.2.11  raeburn  12970:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  12971:                             $newseqid{$i} = $newidx;
1.1067    raeburn  12972:                             unless ($errtext) {
1.1075.2.128  raeburn  12973:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   12974:                                                        &HTML::Entities::encode($docstitle,'<>&"'))..
                   12975:                                             '</li>'."\n";
1.1067    raeburn  12976:                             }
1.1055    raeburn  12977:                         }
                   12978:                     } else {
                   12979:                         if ($context eq 'coursedocs') {
                   12980:                             my $newidx=&LONCAPA::map::getresidx();
                   12981:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   12982:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   12983:                                       $title;
1.1075.2.128  raeburn  12984:                             if (($outer !~ /\D/) && ($mapinner{$outer} !~ /\D/) && ($newidx !~ /\D/)) {
                   12985:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   12986:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
1.1067    raeburn  12987:                                 }
1.1075.2.128  raeburn  12988:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   12989:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   12990:                                 }
                   12991:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   12992:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   12993:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   12994:                                         unless ($ishome) {
                   12995:                                             my $fetch = "$newdest{$i}/$title";
                   12996:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   12997:                                             $prompttofetch{$fetch} = 1;
                   12998:                                         }
                   12999:                                    }
                   13000:                                 }
                   13001:                                 $LONCAPA::map::resources[$newidx]=
                   13002:                                     $docstitle.':'.$url.':false:normal:res';
                   13003:                                 push(@LONCAPA::map::order, $newidx);
                   13004:                                 my ($outtext,$errtext)=
                   13005:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13006:                                                             $docuname.'/'.$folders{$outer}.
                   13007:                                                             '.'.$containers{$outer},1,1);
                   13008:                                 unless ($errtext) {
                   13009:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   13010:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   13011:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   13012:                                                    '</li>'."\n";
                   13013:                                     }
1.1067    raeburn  13014:                                 }
1.1075.2.128  raeburn  13015:                             } else {
                   13016:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13017:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1067    raeburn  13018:                             }
1.1055    raeburn  13019:                         }
                   13020:                     }
1.1075.2.11  raeburn  13021:                 }
                   13022:             } else {
1.1075.2.128  raeburn  13023:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13024:                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1075.2.11  raeburn  13025:             }
                   13026:         }
                   13027:         for (my $i=1; $i<=$numitems; $i++) {
                   13028:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   13029:             my $path = $env{'form.archive_content_'.$i};
                   13030:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13031:                 my ($title) = ($path =~ m{/([^/]+)$});
                   13032:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   13033:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   13034:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13035:                         my ($itemidx,$fullpath,$relpath);
                   13036:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   13037:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  13038:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11  raeburn  13039:                                 if ($dirorder{$i}->[$j] eq $container) {
                   13040:                                     $itemidx = $j;
1.1056    raeburn  13041:                                 }
                   13042:                             }
1.1075.2.11  raeburn  13043:                         }
                   13044:                         if ($itemidx eq '') {
                   13045:                             $itemidx =  0;
                   13046:                         }
                   13047:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   13048:                             if ($mapinner{$referrer{$i}}) {
                   13049:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   13050:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13051:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13052:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13053:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13054:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13055:                                             if (!-e $fullpath) {
                   13056:                                                 mkdir($fullpath,0755);
1.1056    raeburn  13057:                                             }
                   13058:                                         }
1.1075.2.11  raeburn  13059:                                     } else {
                   13060:                                         last;
1.1056    raeburn  13061:                                     }
1.1075.2.11  raeburn  13062:                                 }
                   13063:                             }
                   13064:                         } elsif ($newdest{$referrer{$i}}) {
                   13065:                             $fullpath = $newdest{$referrer{$i}};
                   13066:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13067:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   13068:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   13069:                                     last;
                   13070:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13071:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13072:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13073:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13074:                                         if (!-e $fullpath) {
                   13075:                                             mkdir($fullpath,0755);
1.1056    raeburn  13076:                                         }
                   13077:                                     }
1.1075.2.11  raeburn  13078:                                 } else {
                   13079:                                     last;
1.1056    raeburn  13080:                                 }
1.1075.2.11  raeburn  13081:                             }
                   13082:                         }
                   13083:                         if ($fullpath ne '') {
                   13084:                             if (-e "$prefix$path") {
1.1075.2.128  raeburn  13085:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   13086:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   13087:                                 }
1.1075.2.11  raeburn  13088:                             }
                   13089:                             if (-e "$fullpath/$title") {
                   13090:                                 my $showpath;
                   13091:                                 if ($relpath ne '') {
                   13092:                                     $showpath = "$relpath/$title";
                   13093:                                 } else {
                   13094:                                     $showpath = "/$title";
1.1056    raeburn  13095:                                 }
1.1075.2.128  raeburn  13096:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   13097:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   13098:                                            '</li>'."\n";
                   13099:                                 unless ($ishome) {
                   13100:                                     my $fetch = "$fullpath/$title";
                   13101:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   13102:                                     $prompttofetch{$fetch} = 1;
                   13103:                                 }
1.1055    raeburn  13104:                             }
                   13105:                         }
                   13106:                     }
1.1075.2.11  raeburn  13107:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   13108:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1075.2.128  raeburn  13109:                                     &HTML::Entities::encode($path,'<>&"'),
                   13110:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   13111:                                 '<br />';
1.1055    raeburn  13112:                 }
                   13113:             } else {
1.1075.2.128  raeburn  13114:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13115:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  13116:             }
                   13117:         }
                   13118:         if (keys(%todelete)) {
                   13119:             foreach my $key (keys(%todelete)) {
                   13120:                 unlink($key);
1.1066    raeburn  13121:             }
                   13122:         }
                   13123:         if (keys(%todeletedir)) {
                   13124:             foreach my $key (keys(%todeletedir)) {
                   13125:                 rmdir($key);
                   13126:             }
                   13127:         }
                   13128:         foreach my $dir (sort(keys(%is_dir))) {
                   13129:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   13130:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  13131:             }
                   13132:         }
1.1067    raeburn  13133:         if ($result ne '') {
                   13134:             $output .= '<ul>'."\n".
                   13135:                        $result."\n".
                   13136:                        '</ul>';
                   13137:         }
                   13138:         unless ($ishome) {
                   13139:             my $replicationfail;
                   13140:             foreach my $item (keys(%prompttofetch)) {
                   13141:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   13142:                 unless ($fetchresult eq 'ok') {
                   13143:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   13144:                 }
                   13145:             }
                   13146:             if ($replicationfail) {
                   13147:                 $output .= '<p class="LC_error">'.
                   13148:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   13149:                            $replicationfail.
                   13150:                            '</ul></p>';
                   13151:             }
                   13152:         }
1.1055    raeburn  13153:     } else {
                   13154:         $warning = &mt('No items found in archive.');
                   13155:     }
                   13156:     if ($error) {
                   13157:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   13158:                    $error.'</p>'."\n";
                   13159:     }
                   13160:     if ($warning) {
                   13161:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   13162:     }
                   13163:     return $output;
                   13164: }
                   13165: 
1.1066    raeburn  13166: sub cleanup_empty_dirs {
                   13167:     my ($path) = @_;
                   13168:     if (($path ne '') && (-d $path)) {
                   13169:         if (opendir(my $dirh,$path)) {
                   13170:             my @dircontents = grep(!/^\./,readdir($dirh));
                   13171:             my $numitems = 0;
                   13172:             foreach my $item (@dircontents) {
                   13173:                 if (-d "$path/$item") {
1.1075.2.28  raeburn  13174:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  13175:                     if (-e "$path/$item") {
                   13176:                         $numitems ++;
                   13177:                     }
                   13178:                 } else {
                   13179:                     $numitems ++;
                   13180:                 }
                   13181:             }
                   13182:             if ($numitems == 0) {
                   13183:                 rmdir($path);
                   13184:             }
                   13185:             closedir($dirh);
                   13186:         }
                   13187:     }
                   13188:     return;
                   13189: }
                   13190: 
1.41      ng       13191: =pod
1.45      matthew  13192: 
1.1075.2.56  raeburn  13193: =item * &get_folder_hierarchy()
1.1068    raeburn  13194: 
                   13195: Provides hierarchy of names of folders/sub-folders containing the current
                   13196: item,
                   13197: 
                   13198: Inputs: 3
                   13199:      - $navmap - navmaps object
                   13200: 
                   13201:      - $map - url for map (either the trigger itself, or map containing
                   13202:                            the resource, which is the trigger).
                   13203: 
                   13204:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   13205: 
                   13206: Outputs: 1 @pathitems - array of folder/subfolder names.
                   13207: 
                   13208: =cut
                   13209: 
                   13210: sub get_folder_hierarchy {
                   13211:     my ($navmap,$map,$showitem) = @_;
                   13212:     my @pathitems;
                   13213:     if (ref($navmap)) {
                   13214:         my $mapres = $navmap->getResourceByUrl($map);
                   13215:         if (ref($mapres)) {
                   13216:             my $pcslist = $mapres->map_hierarchy();
                   13217:             if ($pcslist ne '') {
                   13218:                 my @pcs = split(/,/,$pcslist);
                   13219:                 foreach my $pc (@pcs) {
                   13220:                     if ($pc == 1) {
1.1075.2.38  raeburn  13221:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  13222:                     } else {
                   13223:                         my $res = $navmap->getByMapPc($pc);
                   13224:                         if (ref($res)) {
                   13225:                             my $title = $res->compTitle();
                   13226:                             $title =~ s/\W+/_/g;
                   13227:                             if ($title ne '') {
                   13228:                                 push(@pathitems,$title);
                   13229:                             }
                   13230:                         }
                   13231:                     }
                   13232:                 }
                   13233:             }
1.1071    raeburn  13234:             if ($showitem) {
                   13235:                 if ($mapres->{ID} eq '0.0') {
1.1075.2.38  raeburn  13236:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  13237:                 } else {
                   13238:                     my $maptitle = $mapres->compTitle();
                   13239:                     $maptitle =~ s/\W+/_/g;
                   13240:                     if ($maptitle ne '') {
                   13241:                         push(@pathitems,$maptitle);
                   13242:                     }
1.1068    raeburn  13243:                 }
                   13244:             }
                   13245:         }
                   13246:     }
                   13247:     return @pathitems;
                   13248: }
                   13249: 
                   13250: =pod
                   13251: 
1.1015    raeburn  13252: =item * &get_turnedin_filepath()
                   13253: 
                   13254: Determines path in a user's portfolio file for storage of files uploaded
                   13255: to a specific essayresponse or dropbox item.
                   13256: 
                   13257: Inputs: 3 required + 1 optional.
                   13258: $symb is symb for resource, $uname and $udom are for current user (required).
                   13259: $caller is optional (can be "submission", if routine is called when storing
                   13260: an upoaded file when "Submit Answer" button was pressed).
                   13261: 
                   13262: Returns array containing $path and $multiresp. 
                   13263: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   13264: than one file upload item.  Callers of routine should append partid as a 
                   13265: subdirectory to $path in cases where $multiresp is 1.
                   13266: 
                   13267: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   13268: 
                   13269: =cut
                   13270: 
                   13271: sub get_turnedin_filepath {
                   13272:     my ($symb,$uname,$udom,$caller) = @_;
                   13273:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   13274:     my $turnindir;
                   13275:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   13276:     $turnindir = $userhash{'turnindir'};
                   13277:     my ($path,$multiresp);
                   13278:     if ($turnindir eq '') {
                   13279:         if ($caller eq 'submission') {
                   13280:             $turnindir = &mt('turned in');
                   13281:             $turnindir =~ s/\W+/_/g;
                   13282:             my %newhash = (
                   13283:                             'turnindir' => $turnindir,
                   13284:                           );
                   13285:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   13286:         }
                   13287:     }
                   13288:     if ($turnindir ne '') {
                   13289:         $path = '/'.$turnindir.'/';
                   13290:         my ($multipart,$turnin,@pathitems);
                   13291:         my $navmap = Apache::lonnavmaps::navmap->new();
                   13292:         if (defined($navmap)) {
                   13293:             my $mapres = $navmap->getResourceByUrl($map);
                   13294:             if (ref($mapres)) {
                   13295:                 my $pcslist = $mapres->map_hierarchy();
                   13296:                 if ($pcslist ne '') {
                   13297:                     foreach my $pc (split(/,/,$pcslist)) {
                   13298:                         my $res = $navmap->getByMapPc($pc);
                   13299:                         if (ref($res)) {
                   13300:                             my $title = $res->compTitle();
                   13301:                             $title =~ s/\W+/_/g;
                   13302:                             if ($title ne '') {
1.1075.2.48  raeburn  13303:                                 if (($pc > 1) && (length($title) > 12)) {
                   13304:                                     $title = substr($title,0,12);
                   13305:                                 }
1.1015    raeburn  13306:                                 push(@pathitems,$title);
                   13307:                             }
                   13308:                         }
                   13309:                     }
                   13310:                 }
                   13311:                 my $maptitle = $mapres->compTitle();
                   13312:                 $maptitle =~ s/\W+/_/g;
                   13313:                 if ($maptitle ne '') {
1.1075.2.48  raeburn  13314:                     if (length($maptitle) > 12) {
                   13315:                         $maptitle = substr($maptitle,0,12);
                   13316:                     }
1.1015    raeburn  13317:                     push(@pathitems,$maptitle);
                   13318:                 }
                   13319:                 unless ($env{'request.state'} eq 'construct') {
                   13320:                     my $res = $navmap->getBySymb($symb);
                   13321:                     if (ref($res)) {
                   13322:                         my $partlist = $res->parts();
                   13323:                         my $totaluploads = 0;
                   13324:                         if (ref($partlist) eq 'ARRAY') {
                   13325:                             foreach my $part (@{$partlist}) {
                   13326:                                 my @types = $res->responseType($part);
                   13327:                                 my @ids = $res->responseIds($part);
                   13328:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   13329:                                     if ($types[$i] eq 'essay') {
                   13330:                                         my $partid = $part.'_'.$ids[$i];
                   13331:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   13332:                                             $totaluploads ++;
                   13333:                                         }
                   13334:                                     }
                   13335:                                 }
                   13336:                             }
                   13337:                             if ($totaluploads > 1) {
                   13338:                                 $multiresp = 1;
                   13339:                             }
                   13340:                         }
                   13341:                     }
                   13342:                 }
                   13343:             } else {
                   13344:                 return;
                   13345:             }
                   13346:         } else {
                   13347:             return;
                   13348:         }
                   13349:         my $restitle=&Apache::lonnet::gettitle($symb);
                   13350:         $restitle =~ s/\W+/_/g;
                   13351:         if ($restitle eq '') {
                   13352:             $restitle = ($resurl =~ m{/[^/]+$});
                   13353:             if ($restitle eq '') {
                   13354:                 $restitle = time;
                   13355:             }
                   13356:         }
1.1075.2.48  raeburn  13357:         if (length($restitle) > 12) {
                   13358:             $restitle = substr($restitle,0,12);
                   13359:         }
1.1015    raeburn  13360:         push(@pathitems,$restitle);
                   13361:         $path .= join('/',@pathitems);
                   13362:     }
                   13363:     return ($path,$multiresp);
                   13364: }
                   13365: 
                   13366: =pod
                   13367: 
1.464     albertel 13368: =back
1.41      ng       13369: 
1.112     bowersj2 13370: =head1 CSV Upload/Handling functions
1.38      albertel 13371: 
1.41      ng       13372: =over 4
                   13373: 
1.648     raeburn  13374: =item * &upfile_store($r)
1.41      ng       13375: 
                   13376: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 13377: needs $env{'form.upfile'}
1.41      ng       13378: returns $datatoken to be put into hidden field
                   13379: 
                   13380: =cut
1.31      albertel 13381: 
                   13382: sub upfile_store {
                   13383:     my $r=shift;
1.258     albertel 13384:     $env{'form.upfile'}=~s/\r/\n/gs;
                   13385:     $env{'form.upfile'}=~s/\f/\n/gs;
                   13386:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   13387:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 13388: 
1.1075.2.128  raeburn  13389:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   13390:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   13391:                                      time.'_'.$$);
                   13392:     return if ($datatoken eq '');
                   13393: 
1.31      albertel 13394:     {
1.158     raeburn  13395:         my $datafile = $r->dir_config('lonDaemons').
                   13396:                            '/tmp/'.$datatoken.'.tmp';
1.1075.2.128  raeburn  13397:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 13398:             print $fh $env{'form.upfile'};
1.158     raeburn  13399:             close($fh);
                   13400:         }
1.31      albertel 13401:     }
                   13402:     return $datatoken;
                   13403: }
                   13404: 
1.56      matthew  13405: =pod
                   13406: 
1.1075.2.128  raeburn  13407: =item * &load_tmp_file($r,$datatoken)
1.41      ng       13408: 
                   13409: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1075.2.128  raeburn  13410: $datatoken is the name to assign to the temporary file.
1.258     albertel 13411: sets $env{'form.upfile'} to the contents of the file
1.41      ng       13412: 
                   13413: =cut
1.31      albertel 13414: 
                   13415: sub load_tmp_file {
1.1075.2.128  raeburn  13416:     my ($r,$datatoken) = @_;
                   13417:     return if ($datatoken eq '');
1.31      albertel 13418:     my @studentdata=();
                   13419:     {
1.158     raeburn  13420:         my $studentfile = $r->dir_config('lonDaemons').
1.1075.2.128  raeburn  13421:                               '/tmp/'.$datatoken.'.tmp';
                   13422:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  13423:             @studentdata=<$fh>;
                   13424:             close($fh);
                   13425:         }
1.31      albertel 13426:     }
1.258     albertel 13427:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 13428: }
                   13429: 
1.1075.2.128  raeburn  13430: sub valid_datatoken {
                   13431:     my ($datatoken) = @_;
1.1075.2.131  raeburn  13432:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1075.2.128  raeburn  13433:         return $datatoken;
                   13434:     }
                   13435:     return;
                   13436: }
                   13437: 
1.56      matthew  13438: =pod
                   13439: 
1.648     raeburn  13440: =item * &upfile_record_sep()
1.41      ng       13441: 
                   13442: Separate uploaded file into records
                   13443: returns array of records,
1.258     albertel 13444: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       13445: 
                   13446: =cut
1.31      albertel 13447: 
                   13448: sub upfile_record_sep {
1.258     albertel 13449:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 13450:     } else {
1.248     albertel 13451: 	my @records;
1.258     albertel 13452: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 13453: 	    if ($line=~/^\s*$/) { next; }
                   13454: 	    push(@records,$line);
                   13455: 	}
                   13456: 	return @records;
1.31      albertel 13457:     }
                   13458: }
                   13459: 
1.56      matthew  13460: =pod
                   13461: 
1.648     raeburn  13462: =item * &record_sep($record)
1.41      ng       13463: 
1.258     albertel 13464: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       13465: 
                   13466: =cut
                   13467: 
1.263     www      13468: sub takeleft {
                   13469:     my $index=shift;
                   13470:     return substr('0000'.$index,-4,4);
                   13471: }
                   13472: 
1.31      albertel 13473: sub record_sep {
                   13474:     my $record=shift;
                   13475:     my %components=();
1.258     albertel 13476:     if ($env{'form.upfiletype'} eq 'xml') {
                   13477:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 13478:         my $i=0;
1.356     albertel 13479:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 13480:             $field=~s/^(\"|\')//;
                   13481:             $field=~s/(\"|\')$//;
1.263     www      13482:             $components{&takeleft($i)}=$field;
1.31      albertel 13483:             $i++;
                   13484:         }
1.258     albertel 13485:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 13486:         my $i=0;
1.356     albertel 13487:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 13488:             $field=~s/^(\"|\')//;
                   13489:             $field=~s/(\"|\')$//;
1.263     www      13490:             $components{&takeleft($i)}=$field;
1.31      albertel 13491:             $i++;
                   13492:         }
                   13493:     } else {
1.561     www      13494:         my $separator=',';
1.480     banghart 13495:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      13496:             $separator=';';
1.480     banghart 13497:         }
1.31      albertel 13498:         my $i=0;
1.561     www      13499: # the character we are looking for to indicate the end of a quote or a record 
                   13500:         my $looking_for=$separator;
                   13501: # do not add the characters to the fields
                   13502:         my $ignore=0;
                   13503: # we just encountered a separator (or the beginning of the record)
                   13504:         my $just_found_separator=1;
                   13505: # store the field we are working on here
                   13506:         my $field='';
                   13507: # work our way through all characters in record
                   13508:         foreach my $character ($record=~/(.)/g) {
                   13509:             if ($character eq $looking_for) {
                   13510:                if ($character ne $separator) {
                   13511: # Found the end of a quote, again looking for separator
                   13512:                   $looking_for=$separator;
                   13513:                   $ignore=1;
                   13514:                } else {
                   13515: # Found a separator, store away what we got
                   13516:                   $components{&takeleft($i)}=$field;
                   13517: 	          $i++;
                   13518:                   $just_found_separator=1;
                   13519:                   $ignore=0;
                   13520:                   $field='';
                   13521:                }
                   13522:                next;
                   13523:             }
                   13524: # single or double quotation marks after a separator indicate beginning of a quote
                   13525: # we are now looking for the end of the quote and need to ignore separators
                   13526:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   13527:                $looking_for=$character;
                   13528:                next;
                   13529:             }
                   13530: # ignore would be true after we reached the end of a quote
                   13531:             if ($ignore) { next; }
                   13532:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   13533:             $field.=$character;
                   13534:             $just_found_separator=0; 
1.31      albertel 13535:         }
1.561     www      13536: # catch the very last entry, since we never encountered the separator
                   13537:         $components{&takeleft($i)}=$field;
1.31      albertel 13538:     }
                   13539:     return %components;
                   13540: }
                   13541: 
1.144     matthew  13542: ######################################################
                   13543: ######################################################
                   13544: 
1.56      matthew  13545: =pod
                   13546: 
1.648     raeburn  13547: =item * &upfile_select_html()
1.41      ng       13548: 
1.144     matthew  13549: Return HTML code to select a file from the users machine and specify 
                   13550: the file type.
1.41      ng       13551: 
                   13552: =cut
                   13553: 
1.144     matthew  13554: ######################################################
                   13555: ######################################################
1.31      albertel 13556: sub upfile_select_html {
1.144     matthew  13557:     my %Types = (
                   13558:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 13559:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  13560:                  space => &mt('Space separated'),
                   13561:                  tab   => &mt('Tabulator separated'),
                   13562: #                 xml   => &mt('HTML/XML'),
                   13563:                  );
                   13564:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  13565:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  13566:     foreach my $type (sort(keys(%Types))) {
                   13567:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   13568:     }
                   13569:     $Str .= "</select>\n";
                   13570:     return $Str;
1.31      albertel 13571: }
                   13572: 
1.301     albertel 13573: sub get_samples {
                   13574:     my ($records,$toget) = @_;
                   13575:     my @samples=({});
                   13576:     my $got=0;
                   13577:     foreach my $rec (@$records) {
                   13578: 	my %temp = &record_sep($rec);
                   13579: 	if (! grep(/\S/, values(%temp))) { next; }
                   13580: 	if (%temp) {
                   13581: 	    $samples[$got]=\%temp;
                   13582: 	    $got++;
                   13583: 	    if ($got == $toget) { last; }
                   13584: 	}
                   13585:     }
                   13586:     return \@samples;
                   13587: }
                   13588: 
1.144     matthew  13589: ######################################################
                   13590: ######################################################
                   13591: 
1.56      matthew  13592: =pod
                   13593: 
1.648     raeburn  13594: =item * &csv_print_samples($r,$records)
1.41      ng       13595: 
                   13596: Prints a table of sample values from each column uploaded $r is an
                   13597: Apache Request ref, $records is an arrayref from
                   13598: &Apache::loncommon::upfile_record_sep
                   13599: 
                   13600: =cut
                   13601: 
1.144     matthew  13602: ######################################################
                   13603: ######################################################
1.31      albertel 13604: sub csv_print_samples {
                   13605:     my ($r,$records) = @_;
1.662     bisitz   13606:     my $samples = &get_samples($records,5);
1.301     albertel 13607: 
1.594     raeburn  13608:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   13609:               &start_data_table_header_row());
1.356     albertel 13610:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   13611:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  13612:     $r->print(&end_data_table_header_row());
1.301     albertel 13613:     foreach my $hash (@$samples) {
1.594     raeburn  13614: 	$r->print(&start_data_table_row());
1.356     albertel 13615: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 13616: 	    $r->print('<td>');
1.356     albertel 13617: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 13618: 	    $r->print('</td>');
                   13619: 	}
1.594     raeburn  13620: 	$r->print(&end_data_table_row());
1.31      albertel 13621:     }
1.594     raeburn  13622:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 13623: }
                   13624: 
1.144     matthew  13625: ######################################################
                   13626: ######################################################
                   13627: 
1.56      matthew  13628: =pod
                   13629: 
1.648     raeburn  13630: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       13631: 
                   13632: Prints a table to create associations between values and table columns.
1.144     matthew  13633: 
1.41      ng       13634: $r is an Apache Request ref,
                   13635: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  13636: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       13637: 
                   13638: =cut
                   13639: 
1.144     matthew  13640: ######################################################
                   13641: ######################################################
1.31      albertel 13642: sub csv_print_select_table {
                   13643:     my ($r,$records,$d) = @_;
1.301     albertel 13644:     my $i=0;
                   13645:     my $samples = &get_samples($records,1);
1.144     matthew  13646:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  13647: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  13648:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  13649:               '<th>'.&mt('Column').'</th>'.
                   13650:               &end_data_table_header_row()."\n");
1.356     albertel 13651:     foreach my $array_ref (@$d) {
                   13652: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  13653: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 13654: 
1.875     bisitz   13655: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  13656: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 13657: 	$r->print('<option value="none"></option>');
1.356     albertel 13658: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   13659: 	    $r->print('<option value="'.$sample.'"'.
                   13660:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   13661:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 13662: 	}
1.594     raeburn  13663: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 13664: 	$i++;
                   13665:     }
1.594     raeburn  13666:     $r->print(&end_data_table());
1.31      albertel 13667:     $i--;
                   13668:     return $i;
                   13669: }
1.56      matthew  13670: 
1.144     matthew  13671: ######################################################
                   13672: ######################################################
                   13673: 
1.56      matthew  13674: =pod
1.31      albertel 13675: 
1.648     raeburn  13676: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       13677: 
                   13678: Prints a table of sample values from the upload and can make associate samples to internal names.
                   13679: 
                   13680: $r is an Apache Request ref,
                   13681: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   13682: $d is an array of 2 element arrays (internal name, displayed name)
                   13683: 
                   13684: =cut
                   13685: 
1.144     matthew  13686: ######################################################
                   13687: ######################################################
1.31      albertel 13688: sub csv_samples_select_table {
                   13689:     my ($r,$records,$d) = @_;
                   13690:     my $i=0;
1.144     matthew  13691:     #
1.662     bisitz   13692:     my $max_samples = 5;
                   13693:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  13694:     $r->print(&start_data_table().
                   13695:               &start_data_table_header_row().'<th>'.
                   13696:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   13697:               &end_data_table_header_row());
1.301     albertel 13698: 
                   13699:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  13700: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  13701: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 13702: 	foreach my $option (@$d) {
                   13703: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  13704: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 13705:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  13706:                       $display.'</option>');
1.31      albertel 13707: 	}
                   13708: 	$r->print('</select></td><td>');
1.662     bisitz   13709: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 13710: 	    if (defined($samples->[$line]{$key})) { 
                   13711: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   13712: 	    }
                   13713: 	}
1.594     raeburn  13714: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 13715: 	$i++;
                   13716:     }
1.594     raeburn  13717:     $r->print(&end_data_table());
1.31      albertel 13718:     $i--;
                   13719:     return($i);
1.115     matthew  13720: }
                   13721: 
1.144     matthew  13722: ######################################################
                   13723: ######################################################
                   13724: 
1.115     matthew  13725: =pod
                   13726: 
1.648     raeburn  13727: =item * &clean_excel_name($name)
1.115     matthew  13728: 
                   13729: Returns a replacement for $name which does not contain any illegal characters.
                   13730: 
                   13731: =cut
                   13732: 
1.144     matthew  13733: ######################################################
                   13734: ######################################################
1.115     matthew  13735: sub clean_excel_name {
                   13736:     my ($name) = @_;
                   13737:     $name =~ s/[:\*\?\/\\]//g;
                   13738:     if (length($name) > 31) {
                   13739:         $name = substr($name,0,31);
                   13740:     }
                   13741:     return $name;
1.25      albertel 13742: }
1.84      albertel 13743: 
1.85      albertel 13744: =pod
                   13745: 
1.648     raeburn  13746: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 13747: 
                   13748: Returns either 1 or undef
                   13749: 
                   13750: 1 if the part is to be hidden, undef if it is to be shown
                   13751: 
                   13752: Arguments are:
                   13753: 
                   13754: $id the id of the part to be checked
                   13755: $symb, optional the symb of the resource to check
                   13756: $udom, optional the domain of the user to check for
                   13757: $uname, optional the username of the user to check for
                   13758: 
                   13759: =cut
1.84      albertel 13760: 
                   13761: sub check_if_partid_hidden {
                   13762:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 13763:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 13764: 					 $symb,$udom,$uname);
1.141     albertel 13765:     my $truth=1;
                   13766:     #if the string starts with !, then the list is the list to show not hide
                   13767:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 13768:     my @hiddenlist=split(/,/,$hiddenparts);
                   13769:     foreach my $checkid (@hiddenlist) {
1.141     albertel 13770: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 13771:     }
1.141     albertel 13772:     return !$truth;
1.84      albertel 13773: }
1.127     matthew  13774: 
1.138     matthew  13775: 
                   13776: ############################################################
                   13777: ############################################################
                   13778: 
                   13779: =pod
                   13780: 
1.157     matthew  13781: =back 
                   13782: 
1.138     matthew  13783: =head1 cgi-bin script and graphing routines
                   13784: 
1.157     matthew  13785: =over 4
                   13786: 
1.648     raeburn  13787: =item * &get_cgi_id()
1.138     matthew  13788: 
                   13789: Inputs: none
                   13790: 
                   13791: Returns an id which can be used to pass environment variables
                   13792: to various cgi-bin scripts.  These environment variables will
                   13793: be removed from the users environment after a given time by
                   13794: the routine &Apache::lonnet::transfer_profile_to_env.
                   13795: 
                   13796: =cut
                   13797: 
                   13798: ############################################################
                   13799: ############################################################
1.152     albertel 13800: my $uniq=0;
1.136     matthew  13801: sub get_cgi_id {
1.154     albertel 13802:     $uniq=($uniq+1)%100000;
1.280     albertel 13803:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  13804: }
                   13805: 
1.127     matthew  13806: ############################################################
                   13807: ############################################################
                   13808: 
                   13809: =pod
                   13810: 
1.648     raeburn  13811: =item * &DrawBarGraph()
1.127     matthew  13812: 
1.138     matthew  13813: Facilitates the plotting of data in a (stacked) bar graph.
                   13814: Puts plot definition data into the users environment in order for 
                   13815: graph.png to plot it.  Returns an <img> tag for the plot.
                   13816: The bars on the plot are labeled '1','2',...,'n'.
                   13817: 
                   13818: Inputs:
                   13819: 
                   13820: =over 4
                   13821: 
                   13822: =item $Title: string, the title of the plot
                   13823: 
                   13824: =item $xlabel: string, text describing the X-axis of the plot
                   13825: 
                   13826: =item $ylabel: string, text describing the Y-axis of the plot
                   13827: 
                   13828: =item $Max: scalar, the maximum Y value to use in the plot
                   13829: If $Max is < any data point, the graph will not be rendered.
                   13830: 
1.140     matthew  13831: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  13832: they are plotted.  If undefined, default values will be used.
                   13833: 
1.178     matthew  13834: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   13835: 
1.138     matthew  13836: =item @Values: An array of array references.  Each array reference holds data
                   13837: to be plotted in a stacked bar chart.
                   13838: 
1.239     matthew  13839: =item If the final element of @Values is a hash reference the key/value
                   13840: pairs will be added to the graph definition.
                   13841: 
1.138     matthew  13842: =back
                   13843: 
                   13844: Returns:
                   13845: 
                   13846: An <img> tag which references graph.png and the appropriate identifying
                   13847: information for the plot.
                   13848: 
1.127     matthew  13849: =cut
                   13850: 
                   13851: ############################################################
                   13852: ############################################################
1.134     matthew  13853: sub DrawBarGraph {
1.178     matthew  13854:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  13855:     #
                   13856:     if (! defined($colors)) {
                   13857:         $colors = ['#33ff00', 
                   13858:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   13859:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   13860:                   ]; 
                   13861:     }
1.228     matthew  13862:     my $extra_settings = {};
                   13863:     if (ref($Values[-1]) eq 'HASH') {
                   13864:         $extra_settings = pop(@Values);
                   13865:     }
1.127     matthew  13866:     #
1.136     matthew  13867:     my $identifier = &get_cgi_id();
                   13868:     my $id = 'cgi.'.$identifier;        
1.129     matthew  13869:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  13870:         return '';
                   13871:     }
1.225     matthew  13872:     #
                   13873:     my @Labels;
                   13874:     if (defined($labels)) {
                   13875:         @Labels = @$labels;
                   13876:     } else {
                   13877:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1075.2.119  raeburn  13878:             push(@Labels,$i+1);
1.225     matthew  13879:         }
                   13880:     }
                   13881:     #
1.129     matthew  13882:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  13883:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  13884:     my %ValuesHash;
                   13885:     my $NumSets=1;
                   13886:     foreach my $array (@Values) {
                   13887:         next if (! ref($array));
1.136     matthew  13888:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  13889:             join(',',@$array);
1.129     matthew  13890:     }
1.127     matthew  13891:     #
1.136     matthew  13892:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  13893:     if ($NumBars < 3) {
                   13894:         $width = 120+$NumBars*32;
1.220     matthew  13895:         $xskip = 1;
1.225     matthew  13896:         $bar_width = 30;
                   13897:     } elsif ($NumBars < 5) {
                   13898:         $width = 120+$NumBars*20;
                   13899:         $xskip = 1;
                   13900:         $bar_width = 20;
1.220     matthew  13901:     } elsif ($NumBars < 10) {
1.136     matthew  13902:         $width = 120+$NumBars*15;
                   13903:         $xskip = 1;
                   13904:         $bar_width = 15;
                   13905:     } elsif ($NumBars <= 25) {
                   13906:         $width = 120+$NumBars*11;
                   13907:         $xskip = 5;
                   13908:         $bar_width = 8;
                   13909:     } elsif ($NumBars <= 50) {
                   13910:         $width = 120+$NumBars*8;
                   13911:         $xskip = 5;
                   13912:         $bar_width = 4;
                   13913:     } else {
                   13914:         $width = 120+$NumBars*8;
                   13915:         $xskip = 5;
                   13916:         $bar_width = 4;
                   13917:     }
                   13918:     #
1.137     matthew  13919:     $Max = 1 if ($Max < 1);
                   13920:     if ( int($Max) < $Max ) {
                   13921:         $Max++;
                   13922:         $Max = int($Max);
                   13923:     }
1.127     matthew  13924:     $Title  = '' if (! defined($Title));
                   13925:     $xlabel = '' if (! defined($xlabel));
                   13926:     $ylabel = '' if (! defined($ylabel));
1.369     www      13927:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   13928:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   13929:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  13930:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  13931:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   13932:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   13933:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   13934:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   13935:     $ValuesHash{$id.'.height'}   = $height;
                   13936:     $ValuesHash{$id.'.width'}    = $width;
                   13937:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   13938:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   13939:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  13940:     #
1.228     matthew  13941:     # Deal with other parameters
                   13942:     while (my ($key,$value) = each(%$extra_settings)) {
                   13943:         $ValuesHash{$id.'.'.$key} = $value;
                   13944:     }
                   13945:     #
1.646     raeburn  13946:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  13947:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   13948: }
                   13949: 
                   13950: ############################################################
                   13951: ############################################################
                   13952: 
                   13953: =pod
                   13954: 
1.648     raeburn  13955: =item * &DrawXYGraph()
1.137     matthew  13956: 
1.138     matthew  13957: Facilitates the plotting of data in an XY graph.
                   13958: Puts plot definition data into the users environment in order for 
                   13959: graph.png to plot it.  Returns an <img> tag for the plot.
                   13960: 
                   13961: Inputs:
                   13962: 
                   13963: =over 4
                   13964: 
                   13965: =item $Title: string, the title of the plot
                   13966: 
                   13967: =item $xlabel: string, text describing the X-axis of the plot
                   13968: 
                   13969: =item $ylabel: string, text describing the Y-axis of the plot
                   13970: 
                   13971: =item $Max: scalar, the maximum Y value to use in the plot
                   13972: If $Max is < any data point, the graph will not be rendered.
                   13973: 
                   13974: =item $colors: Array ref containing the hex color codes for the data to be 
                   13975: plotted in.  If undefined, default values will be used.
                   13976: 
                   13977: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   13978: 
                   13979: =item $Ydata: Array ref containing Array refs.  
1.185     www      13980: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  13981: 
                   13982: =item %Values: hash indicating or overriding any default values which are 
                   13983: passed to graph.png.  
                   13984: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   13985: 
                   13986: =back
                   13987: 
                   13988: Returns:
                   13989: 
                   13990: An <img> tag which references graph.png and the appropriate identifying
                   13991: information for the plot.
                   13992: 
1.137     matthew  13993: =cut
                   13994: 
                   13995: ############################################################
                   13996: ############################################################
                   13997: sub DrawXYGraph {
                   13998:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   13999:     #
                   14000:     # Create the identifier for the graph
                   14001:     my $identifier = &get_cgi_id();
                   14002:     my $id = 'cgi.'.$identifier;
                   14003:     #
                   14004:     $Title  = '' if (! defined($Title));
                   14005:     $xlabel = '' if (! defined($xlabel));
                   14006:     $ylabel = '' if (! defined($ylabel));
                   14007:     my %ValuesHash = 
                   14008:         (
1.369     www      14009:          $id.'.title'  => &escape($Title),
                   14010:          $id.'.xlabel' => &escape($xlabel),
                   14011:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  14012:          $id.'.y_max_value'=> $Max,
                   14013:          $id.'.labels'     => join(',',@$Xlabels),
                   14014:          $id.'.PlotType'   => 'XY',
                   14015:          );
                   14016:     #
                   14017:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14018:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14019:     }
                   14020:     #
                   14021:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   14022:         return '';
                   14023:     }
                   14024:     my $NumSets=1;
1.138     matthew  14025:     foreach my $array (@{$Ydata}){
1.137     matthew  14026:         next if (! ref($array));
                   14027:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   14028:     }
1.138     matthew  14029:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  14030:     #
                   14031:     # Deal with other parameters
                   14032:     while (my ($key,$value) = each(%Values)) {
                   14033:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  14034:     }
                   14035:     #
1.646     raeburn  14036:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  14037:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14038: }
                   14039: 
                   14040: ############################################################
                   14041: ############################################################
                   14042: 
                   14043: =pod
                   14044: 
1.648     raeburn  14045: =item * &DrawXYYGraph()
1.138     matthew  14046: 
                   14047: Facilitates the plotting of data in an XY graph with two Y axes.
                   14048: Puts plot definition data into the users environment in order for 
                   14049: graph.png to plot it.  Returns an <img> tag for the plot.
                   14050: 
                   14051: Inputs:
                   14052: 
                   14053: =over 4
                   14054: 
                   14055: =item $Title: string, the title of the plot
                   14056: 
                   14057: =item $xlabel: string, text describing the X-axis of the plot
                   14058: 
                   14059: =item $ylabel: string, text describing the Y-axis of the plot
                   14060: 
                   14061: =item $colors: Array ref containing the hex color codes for the data to be 
                   14062: plotted in.  If undefined, default values will be used.
                   14063: 
                   14064: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14065: 
                   14066: =item $Ydata1: The first data set
                   14067: 
                   14068: =item $Min1: The minimum value of the left Y-axis
                   14069: 
                   14070: =item $Max1: The maximum value of the left Y-axis
                   14071: 
                   14072: =item $Ydata2: The second data set
                   14073: 
                   14074: =item $Min2: The minimum value of the right Y-axis
                   14075: 
                   14076: =item $Max2: The maximum value of the left Y-axis
                   14077: 
                   14078: =item %Values: hash indicating or overriding any default values which are 
                   14079: passed to graph.png.  
                   14080: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14081: 
                   14082: =back
                   14083: 
                   14084: Returns:
                   14085: 
                   14086: An <img> tag which references graph.png and the appropriate identifying
                   14087: information for the plot.
1.136     matthew  14088: 
                   14089: =cut
                   14090: 
                   14091: ############################################################
                   14092: ############################################################
1.137     matthew  14093: sub DrawXYYGraph {
                   14094:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   14095:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  14096:     #
                   14097:     # Create the identifier for the graph
                   14098:     my $identifier = &get_cgi_id();
                   14099:     my $id = 'cgi.'.$identifier;
                   14100:     #
                   14101:     $Title  = '' if (! defined($Title));
                   14102:     $xlabel = '' if (! defined($xlabel));
                   14103:     $ylabel = '' if (! defined($ylabel));
                   14104:     my %ValuesHash = 
                   14105:         (
1.369     www      14106:          $id.'.title'  => &escape($Title),
                   14107:          $id.'.xlabel' => &escape($xlabel),
                   14108:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  14109:          $id.'.labels' => join(',',@$Xlabels),
                   14110:          $id.'.PlotType' => 'XY',
                   14111:          $id.'.NumSets' => 2,
1.137     matthew  14112:          $id.'.two_axes' => 1,
                   14113:          $id.'.y1_max_value' => $Max1,
                   14114:          $id.'.y1_min_value' => $Min1,
                   14115:          $id.'.y2_max_value' => $Max2,
                   14116:          $id.'.y2_min_value' => $Min2,
1.136     matthew  14117:          );
                   14118:     #
1.137     matthew  14119:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14120:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14121:     }
                   14122:     #
                   14123:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   14124:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  14125:         return '';
                   14126:     }
                   14127:     my $NumSets=1;
1.137     matthew  14128:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  14129:         next if (! ref($array));
                   14130:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  14131:     }
                   14132:     #
                   14133:     # Deal with other parameters
                   14134:     while (my ($key,$value) = each(%Values)) {
                   14135:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  14136:     }
                   14137:     #
1.646     raeburn  14138:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 14139:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  14140: }
                   14141: 
                   14142: ############################################################
                   14143: ############################################################
                   14144: 
                   14145: =pod
                   14146: 
1.157     matthew  14147: =back 
                   14148: 
1.139     matthew  14149: =head1 Statistics helper routines?  
                   14150: 
                   14151: Bad place for them but what the hell.
                   14152: 
1.157     matthew  14153: =over 4
                   14154: 
1.648     raeburn  14155: =item * &chartlink()
1.139     matthew  14156: 
                   14157: Returns a link to the chart for a specific student.  
                   14158: 
                   14159: Inputs:
                   14160: 
                   14161: =over 4
                   14162: 
                   14163: =item $linktext: The text of the link
                   14164: 
                   14165: =item $sname: The students username
                   14166: 
                   14167: =item $sdomain: The students domain
                   14168: 
                   14169: =back
                   14170: 
1.157     matthew  14171: =back
                   14172: 
1.139     matthew  14173: =cut
                   14174: 
                   14175: ############################################################
                   14176: ############################################################
                   14177: sub chartlink {
                   14178:     my ($linktext, $sname, $sdomain) = @_;
                   14179:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      14180:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 14181:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  14182:        '">'.$linktext.'</a>';
1.153     matthew  14183: }
                   14184: 
                   14185: #######################################################
                   14186: #######################################################
                   14187: 
                   14188: =pod
                   14189: 
                   14190: =head1 Course Environment Routines
1.157     matthew  14191: 
                   14192: =over 4
1.153     matthew  14193: 
1.648     raeburn  14194: =item * &restore_course_settings()
1.153     matthew  14195: 
1.648     raeburn  14196: =item * &store_course_settings()
1.153     matthew  14197: 
                   14198: Restores/Store indicated form parameters from the course environment.
                   14199: Will not overwrite existing values of the form parameters.
                   14200: 
                   14201: Inputs: 
                   14202: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   14203: 
                   14204: a hash ref describing the data to be stored.  For example:
                   14205:    
                   14206: %Save_Parameters = ('Status' => 'scalar',
                   14207:     'chartoutputmode' => 'scalar',
                   14208:     'chartoutputdata' => 'scalar',
                   14209:     'Section' => 'array',
1.373     raeburn  14210:     'Group' => 'array',
1.153     matthew  14211:     'StudentData' => 'array',
                   14212:     'Maps' => 'array');
                   14213: 
                   14214: Returns: both routines return nothing
                   14215: 
1.631     raeburn  14216: =back
                   14217: 
1.153     matthew  14218: =cut
                   14219: 
                   14220: #######################################################
                   14221: #######################################################
                   14222: sub store_course_settings {
1.496     albertel 14223:     return &store_settings($env{'request.course.id'},@_);
                   14224: }
                   14225: 
                   14226: sub store_settings {
1.153     matthew  14227:     # save to the environment
                   14228:     # appenv the same items, just to be safe
1.300     albertel 14229:     my $udom  = $env{'user.domain'};
                   14230:     my $uname = $env{'user.name'};
1.496     albertel 14231:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14232:     my %SaveHash;
                   14233:     my %AppHash;
                   14234:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 14235:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 14236:         my $envname = 'environment.'.$basename;
1.258     albertel 14237:         if (exists($env{'form.'.$setting})) {
1.153     matthew  14238:             # Save this value away
                   14239:             if ($type eq 'scalar' &&
1.258     albertel 14240:                 (! exists($env{$envname}) || 
                   14241:                  $env{$envname} ne $env{'form.'.$setting})) {
                   14242:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   14243:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  14244:             } elsif ($type eq 'array') {
                   14245:                 my $stored_form;
1.258     albertel 14246:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  14247:                     $stored_form = join(',',
                   14248:                                         map {
1.369     www      14249:                                             &escape($_);
1.258     albertel 14250:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  14251:                 } else {
                   14252:                     $stored_form = 
1.369     www      14253:                         &escape($env{'form.'.$setting});
1.153     matthew  14254:                 }
                   14255:                 # Determine if the array contents are the same.
1.258     albertel 14256:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  14257:                     $SaveHash{$basename} = $stored_form;
                   14258:                     $AppHash{$envname}   = $stored_form;
                   14259:                 }
                   14260:             }
                   14261:         }
                   14262:     }
                   14263:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 14264:                                           $udom,$uname);
1.153     matthew  14265:     if ($put_result !~ /^(ok|delayed)/) {
                   14266:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   14267:                                  'got error:'.$put_result);
                   14268:     }
                   14269:     # Make sure these settings stick around in this session, too
1.646     raeburn  14270:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  14271:     return;
                   14272: }
                   14273: 
                   14274: sub restore_course_settings {
1.499     albertel 14275:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 14276: }
                   14277: 
                   14278: sub restore_settings {
                   14279:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14280:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 14281:         next if (exists($env{'form.'.$setting}));
1.496     albertel 14282:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  14283:             '.'.$setting;
1.258     albertel 14284:         if (exists($env{$envname})) {
1.153     matthew  14285:             if ($type eq 'scalar') {
1.258     albertel 14286:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  14287:             } elsif ($type eq 'array') {
1.258     albertel 14288:                 $env{'form.'.$setting} = [ 
1.153     matthew  14289:                                            map { 
1.369     www      14290:                                                &unescape($_); 
1.258     albertel 14291:                                            } split(',',$env{$envname})
1.153     matthew  14292:                                            ];
                   14293:             }
                   14294:         }
                   14295:     }
1.127     matthew  14296: }
                   14297: 
1.618     raeburn  14298: #######################################################
                   14299: #######################################################
                   14300: 
                   14301: =pod
                   14302: 
                   14303: =head1 Domain E-mail Routines  
                   14304: 
                   14305: =over 4
                   14306: 
1.648     raeburn  14307: =item * &build_recipient_list()
1.618     raeburn  14308: 
1.1075.2.44  raeburn  14309: Build recipient lists for following types of e-mail:
1.766     raeburn  14310: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1075.2.44  raeburn  14311: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   14312: module change checking, student/employee ID conflict checks, as
                   14313: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   14314: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  14315: 
                   14316: Inputs:
1.1075.2.44  raeburn  14317: defmail (scalar - email address of default recipient),
                   14318: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   14319: requestsmail, updatesmail, or idconflictsmail).
                   14320: 
1.619     raeburn  14321: defdom (domain for which to retrieve configuration settings),
1.1075.2.44  raeburn  14322: 
                   14323: origmail (scalar - email address of recipient from loncapa.conf,
                   14324: i.e., predates configuration by DC via domainprefs.pm
1.618     raeburn  14325: 
1.1075.2.139  raeburn  14326: $requname username of requester (if mailing type is helpdeskmail)
                   14327: 
                   14328: $requdom domain of requester (if mailing type is helpdeskmail)
                   14329: 
                   14330: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
                   14331: 
1.655     raeburn  14332: Returns: comma separated list of addresses to which to send e-mail.
                   14333: 
                   14334: =back
1.618     raeburn  14335: 
                   14336: =cut
                   14337: 
                   14338: ############################################################
                   14339: ############################################################
                   14340: sub build_recipient_list {
1.1075.2.139  raeburn  14341:     my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618     raeburn  14342:     my @recipients;
1.1075.2.122  raeburn  14343:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  14344:     my %domconfig =
1.1075.2.122  raeburn  14345:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  14346:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  14347:         if (exists($domconfig{'contacts'}{$mailing})) {
                   14348:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   14349:                 my @contacts = ('adminemail','supportemail');
                   14350:                 foreach my $item (@contacts) {
                   14351:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   14352:                         my $addr = $domconfig{'contacts'}{$item}; 
                   14353:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14354:                             push(@recipients,$addr);
                   14355:                         }
1.619     raeburn  14356:                     }
1.1075.2.122  raeburn  14357:                 }
                   14358:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   14359:                 if ($mailing eq 'helpdeskmail') {
                   14360:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   14361:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   14362:                         my @ok_bccs;
                   14363:                         foreach my $bcc (@bccs) {
                   14364:                             $bcc =~ s/^\s+//g;
                   14365:                             $bcc =~ s/\s+$//g;
                   14366:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14367:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14368:                                     push(@ok_bccs,$bcc);
                   14369:                                 }
                   14370:                             }
                   14371:                         }
                   14372:                         if (@ok_bccs > 0) {
                   14373:                             $allbcc = join(', ',@ok_bccs);
                   14374:                         }
                   14375:                     }
                   14376:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  14377:                 }
                   14378:             }
1.766     raeburn  14379:         } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14380:             $lastresort = $origmail;
1.618     raeburn  14381:         }
1.1075.2.139  raeburn  14382:         if ($mailing eq 'helpdeskmail') {
                   14383:             if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
                   14384:                 (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
                   14385:                 my ($inststatus,$inststatus_checked);
                   14386:                 if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
                   14387:                     ($env{'user.domain'} ne 'public')) {
                   14388:                     $inststatus_checked = 1;
                   14389:                     $inststatus = $env{'environment.inststatus'};
                   14390:                 }
                   14391:                 unless ($inststatus_checked) {
                   14392:                     if (($requname ne '') && ($requdom ne '')) {
                   14393:                         if (($requname =~ /^$match_username$/) &&
                   14394:                             ($requdom =~ /^$match_domain$/) &&
                   14395:                             (&Apache::lonnet::domain($requdom))) {
                   14396:                             my $requhome = &Apache::lonnet::homeserver($requname,
                   14397:                                                                       $requdom);
                   14398:                             unless ($requhome eq 'no_host') {
                   14399:                                 my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
                   14400:                                 $inststatus = $userenv{'inststatus'};
                   14401:                                 $inststatus_checked = 1;
                   14402:                             }
                   14403:                         }
                   14404:                     }
                   14405:                 }
                   14406:                 unless ($inststatus_checked) {
                   14407:                     if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
                   14408:                         my %srch = (srchby     => 'email',
                   14409:                                     srchdomain => $defdom,
                   14410:                                     srchterm   => $reqemail,
                   14411:                                     srchtype   => 'exact');
                   14412:                         my %srch_results = &Apache::lonnet::usersearch(\%srch);
                   14413:                         foreach my $uname (keys(%srch_results)) {
                   14414:                             if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14415:                                 $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14416:                                 $inststatus_checked = 1;
                   14417:                                 last;
                   14418:                             }
                   14419:                         }
                   14420:                         unless ($inststatus_checked) {
                   14421:                             my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
                   14422:                             if ($dirsrchres eq 'ok') {
                   14423:                                 foreach my $uname (keys(%srch_results)) {
                   14424:                                     if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14425:                                         $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14426:                                         $inststatus_checked = 1;
                   14427:                                         last;
                   14428:                                     }
                   14429:                                 }
                   14430:                             }
                   14431:                         }
                   14432:                     }
                   14433:                 }
                   14434:                 if ($inststatus ne '') {
                   14435:                     foreach my $status (split(/\:/,$inststatus)) {
                   14436:                         if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
                   14437:                             my @contacts = ('adminemail','supportemail');
                   14438:                             foreach my $item (@contacts) {
                   14439:                                 if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
                   14440:                                     my $addr = $domconfig{'contacts'}{'overrides'}{$status};
                   14441:                                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14442:                                         push(@recipients,$addr);
                   14443:                                     }
                   14444:                                 }
                   14445:                             }
                   14446:                             $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
                   14447:                             if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
                   14448:                                 my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
                   14449:                                 my @ok_bccs;
                   14450:                                 foreach my $bcc (@bccs) {
                   14451:                                     $bcc =~ s/^\s+//g;
                   14452:                                     $bcc =~ s/\s+$//g;
                   14453:                                     if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14454:                                         if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14455:                                             push(@ok_bccs,$bcc);
                   14456:                                         }
                   14457:                                     }
                   14458:                                 }
                   14459:                                 if (@ok_bccs > 0) {
                   14460:                                     $allbcc = join(', ',@ok_bccs);
                   14461:                                 }
                   14462:                             }
                   14463:                             $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
                   14464:                             last;
                   14465:                         }
                   14466:                     }
                   14467:                 }
                   14468:             }
                   14469:         }
1.619     raeburn  14470:     } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14471:         $lastresort = $origmail;
                   14472:     }
1.1075.2.128  raeburn  14473:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1075.2.122  raeburn  14474:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   14475:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   14476:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   14477:             my %what = (
                   14478:                           perlvar => 1,
                   14479:                        );
                   14480:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   14481:             if ($primary) {
                   14482:                 my $gotaddr;
                   14483:                 my ($result,$returnhash) =
                   14484:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   14485:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   14486:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   14487:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   14488:                         $gotaddr = 1;
                   14489:                     }
                   14490:                 }
                   14491:                 unless ($gotaddr) {
                   14492:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   14493:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   14494:                     unless ($uintdom eq $intdom) {
                   14495:                         my %domconfig =
                   14496:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   14497:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   14498:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   14499:                                 my @contacts = ('adminemail','supportemail');
                   14500:                                 foreach my $item (@contacts) {
                   14501:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   14502:                                         my $addr = $domconfig{'contacts'}{$item};
                   14503:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14504:                                             push(@recipients,$addr);
                   14505:                                         }
                   14506:                                     }
                   14507:                                 }
                   14508:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   14509:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   14510:                                 }
                   14511:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   14512:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   14513:                                     my @ok_bccs;
                   14514:                                     foreach my $bcc (@bccs) {
                   14515:                                         $bcc =~ s/^\s+//g;
                   14516:                                         $bcc =~ s/\s+$//g;
                   14517:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14518:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14519:                                                 push(@ok_bccs,$bcc);
                   14520:                                             }
                   14521:                                         }
                   14522:                                     }
                   14523:                                     if (@ok_bccs > 0) {
                   14524:                                         $allbcc = join(', ',@ok_bccs);
                   14525:                                     }
                   14526:                                 }
                   14527:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   14528:                             }
                   14529:                         }
                   14530:                     }
                   14531:                 }
                   14532:             }
                   14533:         }
1.618     raeburn  14534:     }
1.688     raeburn  14535:     if (defined($defmail)) {
                   14536:         if ($defmail ne '') {
                   14537:             push(@recipients,$defmail);
                   14538:         }
1.618     raeburn  14539:     }
                   14540:     if ($otheremails) {
1.619     raeburn  14541:         my @others;
                   14542:         if ($otheremails =~ /,/) {
                   14543:             @others = split(/,/,$otheremails);
1.618     raeburn  14544:         } else {
1.619     raeburn  14545:             push(@others,$otheremails);
                   14546:         }
                   14547:         foreach my $addr (@others) {
                   14548:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14549:                 push(@recipients,$addr);
                   14550:             }
1.618     raeburn  14551:         }
                   14552:     }
1.1075.2.128  raeburn  14553:     if ($mailing eq 'helpdeskmail') {
1.1075.2.122  raeburn  14554:         if ((!@recipients) && ($lastresort ne '')) {
                   14555:             push(@recipients,$lastresort);
                   14556:         }
                   14557:     } elsif ($lastresort ne '') {
                   14558:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   14559:             push(@recipients,$lastresort);
                   14560:         }
                   14561:     }
                   14562:     my $recipientlist = join(',',@recipients);
                   14563:     if (wantarray) {
                   14564:         return ($recipientlist,$allbcc,$addtext);
                   14565:     } else {
                   14566:         return $recipientlist;
                   14567:     }
1.618     raeburn  14568: }
                   14569: 
1.127     matthew  14570: ############################################################
                   14571: ############################################################
1.154     albertel 14572: 
1.655     raeburn  14573: =pod
                   14574: 
                   14575: =head1 Course Catalog Routines
                   14576: 
                   14577: =over 4
                   14578: 
                   14579: =item * &gather_categories()
                   14580: 
                   14581: Converts category definitions - keys of categories hash stored in  
                   14582: coursecategories in configuration.db on the primary library server in a 
                   14583: domain - to an array.  Also generates javascript and idx hash used to 
                   14584: generate Domain Coordinator interface for editing Course Categories.
                   14585: 
                   14586: Inputs:
1.663     raeburn  14587: 
1.655     raeburn  14588: categories (reference to hash of category definitions).
1.663     raeburn  14589: 
1.655     raeburn  14590: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14591:       categories and subcategories).
1.663     raeburn  14592: 
1.655     raeburn  14593: idx (reference to hash of counters used in Domain Coordinator interface for 
                   14594:       editing Course Categories).
1.663     raeburn  14595: 
1.655     raeburn  14596: jsarray (reference to array of categories used to create Javascript arrays for
                   14597:          Domain Coordinator interface for editing Course Categories).
                   14598: 
                   14599: Returns: nothing
                   14600: 
                   14601: Side effects: populates cats, idx and jsarray. 
                   14602: 
                   14603: =cut
                   14604: 
                   14605: sub gather_categories {
                   14606:     my ($categories,$cats,$idx,$jsarray) = @_;
                   14607:     my %counters;
                   14608:     my $num = 0;
                   14609:     foreach my $item (keys(%{$categories})) {
                   14610:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   14611:         if ($container eq '' && $depth == 0) {
                   14612:             $cats->[$depth][$categories->{$item}] = $cat;
                   14613:         } else {
                   14614:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   14615:         }
                   14616:         my ($escitem,$tail) = split(/:/,$item,2);
                   14617:         if ($counters{$tail} eq '') {
                   14618:             $counters{$tail} = $num;
                   14619:             $num ++;
                   14620:         }
                   14621:         if (ref($idx) eq 'HASH') {
                   14622:             $idx->{$item} = $counters{$tail};
                   14623:         }
                   14624:         if (ref($jsarray) eq 'ARRAY') {
                   14625:             push(@{$jsarray->[$counters{$tail}]},$item);
                   14626:         }
                   14627:     }
                   14628:     return;
                   14629: }
                   14630: 
                   14631: =pod
                   14632: 
                   14633: =item * &extract_categories()
                   14634: 
                   14635: Used to generate breadcrumb trails for course categories.
                   14636: 
                   14637: Inputs:
1.663     raeburn  14638: 
1.655     raeburn  14639: categories (reference to hash of category definitions).
1.663     raeburn  14640: 
1.655     raeburn  14641: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14642:       categories and subcategories).
1.663     raeburn  14643: 
1.655     raeburn  14644: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  14645: 
1.655     raeburn  14646: allitems (reference to hash - key is category key 
                   14647:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14648: 
1.655     raeburn  14649: idx (reference to hash of counters used in Domain Coordinator interface for
                   14650:       editing Course Categories).
1.663     raeburn  14651: 
1.655     raeburn  14652: jsarray (reference to array of categories used to create Javascript arrays for
                   14653:          Domain Coordinator interface for editing Course Categories).
                   14654: 
1.665     raeburn  14655: subcats (reference to hash of arrays containing all subcategories within each 
                   14656:          category, -recursive)
                   14657: 
1.1075.2.132  raeburn  14658: maxd (reference to hash used to hold max depth for all top-level categories).
                   14659: 
1.655     raeburn  14660: Returns: nothing
                   14661: 
                   14662: Side effects: populates trails and allitems hash references.
                   14663: 
                   14664: =cut
                   14665: 
                   14666: sub extract_categories {
1.1075.2.132  raeburn  14667:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655     raeburn  14668:     if (ref($categories) eq 'HASH') {
                   14669:         &gather_categories($categories,$cats,$idx,$jsarray);
                   14670:         if (ref($cats->[0]) eq 'ARRAY') {
                   14671:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   14672:                 my $name = $cats->[0][$i];
                   14673:                 my $item = &escape($name).'::0';
                   14674:                 my $trailstr;
                   14675:                 if ($name eq 'instcode') {
                   14676:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  14677:                 } elsif ($name eq 'communities') {
                   14678:                     $trailstr = &mt('Communities');
1.655     raeburn  14679:                 } else {
                   14680:                     $trailstr = $name;
                   14681:                 }
                   14682:                 if ($allitems->{$item} eq '') {
                   14683:                     push(@{$trails},$trailstr);
                   14684:                     $allitems->{$item} = scalar(@{$trails})-1;
                   14685:                 }
                   14686:                 my @parents = ($name);
                   14687:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   14688:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   14689:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  14690:                         if (ref($subcats) eq 'HASH') {
                   14691:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   14692:                         }
1.1075.2.132  raeburn  14693:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665     raeburn  14694:                     }
                   14695:                 } else {
                   14696:                     if (ref($subcats) eq 'HASH') {
                   14697:                         $subcats->{$item} = [];
1.655     raeburn  14698:                     }
1.1075.2.132  raeburn  14699:                     if (ref($maxd) eq 'HASH') {
                   14700:                         $maxd->{$name} = 1;
                   14701:                     }
1.655     raeburn  14702:                 }
                   14703:             }
                   14704:         }
                   14705:     }
                   14706:     return;
                   14707: }
                   14708: 
                   14709: =pod
                   14710: 
1.1075.2.56  raeburn  14711: =item * &recurse_categories()
1.655     raeburn  14712: 
                   14713: Recursively used to generate breadcrumb trails for course categories.
                   14714: 
                   14715: Inputs:
1.663     raeburn  14716: 
1.655     raeburn  14717: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14718:       categories and subcategories).
1.663     raeburn  14719: 
1.655     raeburn  14720: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  14721: 
                   14722: category (current course category, for which breadcrumb trail is being generated).
                   14723: 
                   14724: trails (reference to array of breadcrumb trails for each category).
                   14725: 
1.655     raeburn  14726: allitems (reference to hash - key is category key
                   14727:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14728: 
1.655     raeburn  14729: parents (array containing containers directories for current category, 
                   14730:          back to top level). 
                   14731: 
                   14732: Returns: nothing
                   14733: 
                   14734: Side effects: populates trails and allitems hash references
                   14735: 
                   14736: =cut
                   14737: 
                   14738: sub recurse_categories {
1.1075.2.132  raeburn  14739:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655     raeburn  14740:     my $shallower = $depth - 1;
                   14741:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   14742:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   14743:             my $name = $cats->[$depth]{$category}[$k];
                   14744:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   14745:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   14746:             if ($allitems->{$item} eq '') {
                   14747:                 push(@{$trails},$trailstr);
                   14748:                 $allitems->{$item} = scalar(@{$trails})-1;
                   14749:             }
                   14750:             my $deeper = $depth+1;
                   14751:             push(@{$parents},$category);
1.665     raeburn  14752:             if (ref($subcats) eq 'HASH') {
                   14753:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   14754:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   14755:                     my $higher;
                   14756:                     if ($j > 0) {
                   14757:                         $higher = &escape($parents->[$j]).':'.
                   14758:                                   &escape($parents->[$j-1]).':'.$j;
                   14759:                     } else {
                   14760:                         $higher = &escape($parents->[$j]).'::'.$j;
                   14761:                     }
                   14762:                     push(@{$subcats->{$higher}},$subcat);
                   14763:                 }
                   14764:             }
                   14765:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1075.2.132  raeburn  14766:                                 $subcats,$maxd);
1.655     raeburn  14767:             pop(@{$parents});
                   14768:         }
                   14769:     } else {
                   14770:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.132  raeburn  14771:         my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  14772:         if ($allitems->{$item} eq '') {
                   14773:             push(@{$trails},$trailstr);
                   14774:             $allitems->{$item} = scalar(@{$trails})-1;
                   14775:         }
1.1075.2.132  raeburn  14776:         if (ref($maxd) eq 'HASH') {
                   14777:             if ($depth > $maxd->{$parents->[0]}) {
                   14778:                 $maxd->{$parents->[0]} = $depth;
                   14779:             }
                   14780:         }
1.655     raeburn  14781:     }
                   14782:     return;
                   14783: }
                   14784: 
1.663     raeburn  14785: =pod
                   14786: 
1.1075.2.56  raeburn  14787: =item * &assign_categories_table()
1.663     raeburn  14788: 
                   14789: Create a datatable for display of hierarchical categories in a domain,
                   14790: with checkboxes to allow a course to be categorized. 
                   14791: 
                   14792: Inputs:
                   14793: 
                   14794: cathash - reference to hash of categories defined for the domain (from
                   14795:           configuration.db)
                   14796: 
                   14797: currcat - scalar with an & separated list of categories assigned to a course. 
                   14798: 
1.919     raeburn  14799: type    - scalar contains course type (Course or Community).
                   14800: 
1.1075.2.117  raeburn  14801: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   14802:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   14803: 
1.663     raeburn  14804: Returns: $output (markup to be displayed) 
                   14805: 
                   14806: =cut
                   14807: 
                   14808: sub assign_categories_table {
1.1075.2.117  raeburn  14809:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  14810:     my $output;
                   14811:     if (ref($cathash) eq 'HASH') {
1.1075.2.132  raeburn  14812:         my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
                   14813:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663     raeburn  14814:         $maxdepth = scalar(@cats);
                   14815:         if (@cats > 0) {
                   14816:             my $itemcount = 0;
                   14817:             if (ref($cats[0]) eq 'ARRAY') {
                   14818:                 my @currcategories;
                   14819:                 if ($currcat ne '') {
                   14820:                     @currcategories = split('&',$currcat);
                   14821:                 }
1.919     raeburn  14822:                 my $table;
1.663     raeburn  14823:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   14824:                     my $parent = $cats[0][$i];
1.919     raeburn  14825:                     next if ($parent eq 'instcode');
                   14826:                     if ($type eq 'Community') {
                   14827:                         next unless ($parent eq 'communities');
                   14828:                     } else {
                   14829:                         next if ($parent eq 'communities');
                   14830:                     }
1.663     raeburn  14831:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   14832:                     my $item = &escape($parent).'::0';
                   14833:                     my $checked = '';
                   14834:                     if (@currcategories > 0) {
                   14835:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   14836:                             $checked = ' checked="checked"';
1.663     raeburn  14837:                         }
                   14838:                     }
1.919     raeburn  14839:                     my $parent_title = $parent;
                   14840:                     if ($parent eq 'communities') {
                   14841:                         $parent_title = &mt('Communities');
                   14842:                     }
                   14843:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   14844:                               '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  14845:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  14846:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  14847:                     my $depth = 1;
                   14848:                     push(@path,$parent);
1.1075.2.117  raeburn  14849:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  14850:                     pop(@path);
1.919     raeburn  14851:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  14852:                     $itemcount ++;
                   14853:                 }
1.919     raeburn  14854:                 if ($itemcount) {
                   14855:                     $output = &Apache::loncommon::start_data_table().
                   14856:                               $table.
                   14857:                               &Apache::loncommon::end_data_table();
                   14858:                 }
1.663     raeburn  14859:             }
                   14860:         }
                   14861:     }
                   14862:     return $output;
                   14863: }
                   14864: 
                   14865: =pod
                   14866: 
1.1075.2.56  raeburn  14867: =item * &assign_category_rows()
1.663     raeburn  14868: 
                   14869: Create a datatable row for display of nested categories in a domain,
                   14870: with checkboxes to allow a course to be categorized,called recursively.
                   14871: 
                   14872: Inputs:
                   14873: 
                   14874: itemcount - track row number for alternating colors
                   14875: 
                   14876: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   14877:       categories and subcategories.
                   14878: 
                   14879: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   14880: 
                   14881: parent - parent of current category item
                   14882: 
                   14883: path - Array containing all categories back up through the hierarchy from the
                   14884:        current category to the top level.
                   14885: 
                   14886: currcategories - reference to array of current categories assigned to the course
                   14887: 
1.1075.2.117  raeburn  14888: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   14889:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   14890: 
1.663     raeburn  14891: Returns: $output (markup to be displayed).
                   14892: 
                   14893: =cut
                   14894: 
                   14895: sub assign_category_rows {
1.1075.2.117  raeburn  14896:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  14897:     my ($text,$name,$item,$chgstr);
                   14898:     if (ref($cats) eq 'ARRAY') {
                   14899:         my $maxdepth = scalar(@{$cats});
                   14900:         if (ref($cats->[$depth]) eq 'HASH') {
                   14901:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   14902:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   14903:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1075.2.45  raeburn  14904:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  14905:                 for (my $j=0; $j<$numchildren; $j++) {
                   14906:                     $name = $cats->[$depth]{$parent}[$j];
                   14907:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   14908:                     my $deeper = $depth+1;
                   14909:                     my $checked = '';
                   14910:                     if (ref($currcategories) eq 'ARRAY') {
                   14911:                         if (@{$currcategories} > 0) {
                   14912:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   14913:                                 $checked = ' checked="checked"';
1.663     raeburn  14914:                             }
                   14915:                         }
                   14916:                     }
1.664     raeburn  14917:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   14918:                              '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  14919:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  14920:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   14921:                              '</td><td>';
1.663     raeburn  14922:                     if (ref($path) eq 'ARRAY') {
                   14923:                         push(@{$path},$name);
1.1075.2.117  raeburn  14924:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  14925:                         pop(@{$path});
                   14926:                     }
                   14927:                     $text .= '</td></tr>';
                   14928:                 }
                   14929:                 $text .= '</table></td>';
                   14930:             }
                   14931:         }
                   14932:     }
                   14933:     return $text;
                   14934: }
                   14935: 
1.1075.2.69  raeburn  14936: =pod
                   14937: 
                   14938: =back
                   14939: 
                   14940: =cut
                   14941: 
1.655     raeburn  14942: ############################################################
                   14943: ############################################################
                   14944: 
                   14945: 
1.443     albertel 14946: sub commit_customrole {
1.664     raeburn  14947:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  14948:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 14949:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   14950:                          ($end?', ending '.localtime($end):'').': <b>'.
                   14951:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  14952:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 14953:                  '</b><br />';
                   14954:     return $output;
                   14955: }
                   14956: 
                   14957: sub commit_standardrole {
1.1075.2.31  raeburn  14958:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541     raeburn  14959:     my ($output,$logmsg,$linefeed);
                   14960:     if ($context eq 'auto') {
                   14961:         $linefeed = "\n";
                   14962:     } else {
                   14963:         $linefeed = "<br />\n";
                   14964:     }  
1.443     albertel 14965:     if ($three eq 'st') {
1.541     raeburn  14966:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31  raeburn  14967:                                          $one,$two,$sec,$context,$credits);
1.541     raeburn  14968:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  14969:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   14970:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 14971:         } else {
1.541     raeburn  14972:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 14973:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  14974:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   14975:             if ($context eq 'auto') {
                   14976:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   14977:             } else {
                   14978:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   14979:                &mt('Add to classlist').': <b>ok</b>';
                   14980:             }
                   14981:             $output .= $linefeed;
1.443     albertel 14982:         }
                   14983:     } else {
                   14984:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   14985:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  14986:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  14987:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  14988:         if ($context eq 'auto') {
                   14989:             $output .= $result.$linefeed;
                   14990:         } else {
                   14991:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   14992:         }
1.443     albertel 14993:     }
                   14994:     return $output;
                   14995: }
                   14996: 
                   14997: sub commit_studentrole {
1.1075.2.31  raeburn  14998:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
                   14999:         $credits) = @_;
1.626     raeburn  15000:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  15001:     if ($context eq 'auto') {
                   15002:         $linefeed = "\n";
                   15003:     } else {
                   15004:         $linefeed = '<br />'."\n";
                   15005:     }
1.443     albertel 15006:     if (defined($one) && defined($two)) {
                   15007:         my $cid=$one.'_'.$two;
                   15008:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   15009:         my $secchange = 0;
                   15010:         my $expire_role_result;
                   15011:         my $modify_section_result;
1.628     raeburn  15012:         if ($oldsec ne '-1') { 
                   15013:             if ($oldsec ne $sec) {
1.443     albertel 15014:                 $secchange = 1;
1.628     raeburn  15015:                 my $now = time;
1.443     albertel 15016:                 my $uurl='/'.$cid;
                   15017:                 $uurl=~s/\_/\//g;
                   15018:                 if ($oldsec) {
                   15019:                     $uurl.='/'.$oldsec;
                   15020:                 }
1.626     raeburn  15021:                 $oldsecurl = $uurl;
1.628     raeburn  15022:                 $expire_role_result = 
1.652     raeburn  15023:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  15024:                 if ($env{'request.course.sec'} ne '') { 
                   15025:                     if ($expire_role_result eq 'refused') {
                   15026:                         my @roles = ('st');
                   15027:                         my @statuses = ('previous');
                   15028:                         my @roledoms = ($one);
                   15029:                         my $withsec = 1;
                   15030:                         my %roleshash = 
                   15031:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   15032:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   15033:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   15034:                             my ($oldstart,$oldend) = 
                   15035:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   15036:                             if ($oldend > 0 && $oldend <= $now) {
                   15037:                                 $expire_role_result = 'ok';
                   15038:                             }
                   15039:                         }
                   15040:                     }
                   15041:                 }
1.443     albertel 15042:                 $result = $expire_role_result;
                   15043:             }
                   15044:         }
                   15045:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31  raeburn  15046:             $modify_section_result = 
                   15047:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   15048:                                                            undef,undef,undef,$sec,
                   15049:                                                            $end,$start,'','',$cid,
                   15050:                                                            '',$context,$credits);
1.443     albertel 15051:             if ($modify_section_result =~ /^ok/) {
                   15052:                 if ($secchange == 1) {
1.628     raeburn  15053:                     if ($sec eq '') {
                   15054:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   15055:                     } else {
                   15056:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   15057:                     }
1.443     albertel 15058:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  15059:                     if ($sec eq '') {
                   15060:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   15061:                     } else {
                   15062:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15063:                     }
1.443     albertel 15064:                 } else {
1.628     raeburn  15065:                     if ($sec eq '') {
                   15066:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   15067:                     } else {
                   15068:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15069:                     }
1.443     albertel 15070:                 }
                   15071:             } else {
1.628     raeburn  15072:                 if ($secchange) {       
                   15073:                     $$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;
                   15074:                 } else {
                   15075:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   15076:                 }
1.443     albertel 15077:             }
                   15078:             $result = $modify_section_result;
                   15079:         } elsif ($secchange == 1) {
1.628     raeburn  15080:             if ($oldsec eq '') {
1.1075.2.20  raeburn  15081:                 $$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  15082:             } else {
                   15083:                 $$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;
                   15084:             }
1.626     raeburn  15085:             if ($expire_role_result eq 'refused') {
                   15086:                 my $newsecurl = '/'.$cid;
                   15087:                 $newsecurl =~ s/\_/\//g;
                   15088:                 if ($sec ne '') {
                   15089:                     $newsecurl.='/'.$sec;
                   15090:                 }
                   15091:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   15092:                     if ($sec eq '') {
                   15093:                         $$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;
                   15094:                     } else {
                   15095:                         $$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;
                   15096:                     }
                   15097:                 }
                   15098:             }
1.443     albertel 15099:         }
                   15100:     } else {
1.626     raeburn  15101:         $$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 15102:         $result = "error: incomplete course id\n";
                   15103:     }
                   15104:     return $result;
                   15105: }
                   15106: 
1.1075.2.25  raeburn  15107: sub show_role_extent {
                   15108:     my ($scope,$context,$role) = @_;
                   15109:     $scope =~ s{^/}{};
                   15110:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   15111:     push(@courseroles,'co');
                   15112:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   15113:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   15114:         $scope =~ s{/}{_};
                   15115:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   15116:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   15117:         my ($audom,$auname) = split(/\//,$scope);
                   15118:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   15119:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   15120:     } else {
                   15121:         $scope =~ s{/$}{};
                   15122:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   15123:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   15124:     }
                   15125: }
                   15126: 
1.443     albertel 15127: ############################################################
                   15128: ############################################################
                   15129: 
1.566     albertel 15130: sub check_clone {
1.578     raeburn  15131:     my ($args,$linefeed) = @_;
1.566     albertel 15132:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   15133:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   15134:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   15135:     my $clonemsg;
                   15136:     my $can_clone = 0;
1.944     raeburn  15137:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  15138:     if ($lctype ne 'community') {
                   15139:         $lctype = 'course';
                   15140:     }
1.566     albertel 15141:     if ($clonehome eq 'no_host') {
1.944     raeburn  15142:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15143:             $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'});
                   15144:         } else {
                   15145:             $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'});
                   15146:         }     
1.566     albertel 15147:     } else {
                   15148: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  15149:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15150:             if ($clonedesc{'type'} ne 'Community') {
                   15151:                  $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'});
                   15152:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15153:             }
                   15154:         }
1.1075.2.119  raeburn  15155: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  15156:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 15157: 	    $can_clone = 1;
                   15158: 	} else {
1.1075.2.95  raeburn  15159: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 15160: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1075.2.95  raeburn  15161:             if ($clonehash{'cloners'} eq '') {
                   15162:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   15163:                 if ($domdefs{'canclone'}) {
                   15164:                     unless ($domdefs{'canclone'} eq 'none') {
                   15165:                         if ($domdefs{'canclone'} eq 'domain') {
                   15166:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   15167:                                 $can_clone = 1;
                   15168:                             }
                   15169:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15170:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   15171:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   15172:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   15173:                                 $can_clone = 1;
                   15174:                             }
                   15175:                         }
                   15176:                     }
1.908     raeburn  15177:                 }
1.1075.2.95  raeburn  15178:             } else {
                   15179: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   15180:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  15181:                     $can_clone = 1;
1.1075.2.95  raeburn  15182:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  15183:                     $can_clone = 1;
1.1075.2.96  raeburn  15184:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   15185:                     $can_clone = 1;
1.1075.2.95  raeburn  15186:                 }
                   15187:                 unless ($can_clone) {
1.1075.2.96  raeburn  15188:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15189:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1075.2.95  raeburn  15190:                         my (%gotdomdefaults,%gotcodedefaults);
                   15191:                         foreach my $cloner (@cloners) {
                   15192:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   15193:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   15194:                                 my (%codedefaults,@code_order);
                   15195:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   15196:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   15197:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   15198:                                     }
                   15199:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   15200:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   15201:                                     }
                   15202:                                 } else {
                   15203:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   15204:                                                                             \%codedefaults,
                   15205:                                                                             \@code_order);
                   15206:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   15207:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   15208:                                 }
                   15209:                                 if (@code_order > 0) {
                   15210:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   15211:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   15212:                                                                                 $args->{'crscode'})) {
                   15213:                                         $can_clone = 1;
                   15214:                                         last;
                   15215:                                     }
                   15216:                                 }
                   15217:                             }
                   15218:                         }
                   15219:                     }
1.1075.2.96  raeburn  15220:                 }
                   15221:             }
                   15222:             unless ($can_clone) {
                   15223:                 my $ccrole = 'cc';
                   15224:                 if ($args->{'crstype'} eq 'Community') {
                   15225:                     $ccrole = 'co';
                   15226:                 }
                   15227:                 my %roleshash =
                   15228:                     &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   15229:                                                   $args->{'ccdomain'},
                   15230:                                                   'userroles',['active'],[$ccrole],
                   15231:                                                   [$args->{'clonedomain'}]);
                   15232:                 if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   15233:                     $can_clone = 1;
                   15234:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   15235:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   15236:                     $can_clone = 1;
1.1075.2.95  raeburn  15237:                 }
                   15238:             }
                   15239:             unless ($can_clone) {
                   15240:                 if ($args->{'crstype'} eq 'Community') {
                   15241:                     $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'});
                   15242:                 } else {
                   15243:                     $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  15244: 	        }
1.566     albertel 15245: 	    }
1.578     raeburn  15246:         }
1.566     albertel 15247:     }
                   15248:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15249: }
                   15250: 
1.444     albertel 15251: sub construct_course {
1.1075.2.119  raeburn  15252:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
                   15253:         $cnum,$category,$coderef) = @_;
1.444     albertel 15254:     my $outcome;
1.541     raeburn  15255:     my $linefeed =  '<br />'."\n";
                   15256:     if ($context eq 'auto') {
                   15257:         $linefeed = "\n";
                   15258:     }
1.566     albertel 15259: 
                   15260: #
                   15261: # Are we cloning?
                   15262: #
                   15263:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15264:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  15265: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 15266: 	if ($context ne 'auto') {
1.578     raeburn  15267:             if ($clonemsg ne '') {
                   15268: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   15269:             }
1.566     albertel 15270: 	}
                   15271: 	$outcome .= $clonemsg.$linefeed;
                   15272: 
                   15273:         if (!$can_clone) {
                   15274: 	    return (0,$outcome);
                   15275: 	}
                   15276:     }
                   15277: 
1.444     albertel 15278: #
                   15279: # Open course
                   15280: #
                   15281:     my $crstype = lc($args->{'crstype'});
                   15282:     my %cenv=();
                   15283:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   15284:                                              $args->{'cdescr'},
                   15285:                                              $args->{'curl'},
                   15286:                                              $args->{'course_home'},
                   15287:                                              $args->{'nonstandard'},
                   15288:                                              $args->{'crscode'},
                   15289:                                              $args->{'ccuname'}.':'.
                   15290:                                              $args->{'ccdomain'},
1.882     raeburn  15291:                                              $args->{'crstype'},
1.885     raeburn  15292:                                              $cnum,$context,$category);
1.444     albertel 15293: 
                   15294:     # Note: The testing routines depend on this being output; see 
                   15295:     # Utils::Course. This needs to at least be output as a comment
                   15296:     # if anyone ever decides to not show this, and Utils::Course::new
                   15297:     # will need to be suitably modified.
1.541     raeburn  15298:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  15299:     if ($$courseid =~ /^error:/) {
                   15300:         return (0,$outcome);
                   15301:     }
                   15302: 
1.444     albertel 15303: #
                   15304: # Check if created correctly
                   15305: #
1.479     albertel 15306:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 15307:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  15308:     if ($crsuhome eq 'no_host') {
                   15309:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   15310:         return (0,$outcome);
                   15311:     }
1.541     raeburn  15312:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 15313: 
1.444     albertel 15314: #
1.566     albertel 15315: # Do the cloning
                   15316: #   
                   15317:     if ($can_clone && $cloneid) {
                   15318: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   15319: 	if ($context ne 'auto') {
                   15320: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   15321: 	}
                   15322: 	$outcome .= $clonemsg.$linefeed;
                   15323: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 15324: # Copy all files
1.637     www      15325: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 15326: # Restore URL
1.566     albertel 15327: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 15328: # Restore title
1.566     albertel 15329: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  15330: # Restore creation date, creator and creation context.
                   15331:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   15332:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   15333:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 15334: # Mark as cloned
1.566     albertel 15335: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      15336: # Need to clone grading mode
                   15337:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   15338:         $cenv{'grading'}=$newenv{'grading'};
                   15339: # Do not clone these environment entries
                   15340:         &Apache::lonnet::del('environment',
                   15341:                   ['default_enrollment_start_date',
                   15342:                    'default_enrollment_end_date',
                   15343:                    'question.email',
                   15344:                    'policy.email',
                   15345:                    'comment.email',
                   15346:                    'pch.users.denied',
1.725     raeburn  15347:                    'plc.users.denied',
                   15348:                    'hidefromcat',
1.1075.2.36  raeburn  15349:                    'checkforpriv',
1.1075.2.59  raeburn  15350:                    'categories',
                   15351:                    'internal.uniquecode'],
1.638     www      15352:                    $$crsudom,$$crsunum);
1.1075.2.63  raeburn  15353:         if ($args->{'textbook'}) {
                   15354:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   15355:         }
1.444     albertel 15356:     }
1.566     albertel 15357: 
1.444     albertel 15358: #
                   15359: # Set environment (will override cloned, if existing)
                   15360: #
                   15361:     my @sections = ();
                   15362:     my @xlists = ();
                   15363:     if ($args->{'crstype'}) {
                   15364:         $cenv{'type'}=$args->{'crstype'};
                   15365:     }
                   15366:     if ($args->{'crsid'}) {
                   15367:         $cenv{'courseid'}=$args->{'crsid'};
                   15368:     }
                   15369:     if ($args->{'crscode'}) {
                   15370:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   15371:     }
                   15372:     if ($args->{'crsquota'} ne '') {
                   15373:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   15374:     } else {
                   15375:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   15376:     }
                   15377:     if ($args->{'ccuname'}) {
                   15378:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   15379:                                         ':'.$args->{'ccdomain'};
                   15380:     } else {
                   15381:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   15382:     }
1.1075.2.31  raeburn  15383:     if ($args->{'defaultcredits'}) {
                   15384:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   15385:     }
1.444     albertel 15386:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   15387:     if ($args->{'crssections'}) {
                   15388:         $cenv{'internal.sectionnums'} = '';
                   15389:         if ($args->{'crssections'} =~ m/,/) {
                   15390:             @sections = split/,/,$args->{'crssections'};
                   15391:         } else {
                   15392:             $sections[0] = $args->{'crssections'};
                   15393:         }
                   15394:         if (@sections > 0) {
                   15395:             foreach my $item (@sections) {
                   15396:                 my ($sec,$gp) = split/:/,$item;
                   15397:                 my $class = $args->{'crscode'}.$sec;
                   15398:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   15399:                 $cenv{'internal.sectionnums'} .= $item.',';
                   15400:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  15401:                     push(@badclasses,$class);
1.444     albertel 15402:                 }
                   15403:             }
                   15404:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   15405:         }
                   15406:     }
                   15407: # do not hide course coordinator from staff listing, 
                   15408: # even if privileged
                   15409:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36  raeburn  15410: # add course coordinator's domain to domains to check for privileged users
                   15411: # if different to course domain
                   15412:     if ($$crsudom ne $args->{'ccdomain'}) {
                   15413:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   15414:     }
1.444     albertel 15415: # add crosslistings
                   15416:     if ($args->{'crsxlist'}) {
                   15417:         $cenv{'internal.crosslistings'}='';
                   15418:         if ($args->{'crsxlist'} =~ m/,/) {
                   15419:             @xlists = split/,/,$args->{'crsxlist'};
                   15420:         } else {
                   15421:             $xlists[0] = $args->{'crsxlist'};
                   15422:         }
                   15423:         if (@xlists > 0) {
                   15424:             foreach my $item (@xlists) {
                   15425:                 my ($xl,$gp) = split/:/,$item;
                   15426:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   15427:                 $cenv{'internal.crosslistings'} .= $item.',';
                   15428:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  15429:                     push(@badclasses,$xl);
1.444     albertel 15430:                 }
                   15431:             }
                   15432:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   15433:         }
                   15434:     }
                   15435:     if ($args->{'autoadds'}) {
                   15436:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   15437:     }
                   15438:     if ($args->{'autodrops'}) {
                   15439:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   15440:     }
                   15441: # check for notification of enrollment changes
                   15442:     my @notified = ();
                   15443:     if ($args->{'notify_owner'}) {
                   15444:         if ($args->{'ccuname'} ne '') {
                   15445:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   15446:         }
                   15447:     }
                   15448:     if ($args->{'notify_dc'}) {
                   15449:         if ($uname ne '') { 
1.630     raeburn  15450:             push(@notified,$uname.':'.$udom);
1.444     albertel 15451:         }
                   15452:     }
                   15453:     if (@notified > 0) {
                   15454:         my $notifylist;
                   15455:         if (@notified > 1) {
                   15456:             $notifylist = join(',',@notified);
                   15457:         } else {
                   15458:             $notifylist = $notified[0];
                   15459:         }
                   15460:         $cenv{'internal.notifylist'} = $notifylist;
                   15461:     }
                   15462:     if (@badclasses > 0) {
                   15463:         my %lt=&Apache::lonlocal::texthash(
1.1075.2.119  raeburn  15464:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   15465:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   15466:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 15467:         );
1.1075.2.119  raeburn  15468:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   15469:                            &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  15470:         if ($context eq 'auto') {
                   15471:             $outcome .= $badclass_msg.$linefeed;
1.1075.2.119  raeburn  15472:         } else {
1.566     albertel 15473:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1075.2.119  raeburn  15474:         }
                   15475:         foreach my $item (@badclasses) {
1.541     raeburn  15476:             if ($context eq 'auto') {
1.1075.2.119  raeburn  15477:                 $outcome .= " - $item\n";
1.541     raeburn  15478:             } else {
1.1075.2.119  raeburn  15479:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  15480:             }
1.1075.2.119  raeburn  15481:         }
                   15482:         if ($context eq 'auto') {
                   15483:             $outcome .= $linefeed;
                   15484:         } else {
                   15485:             $outcome .= "</ul><br /><br /></div>\n";
                   15486:         }
1.444     albertel 15487:     }
                   15488:     if ($args->{'no_end_date'}) {
                   15489:         $args->{'endaccess'} = 0;
                   15490:     }
                   15491:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   15492:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   15493:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   15494:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   15495:     if ($args->{'showphotos'}) {
                   15496:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   15497:     }
                   15498:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   15499:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   15500:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   15501:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  15502:             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'); 
                   15503:             if ($context eq 'auto') {
                   15504:                 $outcome .= $krb_msg;
                   15505:             } else {
1.566     albertel 15506:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  15507:             }
                   15508:             $outcome .= $linefeed;
1.444     albertel 15509:         }
                   15510:     }
                   15511:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   15512:        if ($args->{'setpolicy'}) {
                   15513:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15514:        }
                   15515:        if ($args->{'setcontent'}) {
                   15516:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15517:        }
1.1075.2.110  raeburn  15518:        if ($args->{'setcomment'}) {
                   15519:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15520:        }
1.444     albertel 15521:     }
                   15522:     if ($args->{'reshome'}) {
                   15523: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   15524: 	$cenv{'reshome'}=~s/\/+$/\//;
                   15525:     }
                   15526: #
                   15527: # course has keyed access
                   15528: #
                   15529:     if ($args->{'setkeys'}) {
                   15530:        $cenv{'keyaccess'}='yes';
                   15531:     }
                   15532: # if specified, key authority is not course, but user
                   15533: # only active if keyaccess is yes
                   15534:     if ($args->{'keyauth'}) {
1.487     albertel 15535: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   15536: 	$user = &LONCAPA::clean_username($user);
                   15537: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     15538: 	if ($user ne '' && $domain ne '') {
1.487     albertel 15539: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 15540: 	}
                   15541:     }
                   15542: 
1.1075.2.59  raeburn  15543: #
                   15544: #  generate and store uniquecode (available to course requester), if course should have one.
                   15545: #
                   15546:     if ($args->{'uniquecode'}) {
                   15547:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   15548:         if ($code) {
                   15549:             $cenv{'internal.uniquecode'} = $code;
                   15550:             my %crsinfo =
                   15551:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   15552:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   15553:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   15554:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   15555:             }
                   15556:             if (ref($coderef)) {
                   15557:                 $$coderef = $code;
                   15558:             }
                   15559:         }
                   15560:     }
                   15561: 
1.444     albertel 15562:     if ($args->{'disresdis'}) {
                   15563:         $cenv{'pch.roles.denied'}='st';
                   15564:     }
                   15565:     if ($args->{'disablechat'}) {
                   15566:         $cenv{'plc.roles.denied'}='st';
                   15567:     }
                   15568: 
                   15569:     # Record we've not yet viewed the Course Initialization Helper for this 
                   15570:     # course
                   15571:     $cenv{'course.helper.not.run'} = 1;
                   15572:     #
                   15573:     # Use new Randomseed
                   15574:     #
                   15575:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   15576:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   15577:     #
                   15578:     # The encryption code and receipt prefix for this course
                   15579:     #
                   15580:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   15581:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   15582:     #
                   15583:     # By default, use standard grading
                   15584:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   15585: 
1.541     raeburn  15586:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   15587:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15588: #
                   15589: # Open all assignments
                   15590: #
                   15591:     if ($args->{'openall'}) {
1.1075.2.146  raeburn  15592:        my $opendate = time;
                   15593:        if ($args->{'openallfrom'} =~ /^\d+$/) {
                   15594:            $opendate = $args->{'openallfrom'};
                   15595:        }
1.444     albertel 15596:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1075.2.146  raeburn  15597:        my %storecontent = ($storeunder         => $opendate,
1.444     albertel 15598:                            $storeunder.'.type' => 'date_start');
1.1075.2.146  raeburn  15599:        $outcome .= &mt('All assignments open starting [_1]',
                   15600:                        &Apache::lonlocal::locallocaltime($opendate)).': '.
                   15601:                    &Apache::lonnet::cput
                   15602:                        ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15603:    }
                   15604: #
                   15605: # Set first page
                   15606: #
                   15607:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   15608: 	    || ($cloneid)) {
1.445     albertel 15609: 	use LONCAPA::map;
1.444     albertel 15610: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 15611: 
                   15612: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   15613:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   15614: 
1.444     albertel 15615:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   15616:         my $title; my $url;
                   15617:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   15618: 	    $title=&mt('Syllabus');
1.444     albertel 15619:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   15620:         } else {
1.963     raeburn  15621:             $title=&mt('Table of Contents');
1.444     albertel 15622:             $url='/adm/navmaps';
                   15623:         }
1.445     albertel 15624: 
                   15625:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   15626: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   15627: 
                   15628: 	if ($errtext) { $fatal=2; }
1.541     raeburn  15629:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 15630:     }
1.566     albertel 15631: 
                   15632:     return (1,$outcome);
1.444     albertel 15633: }
                   15634: 
1.1075.2.59  raeburn  15635: sub make_unique_code {
                   15636:     my ($cdom,$cnum) = @_;
                   15637:     # get lock on uniquecodes db
                   15638:     my $lockhash = {
                   15639:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   15640:                                                   ':'.$env{'user.domain'},
                   15641:                    };
                   15642:     my $tries = 0;
                   15643:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15644:     my ($code,$error);
                   15645: 
                   15646:     while (($gotlock ne 'ok') && ($tries<3)) {
                   15647:         $tries ++;
                   15648:         sleep 1;
                   15649:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15650:     }
                   15651:     if ($gotlock eq 'ok') {
                   15652:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   15653:         my $gotcode;
                   15654:         my $attempts = 0;
                   15655:         while ((!$gotcode) && ($attempts < 100)) {
                   15656:             $code = &generate_code();
                   15657:             if (!exists($currcodes{$code})) {
                   15658:                 $gotcode = 1;
                   15659:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   15660:                     $error = 'nostore';
                   15661:                 }
                   15662:             }
                   15663:             $attempts ++;
                   15664:         }
                   15665:         my @del_lock = ($cnum."\0".'uniquecodes');
                   15666:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   15667:     } else {
                   15668:         $error = 'nolock';
                   15669:     }
                   15670:     return ($code,$error);
                   15671: }
                   15672: 
                   15673: sub generate_code {
                   15674:     my $code;
                   15675:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   15676:     for (my $i=0; $i<6; $i++) {
                   15677:         my $lettnum = int (rand 2);
                   15678:         my $item = '';
                   15679:         if ($lettnum) {
                   15680:             $item = $letts[int( rand(18) )];
                   15681:         } else {
                   15682:             $item = 1+int( rand(8) );
                   15683:         }
                   15684:         $code .= $item;
                   15685:     }
                   15686:     return $code;
                   15687: }
                   15688: 
1.444     albertel 15689: ############################################################
                   15690: ############################################################
                   15691: 
1.953     droeschl 15692: #SD
                   15693: # only Community and Course, or anything else?
1.378     raeburn  15694: sub course_type {
                   15695:     my ($cid) = @_;
                   15696:     if (!defined($cid)) {
                   15697:         $cid = $env{'request.course.id'};
                   15698:     }
1.404     albertel 15699:     if (defined($env{'course.'.$cid.'.type'})) {
                   15700:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  15701:     } else {
                   15702:         return 'Course';
1.377     raeburn  15703:     }
                   15704: }
1.156     albertel 15705: 
1.406     raeburn  15706: sub group_term {
                   15707:     my $crstype = &course_type();
                   15708:     my %names = (
                   15709:                   'Course' => 'group',
1.865     raeburn  15710:                   'Community' => 'group',
1.406     raeburn  15711:                 );
                   15712:     return $names{$crstype};
                   15713: }
                   15714: 
1.902     raeburn  15715: sub course_types {
1.1075.2.59  raeburn  15716:     my @types = ('official','unofficial','community','textbook');
1.902     raeburn  15717:     my %typename = (
                   15718:                          official   => 'Official course',
                   15719:                          unofficial => 'Unofficial course',
                   15720:                          community  => 'Community',
1.1075.2.59  raeburn  15721:                          textbook   => 'Textbook course',
1.902     raeburn  15722:                    );
                   15723:     return (\@types,\%typename);
                   15724: }
                   15725: 
1.156     albertel 15726: sub icon {
                   15727:     my ($file)=@_;
1.505     albertel 15728:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 15729:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 15730:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 15731:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   15732: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   15733: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   15734: 	            $curfext.".gif") {
                   15735: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   15736: 		$curfext.".gif";
                   15737: 	}
                   15738:     }
1.249     albertel 15739:     return &lonhttpdurl($iconname);
1.154     albertel 15740: } 
1.84      albertel 15741: 
1.575     albertel 15742: sub lonhttpdurl {
1.692     www      15743: #
                   15744: # Had been used for "small fry" static images on separate port 8080.
                   15745: # Modify here if lightweight http functionality desired again.
                   15746: # Currently eliminated due to increasing firewall issues.
                   15747: #
1.575     albertel 15748:     my ($url)=@_;
1.692     www      15749:     return $url;
1.215     albertel 15750: }
                   15751: 
1.213     albertel 15752: sub connection_aborted {
                   15753:     my ($r)=@_;
                   15754:     $r->print(" ");$r->rflush();
                   15755:     my $c = $r->connection;
                   15756:     return $c->aborted();
                   15757: }
                   15758: 
1.221     foxr     15759: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     15760: #    strings as 'strings'.
                   15761: sub escape_single {
1.221     foxr     15762:     my ($input) = @_;
1.223     albertel 15763:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     15764:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   15765:     return $input;
                   15766: }
1.223     albertel 15767: 
1.222     foxr     15768: #  Same as escape_single, but escape's "'s  This 
                   15769: #  can be used for  "strings"
                   15770: sub escape_double {
                   15771:     my ($input) = @_;
                   15772:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   15773:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   15774:     return $input;
                   15775: }
1.223     albertel 15776:  
1.222     foxr     15777: #   Escapes the last element of a full URL.
                   15778: sub escape_url {
                   15779:     my ($url)   = @_;
1.238     raeburn  15780:     my @urlslices = split(/\//, $url,-1);
1.369     www      15781:     my $lastitem = &escape(pop(@urlslices));
1.1075.2.83  raeburn  15782:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     15783: }
1.462     albertel 15784: 
1.820     raeburn  15785: sub compare_arrays {
                   15786:     my ($arrayref1,$arrayref2) = @_;
                   15787:     my (@difference,%count);
                   15788:     @difference = ();
                   15789:     %count = ();
                   15790:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   15791:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   15792:         foreach my $element (keys(%count)) {
                   15793:             if ($count{$element} == 1) {
                   15794:                 push(@difference,$element);
                   15795:             }
                   15796:         }
                   15797:     }
                   15798:     return @difference;
                   15799: }
                   15800: 
1.1075.2.152! raeburn  15801: sub lon_status_items {
        !          15802:     my %defaults = (
        !          15803:                      E         => 100,
        !          15804:                      W         => 4,
        !          15805:                      N         => 1,
        !          15806:                      U         => 5,
        !          15807:                      threshold => 200,
        !          15808:                      sysmail   => 2500,
        !          15809:                    );
        !          15810:     my %names = (
        !          15811:                    E => 'Errors',
        !          15812:                    W => 'Warnings',
        !          15813:                    N => 'Notices',
        !          15814:                    U => 'Unsent',
        !          15815:                 );
        !          15816:     return (\%defaults,\%names);
        !          15817: }
        !          15818: 
1.817     bisitz   15819: # -------------------------------------------------------- Initialize user login
1.462     albertel 15820: sub init_user_environment {
1.463     albertel 15821:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 15822:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   15823: 
                   15824:     my $public=($username eq 'public' && $domain eq 'public');
                   15825: 
                   15826: # See if old ID present, if so, remove
                   15827: 
1.1062    raeburn  15828:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 15829:     my $now=time;
                   15830: 
                   15831:     if ($public) {
                   15832: 	my $max_public=100;
                   15833: 	my $oldest;
                   15834: 	my $oldest_time=0;
                   15835: 	for(my $next=1;$next<=$max_public;$next++) {
                   15836: 	    if (-e $lonids."/publicuser_$next.id") {
                   15837: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   15838: 		if ($mtime<$oldest_time || !$oldest_time) {
                   15839: 		    $oldest_time=$mtime;
                   15840: 		    $oldest=$next;
                   15841: 		}
                   15842: 	    } else {
                   15843: 		$cookie="publicuser_$next";
                   15844: 		last;
                   15845: 	    }
                   15846: 	}
                   15847: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   15848:     } else {
1.463     albertel 15849: 	# if this isn't a robot, kill any existing non-robot sessions
                   15850: 	if (!$args->{'robot'}) {
                   15851: 	    opendir(DIR,$lonids);
                   15852: 	    while ($filename=readdir(DIR)) {
                   15853: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1075.2.136  raeburn  15854:                     if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
                   15855:                             &GDBM_READER(),0640)) {
                   15856:                         my $linkedfile;
                   15857:                         if (exists($oldenv{'user.linkedenv'})) {
                   15858:                             $linkedfile = $oldenv{'user.linkedenv'};
                   15859:                         }
                   15860:                         untie(%oldenv);
                   15861:                         if (unlink("$lonids/$filename")) {
                   15862:                             if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                   15863:                                 if (-l "$lonids/$linkedfile.id") {
                   15864:                                     unlink("$lonids/$linkedfile.id");
                   15865:                                 }
                   15866:                             }
                   15867:                         }
                   15868:                     } else {
                   15869:                         unlink($lonids.'/'.$filename);
                   15870:                     }
1.463     albertel 15871: 		}
1.462     albertel 15872: 	    }
1.463     albertel 15873: 	    closedir(DIR);
1.1075.2.84  raeburn  15874: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   15875:             my $namespace = 'nohist_courseeditor';
                   15876:             my $lockingkey = 'paste'."\0".'locked_num';
                   15877:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   15878:                                                 $domain,$username);
                   15879:             if (exists($lockhash{$lockingkey})) {
                   15880:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   15881:                 unless ($delresult eq 'ok') {
                   15882:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   15883:                 }
                   15884:             }
1.462     albertel 15885: 	}
                   15886: # Give them a new cookie
1.463     albertel 15887: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      15888: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 15889: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 15890:     
                   15891: # Initialize roles
                   15892: 
1.1062    raeburn  15893: 	($userroles,$firstaccenv,$timerintenv) = 
                   15894:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 15895:     }
                   15896: # ------------------------------------ Check browser type and MathML capability
                   15897: 
1.1075.2.77  raeburn  15898:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   15899:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 15900: 
                   15901: # ------------------------------------------------------------- Get environment
                   15902: 
                   15903:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   15904:     my ($tmp) = keys(%userenv);
                   15905:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   15906:     } else {
                   15907: 	undef(%userenv);
                   15908:     }
                   15909:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   15910: 	$form->{'interface'}=$userenv{'interface'};
                   15911:     }
                   15912:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   15913: 
                   15914: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   15915:     foreach my $option ('interface','localpath','localres') {
                   15916:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 15917:     }
                   15918: # --------------------------------------------------------- Write first profile
                   15919: 
                   15920:     {
1.1075.2.150  raeburn  15921:         my $ip = &Apache::lonnet::get_requestor_ip();
1.462     albertel 15922: 	my %initial_env = 
                   15923: 	    ("user.name"          => $username,
                   15924: 	     "user.domain"        => $domain,
                   15925: 	     "user.home"          => $authhost,
                   15926: 	     "browser.type"       => $clientbrowser,
                   15927: 	     "browser.version"    => $clientversion,
                   15928: 	     "browser.mathml"     => $clientmathml,
                   15929: 	     "browser.unicode"    => $clientunicode,
                   15930: 	     "browser.os"         => $clientos,
1.1075.2.42  raeburn  15931:              "browser.mobile"     => $clientmobile,
                   15932:              "browser.info"       => $clientinfo,
1.1075.2.77  raeburn  15933:              "browser.osversion"  => $clientosversion,
1.462     albertel 15934: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   15935: 	     "request.course.fn"  => '',
                   15936: 	     "request.course.uri" => '',
                   15937: 	     "request.course.sec" => '',
                   15938: 	     "request.role"       => 'cm',
                   15939: 	     "request.role.adv"   => $env{'user.adv'},
1.1075.2.150  raeburn  15940: 	     "request.host"       => $ip,);
1.462     albertel 15941: 
                   15942:         if ($form->{'localpath'}) {
                   15943: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   15944: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   15945:         }
                   15946: 	
                   15947: 	if ($form->{'interface'}) {
                   15948: 	    $form->{'interface'}=~s/\W//gs;
                   15949: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   15950: 	    $env{'browser.interface'}=$form->{'interface'};
                   15951: 	}
                   15952: 
1.1075.2.54  raeburn  15953:         if ($form->{'iptoken'}) {
                   15954:             my $lonhost = $r->dir_config('lonHostID');
                   15955:             $initial_env{"user.noloadbalance"} = $lonhost;
                   15956:             $env{'user.noloadbalance'} = $lonhost;
                   15957:         }
                   15958: 
1.1075.2.120  raeburn  15959:         if ($form->{'noloadbalance'}) {
                   15960:             my @hosts = &Apache::lonnet::current_machine_ids();
                   15961:             my $hosthere = $form->{'noloadbalance'};
                   15962:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   15963:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   15964:                 $env{'user.noloadbalance'} = $hosthere;
                   15965:             }
                   15966:         }
                   15967: 
1.1016    raeburn  15968:         unless ($domain eq 'public') {
1.1075.2.125  raeburn  15969:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   15970:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
1.980     raeburn  15971: 
1.1075.2.125  raeburn  15972:             foreach my $tool ('aboutme','blog','webdav','portfolio') {
                   15973:                 $userenv{'availabletools.'.$tool} = 
                   15974:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   15975:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   15976:             }
1.724     raeburn  15977: 
1.1075.2.125  raeburn  15978:             foreach my $crstype ('official','unofficial','community','textbook') {
                   15979:                 $userenv{'canrequest.'.$crstype} =
                   15980:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   15981:                                                       'reload','requestcourses',
                   15982:                                                       \%userenv,\%domdef,\%is_adv);
                   15983:             }
1.765     raeburn  15984: 
1.1075.2.125  raeburn  15985:             $userenv{'canrequest.author'} =
                   15986:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   15987:                                                   'reload','requestauthor',
                   15988:                                                   \%userenv,\%domdef,\%is_adv);
                   15989:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   15990:                                                  $domain,$username);
                   15991:             my $reqstatus = $reqauthor{'author_status'};
                   15992:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
                   15993:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   15994:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   15995:                                                       $reqauthor{'author'}{'timestamp'};
                   15996:                 }
1.1075.2.14  raeburn  15997:             }
                   15998:         }
                   15999: 
1.462     albertel 16000: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  16001: 
1.462     albertel 16002: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   16003: 		 &GDBM_WRCREAT(),0640)) {
                   16004: 	    &_add_to_env(\%disk_env,\%initial_env);
                   16005: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   16006: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  16007:             if (ref($firstaccenv) eq 'HASH') {
                   16008:                 &_add_to_env(\%disk_env,$firstaccenv);
                   16009:             }
                   16010:             if (ref($timerintenv) eq 'HASH') {
                   16011:                 &_add_to_env(\%disk_env,$timerintenv);
                   16012:             }
1.463     albertel 16013: 	    if (ref($args->{'extra_env'})) {
                   16014: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   16015: 	    }
1.462     albertel 16016: 	    untie(%disk_env);
                   16017: 	} else {
1.705     tempelho 16018: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   16019: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 16020: 	    return 'error: '.$!;
                   16021: 	}
                   16022:     }
                   16023:     $env{'request.role'}='cm';
                   16024:     $env{'request.role.adv'}=$env{'user.adv'};
                   16025:     $env{'browser.type'}=$clientbrowser;
                   16026: 
                   16027:     return $cookie;
                   16028: 
                   16029: }
                   16030: 
                   16031: sub _add_to_env {
                   16032:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  16033:     if (ref($env_data) eq 'HASH') {
                   16034:         while (my ($key,$value) = each(%$env_data)) {
                   16035: 	    $idf->{$prefix.$key} = $value;
                   16036: 	    $env{$prefix.$key}   = $value;
                   16037:         }
1.462     albertel 16038:     }
                   16039: }
                   16040: 
1.685     tempelho 16041: # --- Get the symbolic name of a problem and the url
                   16042: sub get_symb {
                   16043:     my ($request,$silent) = @_;
1.726     raeburn  16044:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 16045:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   16046:     if ($symb eq '') {
                   16047:         if (!$silent) {
1.1071    raeburn  16048:             if (ref($request)) { 
                   16049:                 $request->print("Unable to handle ambiguous references:$url:.");
                   16050:             }
1.685     tempelho 16051:             return ();
                   16052:         }
                   16053:     }
                   16054:     &Apache::lonenc::check_decrypt(\$symb);
                   16055:     return ($symb);
                   16056: }
                   16057: 
                   16058: # --------------------------------------------------------------Get annotation
                   16059: 
                   16060: sub get_annotation {
                   16061:     my ($symb,$enc) = @_;
                   16062: 
                   16063:     my $key = $symb;
                   16064:     if (!$enc) {
                   16065:         $key =
                   16066:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   16067:     }
                   16068:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   16069:     return $annotation{$key};
                   16070: }
                   16071: 
                   16072: sub clean_symb {
1.731     raeburn  16073:     my ($symb,$delete_enc) = @_;
1.685     tempelho 16074: 
                   16075:     &Apache::lonenc::check_decrypt(\$symb);
                   16076:     my $enc = $env{'request.enc'};
1.731     raeburn  16077:     if ($delete_enc) {
1.730     raeburn  16078:         delete($env{'request.enc'});
                   16079:     }
1.685     tempelho 16080: 
                   16081:     return ($symb,$enc);
                   16082: }
1.462     albertel 16083: 
1.1075.2.69  raeburn  16084: ############################################################
                   16085: ############################################################
                   16086: 
                   16087: =pod
                   16088: 
                   16089: =head1 Routines for building display used to search for courses
                   16090: 
                   16091: 
                   16092: =over 4
                   16093: 
                   16094: =item * &build_filters()
                   16095: 
                   16096: Create markup for a table used to set filters to use when selecting
                   16097: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   16098: and quotacheck.pl
                   16099: 
                   16100: 
                   16101: Inputs:
                   16102: 
                   16103: filterlist - anonymous array of fields to include as potential filters
                   16104: 
                   16105: crstype - course type
                   16106: 
                   16107: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   16108:               to pop-open a course selector (will contain "extra element").
                   16109: 
                   16110: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   16111: 
                   16112: filter - anonymous hash of criteria and their values
                   16113: 
                   16114: action - form action
                   16115: 
                   16116: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   16117: 
                   16118: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
                   16119: 
                   16120: cloneruname - username of owner of new course who wants to clone
                   16121: 
                   16122: clonerudom - domain of owner of new course who wants to clone
                   16123: 
                   16124: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
                   16125: 
                   16126: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   16127: 
                   16128: codedom - domain
                   16129: 
                   16130: formname - value of form element named "form".
                   16131: 
                   16132: fixeddom - domain, if fixed.
                   16133: 
                   16134: prevphase - value to assign to form element named "phase" when going back to the previous screen
                   16135: 
                   16136: cnameelement - name of form element in form on opener page which will receive title of selected course
                   16137: 
                   16138: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   16139: 
                   16140: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   16141: 
                   16142: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   16143: 
                   16144: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   16145: 
                   16146: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   16147: 
                   16148: 
                   16149: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   16150: 
                   16151: 
                   16152: Side Effects: None
                   16153: 
                   16154: =cut
                   16155: 
                   16156: # ---------------------------------------------- search for courses based on last activity etc.
                   16157: 
                   16158: sub build_filters {
                   16159:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   16160:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   16161:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   16162:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   16163:         $clonetext,$clonewarning) = @_;
                   16164:     my ($list,$jscript);
                   16165:     my $onchange = 'javascript:updateFilters(this)';
                   16166:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   16167:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   16168:         $typeselectform,$instcodetitle);
                   16169:     if ($formname eq '') {
                   16170:         $formname = $caller;
                   16171:     }
                   16172:     foreach my $item (@{$filterlist}) {
                   16173:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   16174:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   16175:             if ($item eq 'domainfilter') {
                   16176:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   16177:             } elsif ($item eq 'coursefilter') {
                   16178:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   16179:             } elsif ($item eq 'ownerfilter') {
                   16180:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16181:             } elsif ($item eq 'ownerdomfilter') {
                   16182:                 $filter->{'ownerdomfilter'} =
                   16183:                     &LONCAPA::clean_domain($filter->{$item});
                   16184:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   16185:                                                        'ownerdomfilter',1);
                   16186:             } elsif ($item eq 'personfilter') {
                   16187:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16188:             } elsif ($item eq 'persondomfilter') {
                   16189:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   16190:                                                         'persondomfilter',1);
                   16191:             } else {
                   16192:                 $filter->{$item} =~ s/\W//g;
                   16193:             }
                   16194:             if (!$filter->{$item}) {
                   16195:                 $filter->{$item} = '';
                   16196:             }
                   16197:         }
                   16198:         if ($item eq 'domainfilter') {
                   16199:             my $allow_blank = 1;
                   16200:             if ($formname eq 'portform') {
                   16201:                 $allow_blank=0;
                   16202:             } elsif ($formname eq 'studentform') {
                   16203:                 $allow_blank=0;
                   16204:             }
                   16205:             if ($fixeddom) {
                   16206:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   16207:                                     ' value="'.$codedom.'" />'.
                   16208:                                     &Apache::lonnet::domain($codedom,'description');
                   16209:             } else {
                   16210:                 $domainselectform = &select_dom_form($filter->{$item},
                   16211:                                                      'domainfilter',
                   16212:                                                       $allow_blank,'',$onchange);
                   16213:             }
                   16214:         } else {
                   16215:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   16216:         }
                   16217:     }
                   16218: 
                   16219:     # last course activity filter and selection
                   16220:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   16221: 
                   16222:     # course created filter and selection
                   16223:     if (exists($filter->{'createdfilter'})) {
                   16224:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   16225:     }
                   16226: 
                   16227:     my %lt = &Apache::lonlocal::texthash(
                   16228:                 'cac' => "$crstype Activity",
                   16229:                 'ccr' => "$crstype Created",
                   16230:                 'cde' => "$crstype Title",
                   16231:                 'cdo' => "$crstype Domain",
                   16232:                 'ins' => 'Institutional Code',
                   16233:                 'inc' => 'Institutional Categorization',
                   16234:                 'cow' => "$crstype Owner/Co-owner",
                   16235:                 'cop' => "$crstype Personnel Includes",
                   16236:                 'cog' => 'Type',
                   16237:              );
                   16238: 
                   16239:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16240:         my $typeval = 'Course';
                   16241:         if ($crstype eq 'Community') {
                   16242:             $typeval = 'Community';
                   16243:         }
                   16244:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   16245:     } else {
                   16246:         $typeselectform =  '<select name="type" size="1"';
                   16247:         if ($onchange) {
                   16248:             $typeselectform .= ' onchange="'.$onchange.'"';
                   16249:         }
                   16250:         $typeselectform .= '>'."\n";
                   16251:         foreach my $posstype ('Course','Community') {
                   16252:             $typeselectform.='<option value="'.$posstype.'"'.
                   16253:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
                   16254:         }
                   16255:         $typeselectform.="</select>";
                   16256:     }
                   16257: 
                   16258:     my ($cloneableonlyform,$cloneabletitle);
                   16259:     if (exists($filter->{'cloneableonly'})) {
                   16260:         my $cloneableon = '';
                   16261:         my $cloneableoff = ' checked="checked"';
                   16262:         if ($filter->{'cloneableonly'}) {
                   16263:             $cloneableon = $cloneableoff;
                   16264:             $cloneableoff = '';
                   16265:         }
                   16266:         $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>';
                   16267:         if ($formname eq 'ccrs') {
1.1075.2.71  raeburn  16268:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1075.2.69  raeburn  16269:         } else {
                   16270:             $cloneabletitle = &mt('Cloneable by you');
                   16271:         }
                   16272:     }
                   16273:     my $officialjs;
                   16274:     if ($crstype eq 'Course') {
                   16275:         if (exists($filter->{'instcodefilter'})) {
                   16276: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   16277: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   16278:             if ($codedom) {
                   16279:                 $officialjs = 1;
                   16280:                 ($instcodeform,$jscript,$$numtitlesref) =
                   16281:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   16282:                                                                   $officialjs,$codetitlesref);
                   16283:                 if ($jscript) {
                   16284:                     $jscript = '<script type="text/javascript">'."\n".
                   16285:                                '// <![CDATA['."\n".
                   16286:                                $jscript."\n".
                   16287:                                '// ]]>'."\n".
                   16288:                                '</script>'."\n";
                   16289:                 }
                   16290:             }
                   16291:             if ($instcodeform eq '') {
                   16292:                 $instcodeform =
                   16293:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   16294:                     $list->{'instcodefilter'}.'" />';
                   16295:                 $instcodetitle = $lt{'ins'};
                   16296:             } else {
                   16297:                 $instcodetitle = $lt{'inc'};
                   16298:             }
                   16299:             if ($fixeddom) {
                   16300:                 $instcodetitle .= '<br />('.$codedom.')';
                   16301:             }
                   16302:         }
                   16303:     }
                   16304:     my $output = qq|
                   16305: <form method="post" name="filterpicker" action="$action">
                   16306: <input type="hidden" name="form" value="$formname" />
                   16307: |;
                   16308:     if ($formname eq 'modifycourse') {
                   16309:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   16310:                    '<input type="hidden" name="prevphase" value="'.
                   16311:                    $prevphase.'" />'."\n";
1.1075.2.82  raeburn  16312:     } elsif ($formname eq 'quotacheck') {
                   16313:         $output .= qq|
                   16314: <input type="hidden" name="sortby" value="" />
                   16315: <input type="hidden" name="sortorder" value="" />
                   16316: |;
                   16317:     } else {
1.1075.2.69  raeburn  16318:         my $name_input;
                   16319:         if ($cnameelement ne '') {
                   16320:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   16321:                           $cnameelement.'" />';
                   16322:         }
                   16323:         $output .= qq|
                   16324: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   16325: <input type="hidden" name="cdomelement" value="$cdomelement" />
                   16326: $name_input
                   16327: $roleelement
                   16328: $multelement
                   16329: $typeelement
                   16330: |;
                   16331:         if ($formname eq 'portform') {
                   16332:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   16333:         }
                   16334:     }
                   16335:     if ($fixeddom) {
                   16336:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   16337:     }
                   16338:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   16339:     if ($sincefilterform) {
                   16340:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   16341:                   .$sincefilterform
                   16342:                   .&Apache::lonhtmlcommon::row_closure();
                   16343:     }
                   16344:     if ($createdfilterform) {
                   16345:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   16346:                   .$createdfilterform
                   16347:                   .&Apache::lonhtmlcommon::row_closure();
                   16348:     }
                   16349:     if ($domainselectform) {
                   16350:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   16351:                   .$domainselectform
                   16352:                   .&Apache::lonhtmlcommon::row_closure();
                   16353:     }
                   16354:     if ($typeselectform) {
                   16355:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16356:             $output .= $typeselectform;
                   16357:         } else {
                   16358:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   16359:                       .$typeselectform
                   16360:                       .&Apache::lonhtmlcommon::row_closure();
                   16361:         }
                   16362:     }
                   16363:     if ($instcodeform) {
                   16364:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   16365:                   .$instcodeform
                   16366:                   .&Apache::lonhtmlcommon::row_closure();
                   16367:     }
                   16368:     if (exists($filter->{'ownerfilter'})) {
                   16369:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   16370:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16371:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   16372:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16373:                    $ownerdomselectform.'</td></tr></table>'.
                   16374:                    &Apache::lonhtmlcommon::row_closure();
                   16375:     }
                   16376:     if (exists($filter->{'personfilter'})) {
                   16377:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   16378:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16379:                    '<input type="text" name="personfilter" size="20" value="'.
                   16380:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16381:                    $persondomselectform.'</td></tr></table>'.
                   16382:                    &Apache::lonhtmlcommon::row_closure();
                   16383:     }
                   16384:     if (exists($filter->{'coursefilter'})) {
                   16385:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   16386:                   .'<input type="text" name="coursefilter" size="25" value="'
                   16387:                   .$list->{'coursefilter'}.'" />'
                   16388:                   .&Apache::lonhtmlcommon::row_closure();
                   16389:     }
                   16390:     if ($cloneableonlyform) {
                   16391:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   16392:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   16393:     }
                   16394:     if (exists($filter->{'descriptfilter'})) {
                   16395:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   16396:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   16397:                   .$list->{'descriptfilter'}.'" />'
                   16398:                   .&Apache::lonhtmlcommon::row_closure(1);
                   16399:     }
                   16400:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   16401:                '<input type="hidden" name="updater" value="" />'."\n".
                   16402:                '<input type="submit" name="gosearch" value="'.
                   16403:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   16404:     return $jscript.$clonewarning.$output;
                   16405: }
                   16406: 
                   16407: =pod
                   16408: 
                   16409: =item * &timebased_select_form()
                   16410: 
                   16411: Create markup for a dropdown list used to select a time-based
                   16412: filter e.g., Course Activity, Course Created, when searching for courses
                   16413: or communities
                   16414: 
                   16415: Inputs:
                   16416: 
                   16417: item - name of form element (sincefilter or createdfilter)
                   16418: 
                   16419: filter - anonymous hash of criteria and their values
                   16420: 
                   16421: Returns: HTML for a select box contained a blank, then six time selections,
                   16422:          with value set in incoming form variables currently selected.
                   16423: 
                   16424: Side Effects: None
                   16425: 
                   16426: =cut
                   16427: 
                   16428: sub timebased_select_form {
                   16429:     my ($item,$filter) = @_;
                   16430:     if (ref($filter) eq 'HASH') {
                   16431:         $filter->{$item} =~ s/[^\d-]//g;
                   16432:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   16433:         return &select_form(
                   16434:                             $filter->{$item},
                   16435:                             $item,
                   16436:                             {      '-1' => '',
                   16437:                                 '86400' => &mt('today'),
                   16438:                                '604800' => &mt('last week'),
                   16439:                               '2592000' => &mt('last month'),
                   16440:                               '7776000' => &mt('last three months'),
                   16441:                              '15552000' => &mt('last six months'),
                   16442:                              '31104000' => &mt('last year'),
                   16443:                     'select_form_order' =>
                   16444:                            ['-1','86400','604800','2592000','7776000',
                   16445:                             '15552000','31104000']});
                   16446:     }
                   16447: }
                   16448: 
                   16449: =pod
                   16450: 
                   16451: =item * &js_changer()
                   16452: 
                   16453: Create script tag containing Javascript used to submit course search form
                   16454: when course type or domain is changed, and also to hide 'Searching ...' on
                   16455: page load completion for page showing search result.
                   16456: 
                   16457: Inputs: None
                   16458: 
                   16459: Returns: markup containing updateFilters() and hideSearching() javascript functions.
                   16460: 
                   16461: Side Effects: None
                   16462: 
                   16463: =cut
                   16464: 
                   16465: sub js_changer {
                   16466:     return <<ENDJS;
                   16467: <script type="text/javascript">
                   16468: // <![CDATA[
                   16469: function updateFilters(caller) {
                   16470:     if (typeof(caller) != "undefined") {
                   16471:         document.filterpicker.updater.value = caller.name;
                   16472:     }
                   16473:     document.filterpicker.submit();
                   16474: }
                   16475: 
                   16476: function hideSearching() {
                   16477:     if (document.getElementById('searching')) {
                   16478:         document.getElementById('searching').style.display = 'none';
                   16479:     }
                   16480:     return;
                   16481: }
                   16482: 
                   16483: // ]]>
                   16484: </script>
                   16485: 
                   16486: ENDJS
                   16487: }
                   16488: 
                   16489: =pod
                   16490: 
                   16491: =item * &search_courses()
                   16492: 
                   16493: Process selected filters form course search form and pass to lonnet::courseiddump
                   16494: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   16495: 
                   16496: Inputs:
                   16497: 
                   16498: dom - domain being searched
                   16499: 
                   16500: type - course type ('Course' or 'Community' or '.' if any).
                   16501: 
                   16502: filter - anonymous hash of criteria and their values
                   16503: 
                   16504: numtitles - for institutional codes - number of categories
                   16505: 
                   16506: cloneruname - optional username of new course owner
                   16507: 
                   16508: clonerudom - optional domain of new course owner
                   16509: 
1.1075.2.95  raeburn  16510: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1075.2.69  raeburn  16511:             (used when DC is using course creation form)
                   16512: 
                   16513: codetitles - reference to array of titles of components in institutional codes (official courses).
                   16514: 
1.1075.2.95  raeburn  16515: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   16516:            (and so can clone automatically)
                   16517: 
                   16518: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   16519: 
                   16520: reqinstcode - institutional code of new course, where search_courses is used to identify potential
                   16521:               courses to clone
1.1075.2.69  raeburn  16522: 
                   16523: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   16524: 
                   16525: 
                   16526: Side Effects: None
                   16527: 
                   16528: =cut
                   16529: 
                   16530: 
                   16531: sub search_courses {
1.1075.2.95  raeburn  16532:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   16533:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1075.2.69  raeburn  16534:     my (%courses,%showcourses,$cloner);
                   16535:     if (($filter->{'ownerfilter'} ne '') ||
                   16536:         ($filter->{'ownerdomfilter'} ne '')) {
                   16537:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   16538:                                        $filter->{'ownerdomfilter'};
                   16539:     }
                   16540:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   16541:         if (!$filter->{$item}) {
                   16542:             $filter->{$item}='.';
                   16543:         }
                   16544:     }
                   16545:     my $now = time;
                   16546:     my $timefilter =
                   16547:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   16548:     my ($createdbefore,$createdafter);
                   16549:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   16550:         $createdbefore = $now;
                   16551:         $createdafter = $now-$filter->{'createdfilter'};
                   16552:     }
                   16553:     my ($instcodefilter,$regexpok);
                   16554:     if ($numtitles) {
                   16555:         if ($env{'form.official'} eq 'on') {
                   16556:             $instcodefilter =
                   16557:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16558:             $regexpok = 1;
                   16559:         } elsif ($env{'form.official'} eq 'off') {
                   16560:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16561:             unless ($instcodefilter eq '') {
                   16562:                 $regexpok = -1;
                   16563:             }
                   16564:         }
                   16565:     } else {
                   16566:         $instcodefilter = $filter->{'instcodefilter'};
                   16567:     }
                   16568:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   16569:     if ($type eq '') { $type = '.'; }
                   16570: 
                   16571:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   16572:         $cloner = $cloneruname.':'.$clonerudom;
                   16573:     }
                   16574:     %courses = &Apache::lonnet::courseiddump($dom,
                   16575:                                              $filter->{'descriptfilter'},
                   16576:                                              $timefilter,
                   16577:                                              $instcodefilter,
                   16578:                                              $filter->{'combownerfilter'},
                   16579:                                              $filter->{'coursefilter'},
                   16580:                                              undef,undef,$type,$regexpok,undef,undef,
1.1075.2.95  raeburn  16581:                                              undef,undef,$cloner,$cc_clone,
1.1075.2.69  raeburn  16582:                                              $filter->{'cloneableonly'},
                   16583:                                              $createdbefore,$createdafter,undef,
1.1075.2.95  raeburn  16584:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1075.2.69  raeburn  16585:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   16586:         my $ccrole;
                   16587:         if ($type eq 'Community') {
                   16588:             $ccrole = 'co';
                   16589:         } else {
                   16590:             $ccrole = 'cc';
                   16591:         }
                   16592:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   16593:                                                      $filter->{'persondomfilter'},
                   16594:                                                      'userroles',undef,
                   16595:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   16596:                                                      $dom);
                   16597:         foreach my $role (keys(%rolehash)) {
                   16598:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   16599:             my $cid = $cdom.'_'.$cnum;
                   16600:             if (exists($courses{$cid})) {
                   16601:                 if (ref($courses{$cid}) eq 'HASH') {
                   16602:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   16603:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1075.2.119  raeburn  16604:                             push(@{$courses{$cid}{roles}},$courserole);
1.1075.2.69  raeburn  16605:                         }
                   16606:                     } else {
                   16607:                         $courses{$cid}{roles} = [$courserole];
                   16608:                     }
                   16609:                     $showcourses{$cid} = $courses{$cid};
                   16610:                 }
                   16611:             }
                   16612:         }
                   16613:         %courses = %showcourses;
                   16614:     }
                   16615:     return %courses;
                   16616: }
                   16617: 
                   16618: =pod
                   16619: 
                   16620: =back
                   16621: 
1.1075.2.88  raeburn  16622: =head1 Routines for version requirements for current course.
                   16623: 
                   16624: =over 4
                   16625: 
                   16626: =item * &check_release_required()
                   16627: 
                   16628: Compares required LON-CAPA version with version on server, and
                   16629: if required version is newer looks for a server with the required version.
                   16630: 
                   16631: Looks first at servers in user's owen domain; if none suitable, looks at
                   16632: servers in course's domain are permitted to host sessions for user's domain.
                   16633: 
                   16634: Inputs:
                   16635: 
                   16636: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16637: 
                   16638: $courseid - Course ID of current course
                   16639: 
                   16640: $rolecode - User's current role in course (for switchserver query string).
                   16641: 
                   16642: $required - LON-CAPA version needed by course (format: Major.Minor).
                   16643: 
                   16644: 
                   16645: Returns:
                   16646: 
                   16647: $switchserver - query string tp append to /adm/switchserver call (if
                   16648:                 current server's LON-CAPA version is too old.
                   16649: 
                   16650: $warning - Message is displayed if no suitable server could be found.
                   16651: 
                   16652: =cut
                   16653: 
                   16654: sub check_release_required {
                   16655:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   16656:     my ($switchserver,$warning);
                   16657:     if ($required ne '') {
                   16658:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   16659:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16660:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   16661:             my $otherserver;
                   16662:             if (($major eq '' && $minor eq '') ||
                   16663:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   16664:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   16665:                 my $switchlcrev =
                   16666:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   16667:                                                            $userdomserver);
                   16668:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16669:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   16670:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   16671:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   16672:                     if ($cdom ne $env{'user.domain'}) {
                   16673:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   16674:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   16675:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   16676:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   16677:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   16678:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   16679:                         my $canhost =
                   16680:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   16681:                                                               $coursedomserver,
                   16682:                                                               $remoterev,
                   16683:                                                               $udomdefaults{'remotesessions'},
                   16684:                                                               $defdomdefaults{'hostedsessions'});
                   16685: 
                   16686:                         if ($canhost) {
                   16687:                             $otherserver = $coursedomserver;
                   16688:                         } else {
                   16689:                             $warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$courseid.'.internal.releaserequired'}).'<br />'. &mt("No suitable server could be found amongst servers in either your own domain or in the course's domain.");
                   16690:                         }
                   16691:                     } else {
                   16692:                         $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).");
                   16693:                     }
                   16694:                 } else {
                   16695:                     $otherserver = $userdomserver;
                   16696:                 }
                   16697:             }
                   16698:             if ($otherserver ne '') {
                   16699:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   16700:             }
                   16701:         }
                   16702:     }
                   16703:     return ($switchserver,$warning);
                   16704: }
                   16705: 
                   16706: =pod
                   16707: 
                   16708: =item * &check_release_result()
                   16709: 
                   16710: Inputs:
                   16711: 
                   16712: $switchwarning - Warning message if no suitable server found to host session.
                   16713: 
                   16714: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   16715:                 and current role.
                   16716: 
                   16717: Returns: HTML to display with information about requirement to switch server.
                   16718:          Either displaying warning with link to Roles/Courses screen or
                   16719:          display link to switchserver.
                   16720: 
1.1075.2.69  raeburn  16721: =cut
                   16722: 
1.1075.2.88  raeburn  16723: sub check_release_result {
                   16724:     my ($switchwarning,$switchserver) = @_;
                   16725:     my $output = &start_page('Selected course unavailable on this server').
                   16726:                  '<p class="LC_warning">';
                   16727:     if ($switchwarning) {
                   16728:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   16729:         if (&show_course()) {
                   16730:             $output .= &mt('Display courses');
                   16731:         } else {
                   16732:             $output .= &mt('Display roles');
                   16733:         }
                   16734:         $output .= '</a>';
                   16735:     } elsif ($switchserver) {
                   16736:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   16737:                    '<br />'.
                   16738:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   16739:                    &mt('Switch Server').
                   16740:                    '</a>';
                   16741:     }
                   16742:     $output .= '</p>'.&end_page();
                   16743:     return $output;
                   16744: }
                   16745: 
                   16746: =pod
                   16747: 
                   16748: =item * &needs_coursereinit()
                   16749: 
                   16750: Determine if course contents stored for user's session needs to be
                   16751: refreshed, because content has changed since "Big Hash" last tied.
                   16752: 
                   16753: Check for change is made if time last checked is more than 10 minutes ago
                   16754: (by default).
                   16755: 
                   16756: Inputs:
                   16757: 
                   16758: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16759: 
                   16760: $interval (optional) - Time which may elapse (in s) between last check for content
                   16761:                        change in current course. (default: 600 s).
                   16762: 
                   16763: Returns: an array; first element is:
                   16764: 
                   16765: =over 4
                   16766: 
                   16767: 'switch' - if content updates mean user's session
                   16768:            needs to be switched to a server running a newer LON-CAPA version
                   16769: 
                   16770: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   16771:            on current server hosting user's session
                   16772: 
                   16773: ''       - if no action required.
                   16774: 
                   16775: =back
                   16776: 
                   16777: If first item element is 'switch':
                   16778: 
                   16779: second item is $switchwarning - Warning message if no suitable server found to host session.
                   16780: 
                   16781: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   16782:                               and current role.
                   16783: 
                   16784: otherwise: no other elements returned.
                   16785: 
                   16786: =back
                   16787: 
                   16788: =cut
                   16789: 
                   16790: sub needs_coursereinit {
                   16791:     my ($loncaparev,$interval) = @_;
                   16792:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   16793:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   16794:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   16795:     my $now = time;
                   16796:     if ($interval eq '') {
                   16797:         $interval = 600;
                   16798:     }
                   16799:     if (($now-$env{'request.course.timechecked'})>$interval) {
                   16800:         my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
                   16801:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
                   16802:         if ($lastchange > $env{'request.course.tied'}) {
                   16803:             my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   16804:             if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   16805:                 my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   16806:                 if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   16807:                     &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   16808:                                              $curr_reqd_hash{'internal.releaserequired'}});
                   16809:                     my ($switchserver,$switchwarning) =
                   16810:                         &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   16811:                                                 $curr_reqd_hash{'internal.releaserequired'});
                   16812:                     if ($switchwarning ne '' || $switchserver ne '') {
                   16813:                         return ('switch',$switchwarning,$switchserver);
                   16814:                     }
                   16815:                 }
                   16816:             }
                   16817:             return ('update');
                   16818:         }
                   16819:     }
                   16820:     return ();
                   16821: }
1.1075.2.69  raeburn  16822: 
1.1075.2.11  raeburn  16823: sub update_content_constraints {
                   16824:     my ($cdom,$cnum,$chome,$cid) = @_;
                   16825:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   16826:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   16827:     my %checkresponsetypes;
                   16828:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   16829:         my ($item,$name,$value) = split(/:/,$key);
                   16830:         if ($item eq 'resourcetag') {
                   16831:             if ($name eq 'responsetype') {
                   16832:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   16833:             }
                   16834:         }
                   16835:     }
                   16836:     my $navmap = Apache::lonnavmaps::navmap->new();
                   16837:     if (defined($navmap)) {
                   16838:         my %allresponses;
                   16839:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
                   16840:             my %responses = $res->responseTypes();
                   16841:             foreach my $key (keys(%responses)) {
                   16842:                 next unless(exists($checkresponsetypes{$key}));
                   16843:                 $allresponses{$key} += $responses{$key};
                   16844:             }
                   16845:         }
                   16846:         foreach my $key (keys(%allresponses)) {
                   16847:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   16848:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   16849:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   16850:             }
                   16851:         }
                   16852:         undef($navmap);
                   16853:     }
                   16854:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   16855:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   16856:     }
                   16857:     return;
                   16858: }
                   16859: 
1.1075.2.27  raeburn  16860: sub allmaps_incourse {
                   16861:     my ($cdom,$cnum,$chome,$cid) = @_;
                   16862:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   16863:         $cid = $env{'request.course.id'};
                   16864:         $cdom = $env{'course.'.$cid.'.domain'};
                   16865:         $cnum = $env{'course.'.$cid.'.num'};
                   16866:         $chome = $env{'course.'.$cid.'.home'};
                   16867:     }
                   16868:     my %allmaps = ();
                   16869:     my $lastchange =
                   16870:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   16871:     if ($lastchange > $env{'request.course.tied'}) {
                   16872:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   16873:         unless ($ferr) {
                   16874:             &update_content_constraints($cdom,$cnum,$chome,$cid);
                   16875:         }
                   16876:     }
                   16877:     my $navmap = Apache::lonnavmaps::navmap->new();
                   16878:     if (defined($navmap)) {
                   16879:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   16880:             $allmaps{$res->src()} = 1;
                   16881:         }
                   16882:     }
                   16883:     return \%allmaps;
                   16884: }
                   16885: 
1.1075.2.11  raeburn  16886: sub parse_supplemental_title {
                   16887:     my ($title) = @_;
                   16888: 
                   16889:     my ($foldertitle,$renametitle);
                   16890:     if ($title =~ /&amp;&amp;&amp;/) {
                   16891:         $title = &HTML::Entites::decode($title);
                   16892:     }
                   16893:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   16894:         $renametitle=$4;
                   16895:         my ($time,$uname,$udom) = ($1,$2,$3);
                   16896:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   16897:         my $name =  &plainname($uname,$udom);
                   16898:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   16899:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
                   16900:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
                   16901:             $name.': <br />'.$foldertitle;
                   16902:     }
                   16903:     if (wantarray) {
                   16904:         return ($title,$foldertitle,$renametitle);
                   16905:     }
                   16906:     return $title;
                   16907: }
                   16908: 
1.1075.2.43  raeburn  16909: sub recurse_supplemental {
                   16910:     my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
                   16911:     if ($suppmap) {
                   16912:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   16913:         if ($fatal) {
                   16914:             $errors ++;
                   16915:         } else {
                   16916:             if ($#LONCAPA::map::resources > 0) {
                   16917:                 foreach my $res (@LONCAPA::map::resources) {
                   16918:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
                   16919:                     if (($src ne '') && ($status eq 'res')) {
1.1075.2.46  raeburn  16920:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
                   16921:                             ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1075.2.43  raeburn  16922:                         } else {
                   16923:                             $numfiles ++;
                   16924:                         }
                   16925:                     }
                   16926:                 }
                   16927:             }
                   16928:         }
                   16929:     }
                   16930:     return ($numfiles,$errors);
                   16931: }
                   16932: 
1.1075.2.18  raeburn  16933: sub symb_to_docspath {
1.1075.2.119  raeburn  16934:     my ($symb,$navmapref) = @_;
                   16935:     return unless ($symb && ref($navmapref));
1.1075.2.18  raeburn  16936:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   16937:     if ($resurl=~/\.(sequence|page)$/) {
                   16938:         $mapurl=$resurl;
                   16939:     } elsif ($resurl eq 'adm/navmaps') {
                   16940:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   16941:     }
                   16942:     my $mapresobj;
1.1075.2.119  raeburn  16943:     unless (ref($$navmapref)) {
                   16944:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   16945:     }
                   16946:     if (ref($$navmapref)) {
                   16947:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1075.2.18  raeburn  16948:     }
                   16949:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   16950:     my $type=$2;
                   16951:     my $path;
                   16952:     if (ref($mapresobj)) {
                   16953:         my $pcslist = $mapresobj->map_hierarchy();
                   16954:         if ($pcslist ne '') {
                   16955:             foreach my $pc (split(/,/,$pcslist)) {
                   16956:                 next if ($pc <= 1);
1.1075.2.119  raeburn  16957:                 my $res = $$navmapref->getByMapPc($pc);
1.1075.2.18  raeburn  16958:                 if (ref($res)) {
                   16959:                     my $thisurl = $res->src();
                   16960:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   16961:                     my $thistitle = $res->title();
                   16962:                     $path .= '&'.
                   16963:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1075.2.46  raeburn  16964:                              &escape($thistitle).
1.1075.2.18  raeburn  16965:                              ':'.$res->randompick().
                   16966:                              ':'.$res->randomout().
                   16967:                              ':'.$res->encrypted().
                   16968:                              ':'.$res->randomorder().
                   16969:                              ':'.$res->is_page();
                   16970:                 }
                   16971:             }
                   16972:         }
                   16973:         $path =~ s/^\&//;
                   16974:         my $maptitle = $mapresobj->title();
                   16975:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  16976:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  16977:         }
                   16978:         $path .= (($path ne '')? '&' : '').
                   16979:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  16980:                  &escape($maptitle).
1.1075.2.18  raeburn  16981:                  ':'.$mapresobj->randompick().
                   16982:                  ':'.$mapresobj->randomout().
                   16983:                  ':'.$mapresobj->encrypted().
                   16984:                  ':'.$mapresobj->randomorder().
                   16985:                  ':'.$mapresobj->is_page();
                   16986:     } else {
                   16987:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   16988:         my $ispage = (($type eq 'page')? 1 : '');
                   16989:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  16990:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  16991:         }
                   16992:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  16993:                 &escape($maptitle).':::::'.$ispage;
1.1075.2.18  raeburn  16994:     }
                   16995:     unless ($mapurl eq 'default') {
                   16996:         $path = 'default&'.
1.1075.2.46  raeburn  16997:                 &escape('Main Content').
1.1075.2.18  raeburn  16998:                 ':::::&'.$path;
                   16999:     }
                   17000:     return $path;
                   17001: }
                   17002: 
1.1075.2.14  raeburn  17003: sub captcha_display {
1.1075.2.137  raeburn  17004:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17005:     my ($output,$error);
1.1075.2.107  raeburn  17006:     my ($captcha,$pubkey,$privkey,$version) =
1.1075.2.137  raeburn  17007:         &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17008:     if ($captcha eq 'original') {
                   17009:         $output = &create_captcha();
                   17010:         unless ($output) {
                   17011:             $error = 'captcha';
                   17012:         }
                   17013:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17014:         $output = &create_recaptcha($pubkey,$version);
1.1075.2.14  raeburn  17015:         unless ($output) {
                   17016:             $error = 'recaptcha';
                   17017:         }
                   17018:     }
1.1075.2.107  raeburn  17019:     return ($output,$error,$captcha,$version);
1.1075.2.14  raeburn  17020: }
                   17021: 
                   17022: sub captcha_response {
1.1075.2.137  raeburn  17023:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17024:     my ($captcha_chk,$captcha_error);
1.1075.2.137  raeburn  17025:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17026:     if ($captcha eq 'original') {
                   17027:         ($captcha_chk,$captcha_error) = &check_captcha();
                   17028:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17029:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1075.2.14  raeburn  17030:     } else {
                   17031:         $captcha_chk = 1;
                   17032:     }
                   17033:     return ($captcha_chk,$captcha_error);
                   17034: }
                   17035: 
                   17036: sub get_captcha_config {
1.1075.2.137  raeburn  17037:     my ($context,$lonhost,$dom_in_effect) = @_;
1.1075.2.107  raeburn  17038:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1075.2.14  raeburn  17039:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   17040:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   17041:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   17042:     if ($context eq 'usercreation') {
                   17043:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   17044:         if (ref($domconfig{$context}) eq 'HASH') {
                   17045:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   17046:             if (ref($hashtocheck) eq 'HASH') {
                   17047:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   17048:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   17049:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   17050:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   17051:                     }
                   17052:                     if ($privkey && $pubkey) {
                   17053:                         $captcha = 'recaptcha';
1.1075.2.107  raeburn  17054:                         $version = $hashtocheck->{'recaptchaversion'};
                   17055:                         if ($version ne '2') {
                   17056:                             $version = 1;
                   17057:                         }
1.1075.2.14  raeburn  17058:                     } else {
                   17059:                         $captcha = 'original';
                   17060:                     }
                   17061:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   17062:                     $captcha = 'original';
                   17063:                 }
                   17064:             }
                   17065:         } else {
                   17066:             $captcha = 'captcha';
                   17067:         }
                   17068:     } elsif ($context eq 'login') {
                   17069:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   17070:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   17071:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   17072:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
                   17073:             if ($privkey && $pubkey) {
                   17074:                 $captcha = 'recaptcha';
1.1075.2.107  raeburn  17075:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   17076:                 if ($version ne '2') {
                   17077:                     $version = 1;
                   17078:                 }
1.1075.2.14  raeburn  17079:             } else {
                   17080:                 $captcha = 'original';
                   17081:             }
                   17082:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   17083:             $captcha = 'original';
                   17084:         }
1.1075.2.137  raeburn  17085:     } elsif ($context eq 'passwords') {
                   17086:         if ($dom_in_effect) {
                   17087:             my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
                   17088:             if ($passwdconf{'captcha'} eq 'recaptcha') {
                   17089:                 if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
                   17090:                     $pubkey = $passwdconf{'recaptchakeys'}{'public'};
                   17091:                     $privkey = $passwdconf{'recaptchakeys'}{'private'};
                   17092:                 }
                   17093:                 if ($privkey && $pubkey) {
                   17094:                     $captcha = 'recaptcha';
                   17095:                     $version = $passwdconf{'recaptchaversion'};
                   17096:                     if ($version ne '2') {
                   17097:                         $version = 1;
                   17098:                     }
                   17099:                 } else {
                   17100:                     $captcha = 'original';
                   17101:                 }
                   17102:             } elsif ($passwdconf{'captcha'} ne 'notused') {
                   17103:                 $captcha = 'original';
                   17104:             }
                   17105:         }
1.1075.2.14  raeburn  17106:     }
1.1075.2.107  raeburn  17107:     return ($captcha,$pubkey,$privkey,$version);
1.1075.2.14  raeburn  17108: }
                   17109: 
                   17110: sub create_captcha {
                   17111:     my %captcha_params = &captcha_settings();
                   17112:     my ($output,$maxtries,$tries) = ('',10,0);
                   17113:     while ($tries < $maxtries) {
                   17114:         $tries ++;
                   17115:         my $captcha = Authen::Captcha->new (
                   17116:                                            output_folder => $captcha_params{'output_dir'},
                   17117:                                            data_folder   => $captcha_params{'db_dir'},
                   17118:                                           );
                   17119:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   17120: 
                   17121:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   17122:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
                   17123:                       &mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1075.2.66  raeburn  17124:                       '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
                   17125:                       '<br />'.
                   17126:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1075.2.14  raeburn  17127:             last;
                   17128:         }
                   17129:     }
                   17130:     return $output;
                   17131: }
                   17132: 
                   17133: sub captcha_settings {
                   17134:     my %captcha_params = (
                   17135:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   17136:                            www_output_dir => "/captchaspool",
                   17137:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   17138:                            numchars       => '5',
                   17139:                          );
                   17140:     return %captcha_params;
                   17141: }
                   17142: 
                   17143: sub check_captcha {
                   17144:     my ($captcha_chk,$captcha_error);
                   17145:     my $code = $env{'form.code'};
                   17146:     my $md5sum = $env{'form.crypt'};
                   17147:     my %captcha_params = &captcha_settings();
                   17148:     my $captcha = Authen::Captcha->new(
                   17149:                       output_folder => $captcha_params{'output_dir'},
                   17150:                       data_folder   => $captcha_params{'db_dir'},
                   17151:                   );
1.1075.2.26  raeburn  17152:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14  raeburn  17153:     my %captcha_hash = (
                   17154:                         0       => 'Code not checked (file error)',
                   17155:                        -1      => 'Failed: code expired',
                   17156:                        -2      => 'Failed: invalid code (not in database)',
                   17157:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   17158:     );
                   17159:     if ($captcha_chk != 1) {
                   17160:         $captcha_error = $captcha_hash{$captcha_chk}
                   17161:     }
                   17162:     return ($captcha_chk,$captcha_error);
                   17163: }
                   17164: 
                   17165: sub create_recaptcha {
1.1075.2.107  raeburn  17166:     my ($pubkey,$version) = @_;
                   17167:     if ($version >= 2) {
                   17168:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>';
                   17169:     } else {
                   17170:         my $use_ssl;
                   17171:         if ($ENV{'SERVER_PORT'} == 443) {
                   17172:             $use_ssl = 1;
                   17173:         }
                   17174:         my $captcha = Captcha::reCAPTCHA->new;
                   17175:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   17176:                $captcha->get_html($pubkey,undef,$use_ssl).
                   17177:                &mt('If the text is hard to read, [_1] will replace them.',
                   17178:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   17179:                '<br /><br />';
                   17180:      }
1.1075.2.14  raeburn  17181: }
                   17182: 
                   17183: sub check_recaptcha {
1.1075.2.107  raeburn  17184:     my ($privkey,$version) = @_;
1.1075.2.14  raeburn  17185:     my $captcha_chk;
1.1075.2.150  raeburn  17186:     my $ip = &Apache::lonnet::get_requestor_ip(); 
1.1075.2.107  raeburn  17187:     if ($version >= 2) {
                   17188:         my $ua = LWP::UserAgent->new;
                   17189:         $ua->timeout(10);
                   17190:         my %info = (
                   17191:                      secret   => $privkey,
                   17192:                      response => $env{'form.g-recaptcha-response'},
1.1075.2.150  raeburn  17193:                      remoteip => $ip,
1.1075.2.107  raeburn  17194:                    );
                   17195:         my $response = $ua->post('https://www.google.com/recaptcha/api/siteverify',\%info);
                   17196:         if ($response->is_success)  {
                   17197:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   17198:             if (ref($data) eq 'HASH') {
                   17199:                 if ($data->{'success'}) {
                   17200:                     $captcha_chk = 1;
                   17201:                 }
                   17202:             }
                   17203:         }
                   17204:     } else {
                   17205:         my $captcha = Captcha::reCAPTCHA->new;
                   17206:         my $captcha_result =
                   17207:             $captcha->check_answer(
                   17208:                                     $privkey,
1.1075.2.150  raeburn  17209:                                     $ip,
1.1075.2.107  raeburn  17210:                                     $env{'form.recaptcha_challenge_field'},
                   17211:                                     $env{'form.recaptcha_response_field'},
                   17212:                                   );
                   17213:         if ($captcha_result->{is_valid}) {
                   17214:             $captcha_chk = 1;
                   17215:         }
1.1075.2.14  raeburn  17216:     }
                   17217:     return $captcha_chk;
                   17218: }
                   17219: 
1.1075.2.64  raeburn  17220: sub emailusername_info {
1.1075.2.103  raeburn  17221:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1075.2.64  raeburn  17222:     my %titles = &Apache::lonlocal::texthash (
                   17223:                      lastname      => 'Last Name',
                   17224:                      firstname     => 'First Name',
                   17225:                      institution   => 'School/college/university',
                   17226:                      location      => "School's city, state/province, country",
                   17227:                      web           => "School's web address",
                   17228:                      officialemail => 'E-mail address at institution (if different)',
1.1075.2.103  raeburn  17229:                      id            => 'Student/Employee ID',
1.1075.2.64  raeburn  17230:                  );
                   17231:     return (\@fields,\%titles);
                   17232: }
                   17233: 
1.1075.2.56  raeburn  17234: sub cleanup_html {
                   17235:     my ($incoming) = @_;
                   17236:     my $outgoing;
                   17237:     if ($incoming ne '') {
                   17238:         $outgoing = $incoming;
                   17239:         $outgoing =~ s/;/&#059;/g;
                   17240:         $outgoing =~ s/\#/&#035;/g;
                   17241:         $outgoing =~ s/\&/&#038;/g;
                   17242:         $outgoing =~ s/</&#060;/g;
                   17243:         $outgoing =~ s/>/&#062;/g;
                   17244:         $outgoing =~ s/\(/&#040/g;
                   17245:         $outgoing =~ s/\)/&#041;/g;
                   17246:         $outgoing =~ s/"/&#034;/g;
                   17247:         $outgoing =~ s/'/&#039;/g;
                   17248:         $outgoing =~ s/\$/&#036;/g;
                   17249:         $outgoing =~ s{/}{&#047;}g;
                   17250:         $outgoing =~ s/=/&#061;/g;
                   17251:         $outgoing =~ s/\\/&#092;/g
                   17252:     }
                   17253:     return $outgoing;
                   17254: }
                   17255: 
1.1075.2.74  raeburn  17256: # Checks for critical messages and returns a redirect url if one exists.
                   17257: # $interval indicates how often to check for messages.
                   17258: sub critical_redirect {
                   17259:     my ($interval) = @_;
                   17260:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
                   17261:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
                   17262:                                         $env{'user.name'});
                   17263:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
                   17264:         my $redirecturl;
                   17265:         if ($what[0]) {
                   17266:             if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) {
                   17267:                 $redirecturl='/adm/email?critical=display';
                   17268:                 my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   17269:                 return (1, $url);
                   17270:             }
                   17271:         }
                   17272:     }
                   17273:     return ();
                   17274: }
                   17275: 
1.1075.2.64  raeburn  17276: # Use:
                   17277: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   17278: #
                   17279: ##################################################
                   17280: #          password associated functions         #
                   17281: ##################################################
                   17282: sub des_keys {
                   17283:     # Make a new key for DES encryption.
                   17284:     # Each key has two parts which are returned separately.
                   17285:     # Please note:  Each key must be passed through the &hex function
                   17286:     # before it is output to the web browser.  The hex versions cannot
                   17287:     # be used to decrypt.
                   17288:     my @hexstr=('0','1','2','3','4','5','6','7',
                   17289:                 '8','9','a','b','c','d','e','f');
                   17290:     my $lkey='';
                   17291:     for (0..7) {
                   17292:         $lkey.=$hexstr[rand(15)];
                   17293:     }
                   17294:     my $ukey='';
                   17295:     for (0..7) {
                   17296:         $ukey.=$hexstr[rand(15)];
                   17297:     }
                   17298:     return ($lkey,$ukey);
                   17299: }
                   17300: 
                   17301: sub des_decrypt {
                   17302:     my ($key,$cyphertext) = @_;
                   17303:     my $keybin=pack("H16",$key);
                   17304:     my $cypher;
                   17305:     if ($Crypt::DES::VERSION>=2.03) {
                   17306:         $cypher=new Crypt::DES $keybin;
                   17307:     } else {
                   17308:         $cypher=new DES $keybin;
                   17309:     }
1.1075.2.106  raeburn  17310:     my $plaintext='';
                   17311:     my $cypherlength = length($cyphertext);
                   17312:     my $numchunks = int($cypherlength/32);
                   17313:     for (my $j=0; $j<$numchunks; $j++) {
                   17314:         my $start = $j*32;
                   17315:         my $cypherblock = substr($cyphertext,$start,32);
                   17316:         my $chunk =
                   17317:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   17318:         $chunk .=
                   17319:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   17320:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   17321:         $plaintext .= $chunk;
                   17322:     }
1.1075.2.64  raeburn  17323:     return $plaintext;
                   17324: }
                   17325: 
1.1075.2.135  raeburn  17326: sub is_nonframeable {
                   17327:     my ($url,$absolute,$hostname,$ip,$nocache) = @_;
                   17328:     my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
                   17329:     return if (($remprotocol eq '') || ($remhost eq ''));
                   17330: 
                   17331:     $remprotocol = lc($remprotocol);
                   17332:     $remhost = lc($remhost);
                   17333:     my $remport = 80;
                   17334:     if ($remprotocol eq 'https') {
                   17335:         $remport = 443;
                   17336:     }
                   17337:     my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
                   17338:     if ($cached) {
                   17339:         unless ($nocache) {
                   17340:             if ($result) {
                   17341:                 return 1;
                   17342:             } else {
                   17343:                 return 0;
                   17344:             }
                   17345:         }
                   17346:     }
                   17347:     my $uselink;
                   17348:     my $request = new HTTP::Request('HEAD',$url);
1.1075.2.142  raeburn  17349:     my $ua = LWP::UserAgent->new;
                   17350:     $ua->timeout(5);
                   17351:     my $response=$ua->request($request);
1.1075.2.135  raeburn  17352:     if ($response->is_success()) {
                   17353:         my $secpolicy = lc($response->header('content-security-policy'));
                   17354:         my $xframeop = lc($response->header('x-frame-options'));
                   17355:         $secpolicy =~ s/^\s+|\s+$//g;
                   17356:         $xframeop =~ s/^\s+|\s+$//g;
                   17357:         if (($secpolicy ne '') || ($xframeop ne '')) {
                   17358:             my $remotehost = $remprotocol.'://'.$remhost;
                   17359:             my ($origin,$protocol,$port);
                   17360:             if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
                   17361:                 $port = $ENV{'SERVER_PORT'};
                   17362:             } else {
                   17363:                 $port = 80;
                   17364:             }
                   17365:             if ($absolute eq '') {
                   17366:                 $protocol = 'http:';
                   17367:                 if ($port == 443) {
                   17368:                     $protocol = 'https:';
                   17369:                 }
                   17370:                 $origin = $protocol.'//'.lc($hostname);
                   17371:             } else {
                   17372:                 $origin = lc($absolute);
                   17373:                 ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
                   17374:             }
                   17375:             if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
                   17376:                 my $framepolicy = $1;
                   17377:                 $framepolicy =~ s/^\s+|\s+$//g;
                   17378:                 my @policies = split(/\s+/,$framepolicy);
                   17379:                 if (@policies) {
                   17380:                     if (grep(/^\Q'none'\E$/,@policies)) {
                   17381:                         $uselink = 1;
                   17382:                     } else {
                   17383:                         $uselink = 1;
                   17384:                         if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
                   17385:                                 (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
                   17386:                                 (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
                   17387:                             undef($uselink);
                   17388:                         }
                   17389:                         if ($uselink) {
                   17390:                             if (grep(/^\Q'self'\E$/,@policies)) {
                   17391:                                 if (($origin ne '') && ($remotehost eq $origin)) {
                   17392:                                     undef($uselink);
                   17393:                                 }
                   17394:                             }
                   17395:                         }
                   17396:                         if ($uselink) {
                   17397:                             my @possok;
                   17398:                             if ($ip ne '') {
                   17399:                                 push(@possok,$ip);
                   17400:                             }
                   17401:                             my $hoststr = '';
                   17402:                             foreach my $part (reverse(split(/\./,$hostname))) {
                   17403:                                 if ($hoststr eq '') {
                   17404:                                     $hoststr = $part;
                   17405:                                 } else {
                   17406:                                     $hoststr = "$part.$hoststr";
                   17407:                                 }
                   17408:                                 if ($hoststr eq $hostname) {
                   17409:                                     push(@possok,$hostname);
                   17410:                                 } else {
                   17411:                                     push(@possok,"*.$hoststr");
                   17412:                                 }
                   17413:                             }
                   17414:                             if (@possok) {
                   17415:                                 foreach my $poss (@possok) {
                   17416:                                     last if (!$uselink);
                   17417:                                     foreach my $policy (@policies) {
                   17418:                                         if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
                   17419:                                             undef($uselink);
                   17420:                                             last;
                   17421:                                         }
                   17422:                                     }
                   17423:                                 }
                   17424:                             }
                   17425:                         }
                   17426:                     }
                   17427:                 }
                   17428:             } elsif ($xframeop ne '') {
                   17429:                 $uselink = 1;
                   17430:                 my @policies = split(/\s*,\s*/,$xframeop);
                   17431:                 if (@policies) {
                   17432:                     unless (grep(/^deny$/,@policies)) {
                   17433:                         if ($origin ne '') {
                   17434:                             if (grep(/^sameorigin$/,@policies)) {
                   17435:                                 if ($remotehost eq $origin) {
                   17436:                                     undef($uselink);
                   17437:                                 }
                   17438:                             }
                   17439:                             if ($uselink) {
                   17440:                                 foreach my $policy (@policies) {
                   17441:                                     if ($policy =~ /^allow-from\s*(.+)$/) {
                   17442:                                         my $allowfrom = $1;
                   17443:                                         if (($allowfrom ne '') && ($allowfrom eq $origin)) {
                   17444:                                             undef($uselink);
                   17445:                                             last;
                   17446:                                         }
                   17447:                                     }
                   17448:                                 }
                   17449:                             }
                   17450:                         }
                   17451:                     }
                   17452:                 }
                   17453:             }
                   17454:         }
                   17455:     }
                   17456:     if ($nocache) {
                   17457:         if ($cached) {
                   17458:             my $devalidate;
                   17459:             if ($uselink && !$result) {
                   17460:                 $devalidate = 1;
                   17461:             } elsif (!$uselink && $result) {
                   17462:                 $devalidate = 1;
                   17463:             }
                   17464:             if ($devalidate) {
                   17465:                 &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
                   17466:             }
                   17467:         }
                   17468:     } else {
                   17469:         if ($uselink) {
                   17470:             $result = 1;
                   17471:         } else {
                   17472:             $result = 0;
                   17473:         }
                   17474:         &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
                   17475:     }
                   17476:     return $uselink;
                   17477: }
                   17478: 
1.112     bowersj2 17479: 1;
                   17480: __END__;
1.41      ng       17481: 

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